​
Installation

First, you need to set up a Corbado project. To get started with the integration, either install the Corbado web-js package via npm or add the JavaScript library via CDN.

Note: UI components added via CDN do currently not support icon coloring which may impact dark mode and other custom UI stylings.

​
Set up Corbado

As a prerequisite to all future actions, Corbado has to be loaded. We do this by using the Corbado.load function.

<!DOCTYPE html>
<html>
<head>
    <link
        rel="stylesheet"
        href="https://unpkg.com/@corbado/web-js@2/dist/bundle/index.css"
    />
    <script src="https://unpkg.com/@corbado/web-js@2/dist/bundle/index.js"></script>
<body>
    <script type="module">
        await Corbado.load({
            projectId: "pro-XXX"
        });
    </script>
</body>
</html>

Corbado.load() must be called on every page to make session refresh work.

​
Configuration

Most configuration is done in the . The following options are available:

NameTypeDefaultDescription
projectIdstring (e.g. pro-1234567890)requiredThe ID of your Corbado project. This setting is mandatory and can be found in the Developer Panel.
autoDetectLanguagebooleantrueIf set to true the language used in UI components will be derived from the browser.
defaultLanguagestringenThe default language to be used if auto-detection is disabled or fails. Corbado supports “en”, “de” and “fr”. You can define custom translations though.
customTranslationsobjectnullA map from language (e.g. “en”) to an object containing your custom translation overrides. Find more details here
darkModeon | off | autoautoControls if your components are rendered in dark mode. If set to auto the darkMode setting will be derived from the browser.
themestringundefinedControls the style of your components. Currently, the only alternative theme that can be set here is emerald-funk. To create your own custom theme find all information here.
customerSupportEmailstringundefinedEmail address for customer support in case of critical errors.
isDevModebooleanfalseIf set to true, the UI components will log debug messages to console.
frontendApiUrlstringSet to your Frontend API URLPlease set this value when you go live to your defined CNAME.
apiTimeoutnumber30000Front-end api timeout time in miliseconds

​
Next

  1. Add authentication UI components to your application.
  2. Let your users manage their passkeys with the PasskeyList.
  3. Learn how you can access the users authentication state.

Was this page helpful?

React BlogpostCorbadoAuth Component