> ## Documentation Index
> Fetch the complete documentation index at: https://developers.entri.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Connect White Label
> Theme, colors, icons, custom properties, and custom copy for the Connect modal.
## `whiteLabel` object
**Entri Connect Growth tier and above. Included on Entri Sell**
The whiteLabel property object allows you to further customize the Entri Modal UI. Please note you may need an Enterprise level account for these properties to be available. For questions about this, contact your account manager.
Entri is rolling out a redesigned modal. For the `whiteLabel` properties it supports, see [Connect New UI](/connect/new-ui). The same UI powers [Entri Activate](/activate/overview).
| Property | Type | Required? | Default | Description |
| --------------------------- | ------- | --------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| hideEntriLogo | boolean | No | false | When true, hides all mentions of "Powered by Entri" |
| hideConfetti | boolean | No | false | When true, hides the confetti upon a successful domain configuration. |
| hideLinkSharingConfirmation | boolean | No | false | Removes the "I have shared the link" check from the sharing link feature modal. |
| logo | string | No | null | This needs to be an https URL. When inputted, it will override the configured Application logo, and use this one instead. We recommended an SVG or PNG file that is 1:1. |
| logoBackgroundColor | string | No | null | When present, this will set a background color for the logo mask. Useful if your logo uses a white color and has a transparent background. |
| removeLogoBorder | boolean | No | false | When true, this will remove the rounded mask/border that is applied over your logo. |
| removeShareLogin | boolean | No | false | When true, this will remove the sharing link functionality across the whole application. |
| hideCompanyName | boolean | No | false | Hides the company name across the flow. |
| hideProgressIndicator | boolean | No | null | Hides the progress indicator at the top of the modal |
| theme | object | No | null | Described below (see [theme Object](#whitelabel-theme-object)) |
| icons | object | No | null | Described below (see [icons Object](#whitelabel-icons-object)) |
| customProperties | object | No | null | Described below (see [customProperties Object](#whitelabel-customproperties-object)) |
| customCopy | object | No | null | Described below (see [customCopy Object](#whitelabel-customcopy-object)) |
To white-label the sharing link URL itself — replacing `app.goentri.com` with your own branded domain — configure the **Sharing link URL** field in your Dashboard under Account Settings → Application Settings. This is an Enterprise-tier feature and requires no code changes. See [Sharing Link Custom Domain](/connect/shared-links#sharing-link-custom-domain) for details.
### `whiteLabel.theme` Object
The `whiteLabel.theme` object allows you to customize the foreground and background colors to match your app's branding. Please note you may need an Enterprise level account for these properties to be available. For questions about this, contact your account manager.
**Entri Connect Theme Options**
| Property | Type | Default | Description |
| ----------------------------- | ------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| bg | string | N/A | Primary brand color. Please input a hex code. Applies to primary buttons, links, and input shadow **Recommended for quick theming.** |
| fg | string | N/A | Text color on primary elements. Please input a hex code. Applies to text on buttons **Recommended for quick theming.** |
| darkMode | string | "disabled" | Color scheme: `"disabled"` (light), `"enabled"` (dark), or `"auto"` (matches system preference). |
| colors | object | null | Custom color overrides for granular control. See [Colors Reference](#whitelabel-theme-colors-object) below for complete list of available properties. |
| width | string | N/A | Modal's width |
| links | string | N/A | Links color to override HTML's default blue. |
| internalCustomAnimation | string | null | This enables a custom animation. Please refer to your account executive for more info. |
| buttons | object | null | Contains custom properties for the buttons across all screens |
| buttons.border.style | string | null | Contains the `border` css styling e.g. `solid 1px #000` |
| buttons.border.radius | string | null | Contains the `border-radius` css styling e.g. `5%` or `10px` |
| googleFont | object | null | Allows to set a custom GoogleFont and its properties |
| googleFont.family | string | null | Overrides the Modal `font-family` |
| googleFont.variant | string | null | `font-family` normal text weight e.g. `400` |
| googleFont.boldWeight | string | null | `font-family` bold text weight e.g. `600` |
| lightBox | object | null | Contains custom properties for the backdrop/overlay |
| lightBox.color | string | null | Backdrop/overlay color. Please input a transparent hsla or rgba code |
| titles | object | null | Define styling properties for the titles globally and per screen |
| titles.fontSize | string | null | Overrides the `font-size` for all titles |
| titles.providerLogin | object | null | Define styling properties for the Login Screen |
| titles.providerLogin.fontSize | object | null | Overrides the `font-size` for the Login Screen |
| secondaryLinks | object | null | Overrides styling for secondary links |
| secondaryLinks.fontSize | string | null | Override the `font-size` for secondary links globally |
| hideCompanyLogo | boolean | false | Hides the customer's logo on the initial screen (Does not apply to the multi-domain initial screen) |
### `whiteLabel.theme.colors` Object
The `colors` object provides granular control over individual UI elements. Most of `colors` properties accept standard CSS color formats (hex, rgb, rgba, hsl, hsla), except `bg`, `fg`, `buttonPrimary`, `errorShadowColorRgb`, `errorShadowColorRgb`.
**Special Format Requirements:**
| Property | Format | Example | Notes |
| --------------------- | ------------------ | --------------- | ----------------------------------------------------------------------------------------------------------- |
| `buttonPrimary` | Hexadecimal string | `"#1f77f8"` | Same format for `them.bg`, `theme.fg`. |
| `shadowColorRgb` | RGB triplet string | `"0, 0, 0"` | Comma-separated RGB values without parentheses. Used for CSS custom properties that require RGB components. |
| `errorShadowColorRgb` | RGB triplet string | `"247, 38, 38"` | Same format as `shadowColorRgb`. |
**Colors Property Reference:**
Below is a comprehensive list of where each color property is applied in the Entri Connect modal:
| Property | Applied To | CSS Variable | Example Usage |
| --------------------- | ----------------------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------- |
| `modalBackground` | Main modal container | `--modal-background` | Background of the entire modal |
| `modalOverlay` | Primary overlay | `--modal-overlay` | Backdrop when modal is open |
| `footerBackground` | Modal footer | `--footer-background` | Bottom section of modal |
| `textPrimary` | Main text content | `--text-primary` | Primary text throughout modal |
| `textSecondary` | Supporting text | `--text-secondary` | Descriptions, helper text |
| `textTertiary` | Tertiary text | `--text-tertiary` | Least prominent text |
| `buttonPrimary` | Primary buttons | `--button-primary` | Main action buttons |
| `buttonPrimaryText` | Primary button text | `--button-primary-text` | Text on primary buttons |
| `buttonSecondary` | Secondary buttons | `--button-secondary` | Less prominent action buttons |
| `buttonSecondaryText` | Secondary button text | `--button-secondary-text` | Text on secondary buttons |
| `linkPrimary` | Primary links | `--link-primary` | Main hyperlinks |
| `linkSecondary` | Secondary links | `--link-secondary` | Less prominent links |
| `linkSecondaryHover` | Secondary link hover state | `--link-secondary-hover` | Hover effect on secondary links |
| `linkDestructive` | Destructive action links | `--link-destructive` | Close app button |
| `inputBackground` | Form input backgrounds | `--input-background` | Text input fields |
| `inputBorder` | Form input borders | `--input-border` | Input field borders |
| `inputText` | Input field text | `--input-text` | Text inside input fields |
| `inputPlaceholder` | Input placeholder text | `--input-placeholder` | Placeholder text in inputs |
| `divider` | Section dividers | `--divider` | Horizontal rules, separators |
| `border` | Generic borders | `--border` | General border color |
| `shadowColorRgb` | Shadow color components | `--shadow-color-rgb` | RGB values for shadow colors |
| `tableHeaderBg` | Table header background | `--table-header-bg` | Header row of tables |
| `tableHeaderBorder` | Table header borders | `--table-header-border` | Border around table headers |
| `tableCellBorder` | Table cell borders | `--table-cell-border` | Borders between table cells |
| `tableRowEvenBg` | Even table row background | `--table-row-even-bg` | Zebra striping for tables |
| `tableRowHoverBg` | Table row hover background | `--table-row-hover-bg` | Row background on hover |
| `errorBorder` | Error state borders | `--error-border` | Borders on error inputs |
| `errorText` | Error message text | `--error-text` | Error message color |
| `errorBackground` | Error state background | `--error-background` | Background for error states |
| `errorShadowColorRgb` | Error shadow color components | `--error-shadow-color-rgb` | RGB values for error shadows |
| `copyRecordValueText` | Manual records value text | — | DNS value text inside each copy chip on the manual setup screen. Falls back to `buttonPrimary` when unset. |
**Dark Mode Preset:** When `darkMode: 'enabled'` is set, Entri automatically applies a comprehensive dark color scheme. You can still override individual colors by specifying them in the `colors` object after setting `darkMode`.
**Quick Theme + Advanced Customization:** The `bg` and `fg` properties provide fast global theming, while the `colors` object allows granular control. They work together - `colors` properties override the automatic mappings from `bg`/`fg` where specified.
**Example:**
```javascript theme={null}
theme: {
bg: "#1f77f8", // Quick: sets buttons, links, shadows
fg: "#FFFFFF", // Quick: sets text on primary elements
colors: {
modalBackground: "#F5F5F5",
buttonPrimary: "#FF0000" // Override: specific customization
}
}
```
**Entri Sell Theme Options**
| Property | Type | Default | Description |
| ---------------- | ------ | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| primary | string | N/A | Main color used in your theme. It’s usually the most recognizable color in the interface. Example: `"#012939"` |
| onPrimary | string | N/A | Color used for text and icons that appear on top of the primary color. Example: `"#ffffff"` |
| secondary | string | N/A | Color that complements the primary color and is used for secondary UI elements. Example: `"#012939"` |
| onSecondary | string | N/A | Color used for text and icons that appear on top of the secondary color. Example: `"#ffffff"` |
| headerBackground | string | N/A | Background color of the header. Accepts any valid CSS color code (e.g., hex, rgb). If not defined, it will default to the primary color value. Example: `"#123456"` |
| interactive | string | N/A | Color for interactive elements such as radio buttons. Accepts any valid CSS color code (e.g., hex, rgb). Example: `"#ffcc00"` |
| premiumBadge | string | N/A | Background color of premium badge components. Accepts any valid CSS color code (e.g., hex, rgb). Example: `"#00ffcc"` |
| onPremiumBadge | string | N/A | Text color on the premium badge. Accepts any valid CSS color code (e.g., hex, rgb). Example: `"#ffffff"` |
| priceBadge | string | N/A | Background color of the price badge component. Accepts any valid CSS color code (e.g., hex, rgb). Example: `"#ff6600"` |
| onPriceBadge | string | N/A | Text color on the price badge. Accepts any valid CSS color code (e.g., hex, rgb). Example: `"#ffffff"` |
| activating | string | N/A | Background color of the “Search Domain” button. Accepts any valid CSS color code (e.g., hex, rgb). Example: `"#ff4500"` |
| onActivating | string | N/A | Text color on the “Search Domain” button. Accepts any valid CSS color code (e.g., hex, rgb). Example: `"#000000"` |
### `whiteLabel.icons` Object
The `whiteLabel.icons` object allows you to customize the default icons used across the flow.
| Property | Type | Default | Description |
| -------------------------------------- | ------ | ------- | ---------------------------------------------------------------------------------------------- |
| icons | object | null | Contains the icons' override details. These need to be set by your assigned Sales Engineer. |
| icons.initialStep | object | null | Contains the Initial screen's icons override details |
| icons.initialStep.secureIcon | string | null | Icon code to use as replacement for the "secure" part of the introduction section |
| icons.initialStep.easyIcon | string | null | Icon code to use as replacement for the "easy" part of the introduction section |
| icons.domainAnalysis | object | null | Contains the Domains analysis' icons override details |
| icons.domainAnalysis.stepInitial | string | null | Icon code to use as replacement for the undone check in the Domain analysis screen |
| icons.domainAnalysis.stepInactive | string | null | Icon code to use as replacement for the inactive check in the Domain analysis screen |
| icons.domainAnalysis.stepFinished | string | null | Icon code to use as replacement for the done check in the Domain analysis screen |
| icons.providerLogin | object | null | Contains the Initial screen's icons override details |
| icons.providerLogin.user | string | null | Icon code to use as replacement for the user icon within the username input |
| icons.providerLogin.password | string | null | Icon code to use as replacement for the password icon within the password input |
| icons.providerLogin.passwordEyeVisible | string | null | Icon code to use as replacement for the showing the password feature within the password input |
| icons.providerLogin.passwordEyeHidden | string | null | Icon code to use as replacement for the hiding the password feature within the password input |
### `whiteLabel.customProperties` Object
**Enterprise tier.**
The `whiteLabel.customProperties` object allows you to set different behaviours related specifically to specific elements or a screen's behavior.
| Property | Type | Default | Description |
| ------------------------------------------- | ---------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| embeddedSelector | string | null | A valid CSS selector (e.g., #entri-container) specifying the target element where the Entri Connect login UI should be embedded. If null, the authentication flow will open in a modal. |
| congratulations.disableScreen | boolean | false | If set to true, disables the congratulations screen in the modal after the domain connection. |
| initialScreen | object | null | Contains properties for the initial screen |
| initialScreen.showManualInstructionsCTA | boolean | false | Enables the go-to manual link in the initial screen. Closes the modal and adds the `authenticateManuallyClicked: true` key to the `onEntriClose` event. |
| initialScreen.disableScreen | boolean | false | Disables the the initial screen. If prefilledDomain is in use, then the user will land directly on the domain analysis screen. If no prefilledDomain is in use, then the user will land on the domain input screen. |
| errorScreen | object | null | Contains properties for the error screen |
| errorScreen.genericError | object | null | Contains properties for the Generic error screen specifically |
| errorScreen.genericError.image | object | null | Overrides the default image/animation shown for Generic errors |
| errorScreen.sessionError | object | null | Contains properties for the Session error screen specifically |
| errorScreen.sessionError.image | object | null | Overrides the default image/animation shown for Session errors |
| existingRecords | object | null | Contains properties for the Existing records screen |
| existingRecords.disableScreen | boolean | false | Disables the Existing Records override prompt and confirms automatically |
| fwdToColleague.background | Object or String | null | Changes all possible css background properties. Can be used as **String**, working as described in the `background` [CSS property definition](https://developer.mozilla.org/en-US/docs/Web/CSS/background), or as an **Object**, making use of all possible background sub-properties using camelCase syntax keys, for example: `background:{backgroundColor:"red"}` |
| manualConfiguration | object | null | Contains properties for the manual screen guide |
| manualConfiguration.disableScreen | boolean | false | Prevents the manual screen from being shown. Adds the `manualScreenDisabled:true` extra property to the onEntriClose event |
| providerLogin | object | null | Contains properties for the provider login screen |
| providerLogin.showEntriToS | boolean | false | Displays the terms of service on the Provider Login screen |
| providerLogin.disableExtendedLoginAnimation | boolean | false | Disables the extended login animation and leaves only the default one in place. |
| providerLogin.changeProvider | object | null | Sets visual changes to the change provider feature on the login screen |
| providerLogin.changeProvider.hide | boolean | false | Hides the "Change provider" feature |
| providerLogin.gotoManualLink | object | null | Contains translations for customizing the "go to our manual setup" link rendered on the Provider Login and DomainConnect/OAuth screens. |
| providerLogin.gotoManualLink.disable | boolean | false | Hides the go to manual text copy |
| providerLogin.gotoManualLink.\$\{locale} | string | null | Sets the **go to manual setup link** translation text for the specific locale. Wrap clickable text in `` tags. Also accepts ``, ``, ` ` tags. Example: `"Follow our manual setup guide"`. |
| providerLogin.forwardLink.hideLeftArrow | boolean | false | Hides the `>>` icon at the left of the records-preview link. |
| providerLogin.forwardLink.style | Object | false | Allows to include custom styling for to the forward to a colleague link. Each property has to be in added in camelCase format, eg. `background: "#000"`, `color: "white"`, `padding: "0.5rem 1rem"`, `borderRadius: "5px"`, `textDecoration: "none"`, etc. |
| providerLogin.forwardLink.disable | boolean | false | Disables the *Forward Link* feature. |
| providerLogin.forwardLink.hide | boolean | false | Hides the *Forward Link* feature entirely, so the forward-to-a-colleague link does not render on the Provider Login screen. |
| providerLogin.recordsPreview\.hide | boolean | false | Hides the records preview feature/link. |
| sharedFlow\.background | Object or String | null | Changes all possible css background properties. Can be used as **String**, working as described in the `background` [CSS property definition](https://developer.mozilla.org/en-US/docs/Web/CSS/background), or as an **Object**, making use of all possible background sub-properties using camelCase syntax keys, for example: `background:{backgroundColor:"red"}` |
| sharedFlow\.hideDecorations | boolean | false | Disables the default Entri background decorations on the shared flow |
| general.hideCloseButton | boolean | false | When `true`, hides the close (X) button in the widget header. The button space is preserved in the layout but remains invisible, which is useful when your own UI is responsible for dismissing the widget. |
| general.useCustomExitConfirmation | boolean | false | When `true`, Entri's default "Are you sure you want to leave?" exit confirmation dialog is suppressed and the [`onEntriRequestClose`](/connect/events#onentrirequestclose-event) event fires instead when the user clicks the close (X) button. The host app must then run its own confirmation UI and call [`entri.close()`](/connect/sdk#entri-close) to dismiss the widget. |
| general.embeddedMode.fillContainer | boolean | false | When `true`, makes the embedded widget fill its parent container at 100% width and height, and removes the default border-radius and box-shadow. Requires `general.embeddedMode.selector` to be set. Useful when you want the widget to be fully responsive inside your own layout container. |
### `whiteLabel.customCopy` Object
**Entri Connect Premium tier and above. Included on Entri Sell**
The `whiteLabel.customCopy` object allows you to customize certain texts along the flow, in order to match your brand's tone or in case the default copy doesn't exactly fit your use case. The default and only required locale (translation) needed to be used within the `whiteLabel.customCopy` object is the `EN` locale. All missing translations will default to English.
Please note you may need an Enterprise level account for these properties to be available. For questions about this, contact your account manager.
| Property | Type | Default | Description |
| -------------------------------------------------- | ------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| congratulations | object | null | Contains the override details for the Congratulations screen |
| congratulations.title | object | null | Overrides the title on the Congratulations screen. |
| congratulations.title.\$\{locale} | string | null | Sets the **Congratulations title's** translation text for the specific locale. Accepts the `{DOMAIN}` replacement token. Accepts applying bold when using the following tags ``. |
| congratulations.description | object | null | Overrides the description on the congratulations screen. |
| congratulations.description.\$\{locale} | string | null | Sets the **Congratulations description's** translation text for the specific locale. Accepts applying bold when using the following tags ``. Accepts a `{USER}` (described below) and `{DOMAIN}` placeholders. |
| congratulations.user | string | null | The user value to replace on the `{USER}` token in the `congratulations.description` |
| congratulations.sell.title | object | null | Overrides the title on the Congratulations screen. |
| congratulations.sell.title.\$\{locale} | string | null | Sets the **Congratulations title's** translation text for the specific locale. Accepts the `{DOMAIN}` and `{APPLICATION_NAME}` replacement tokens. Accepts applying bold when using the following tags ``. |
| congratulations.sell.description | object | null | Overrides the description on Entri Sell congratulations screen. |
| congratulations.sell.description.\$\{locale} | string | null | Sets the **Congratulations description's** translation text for the specific locale. Accepts applying bold when using the following tags ``. Accepts a `{USER}` (described below) and `{APPLICATION_NAME}` replacement tokens. |
| congratulations.sell.user | string | null | The user value to replace on the `{USER}` token in the `congratulations.sell.description` |
| congratulations.button | string | null | Overrides the button's text in the Congratulations screen. |
| congratulations.button.\$\{locale} | string | null | Sets the **Congratulations button call to action's** translation text for the specific locale. Accepts applying bold when using the following tags ``. |
| domainAnalysis | object | null | Contains the override details for the Domain analysis screen |
| domainAnalysis.title | object | null | Overrides the title on the Domain analysis screen. |
| domainAnalysis.title.\$\{locale} | string | null | Sets the **Domain Analysis title's** translation text for the specific locale. |
| domainAnalysis.analyzing | object | null | Overrides the **analysis in progress** text on the Domain analysis screen. |
| domainAnalysis.analyzing.\$\{locale} | string | null | Sets the **analysis in progress** translation text for the specific locale. |
| domainAnalysis.analyzed | object | null | Overrides the **analysis done** text on the Domain analysis screen. |
| domainAnalysis.analyzed.\$\{locale} | string | null | Sets the **analysis done** translation text for the specific locale. |
| domainAnalysis.detecting | object | null | Overrides the **detection in progress** text on the Domain analysis screen. |
| domainAnalysis.detecting.\$\{locale} | string | null | Sets the **detection in progress** translation text for the specific locale. |
| domainAnalysis.detected | object | null | Overrides the **detection done** text on the Domain analysis screen. |
| domainAnalysis.detected.\$\{locale} | string | null | Sets the **detection done** translation text for the specific locale. |
| domainAnalysis.gettingSetupReady | object | null | Overrides the **getting setup ready** text on the Domain analysis screen. |
| domainAnalysis.gettingSetupReady.\$\{locale} | string | null | Sets the **getting setup ready** in progress translation text for the specific locale. |
| domainAnalysis.setupIsReady | object | null | Overrides the **setup is ready** text on the Domain analysis screen. |
| domainAnalysis.setupIsReady.\$\{locale} | string | null | Sets the **setup is ready** translation text for the specific locale. |
| existingRecords | object | null | Contains the override details for the Override records confirmation screen. |
| existingRecords.title | object | null | Contains the translations for Overriding the title on the Override records confirmation screen. |
| existingRecords.title\$.\{locale} | string | null | Sets the **Override-confirmation screen title's** translation text for the specific locale. Accepts the `{DOMAIN}` replacement token. Accepts applying bold when using the following tags ``. |
| initialScreen | object | null | Contains the override details for the Initial screen |
| initialScreen.title | object | null | Contains the translations for overriding the title on the initial screen. |
| initialScreen.title.\$\{locale} | string | null | Sets the **title's** translation text for the specific locale. (one of the available codes such as en,es,fr, etc., for example initialScreen.title.en). Accepts applying bold when using the following tags ``. For Entri Sell, sets the title text that appears on the initial screen of the domain purchase flow, localized by language. Example: "Search for your domain" |
| initialScreen.marketingCopy.\$\{locale} | string | null | Marketing copy that appears below the domain input field, localized by language. Example: *"Your website will look even better with a custom domain!"* (Entri Sell only) |
| initialScreen.subTitle | object | null | Contains the translations for overriding the subtitle on the initial screen |
| initialScreen.subTitle.\$\{locale} | string | null | Sets the **subtitle's** translation text for the specific locale. |
| initialScreen.secure | object | null | Overrides the texts in the "secure" section on the initial screen |
| initialScreen.secure.title | object | null | Contains the translations for overriding the "secure" title section on the initial screen. |
| initialScreen.secure.title.\$\{locale} | string | null | Sets the **secure title's** translation text for the specific locale. |
| initialScreen.secure.description | object | null | Contains the translations for overriding the "secure" description text section on the initial screen |
| initialScreen.secure.description.\$\{locale} | string | null | Sets the **secure description's** translation text for the specific locale. |
| initialScreen.easy | object | null | Overrides the texts in the "easy" section on the initial screen |
| initialScreen.easy.title | object | null | Contains the translations for overriding the "easy" title section on the initial screen |
| initialScreen.easy.title.\$\{locale} | string | null | Sets the **easy title's** translation text for the specific locale. |
| initialScreen.easy.description | object | null | Contains the translations for overriding the "easy" description section on the initial screen |
| initialScreen.easy.description.\$\{locale} | string | null | Sets the **easy description's** translation text for the specific locale. |
| login2FA | object | null | Contains the override details for the login 2FA screen |
| login2FA.description | object | null | Overrides the description on the login 2FA screen. |
| login2FA.description.generic | object | null | Overrides the description on the login 2FA screen with a generic text applied to all types of 2FA. |
| login2FA.description.generic.\$\{locale} | string | null | Sets the **Login 2FA description's** translation text for the specific locale (one of the available codes, such as en,es,fr, etc., for example initialScreen.title.en). |
| login2FA.description.sms | object | null | Overrides the description on the login 2FA for SMS 2fa auth |
| login2FA.description.sms.\$\{locale} | string | null | Sets the **Login 2FA description's** for SMS 2fa auth translation text for the specific locale (one of the available codes, such as en,es,fr, etc., for example initialScreen.title.en). |
| login2FA.description.email | object | null | Overrides the description on the login 2FA for EMAIL 2fa auth |
| login2FA.description.email.\$\{locale} | string | null | Sets the **Login 2FA description's** for EMAIL 2fa auth translation text for the specific locale (one of the available codes, such as en,es,fr, etc., for example initialScreen.title.en). |
| login2FA.description.authenticatorApp | object | null | Overrides the description on the login 2FA for AUTHENTICATOR 2fa auth |
| login2FA.description.authenticatorApp.\$\{locale} | string | null | Sets the **Login 2FA description's** for AUTHENTICATOR 2fa auth translation text for the specific locale (one of the available codes, such as en,es,fr, etc., for example initialScreen.title.en). |
| manuallyScreen | object | null | Contains the step-by-step-guide override details. |
| manuallyScreen.disableManualSetupDocumentationLink | boolean | false | Disables the opening of the documentation URL provided in the manualSetupDocumentation configuration property. Commonly used in combination with in combination with the onEntriManualSetupDocumentationClick event to trigger a custom js function. |
| manuallyScreen.stepByStepGuide | object | null | Overrides the step-by-step-guide line of text on the manual configuration screen |
| manuallyScreen.stepByStepGuide.\$\{locale} | string | null | Sets the **step-by-step-guide** translation text for the specific locale (one of the available codes, such as en,es,fr, etc., for example initialScreen.title.en). This field also supports links for triggering javascript functions only. These are helpful for triggering chatbots or other actions. You only need to enclose the call to action text inside the `` tags to create an "empty" link, and then catch the onEntriManualSetupDocumentationClick event. |
| providerLogin | object | null | Contains the override details for the Provider Login screen |
| providerLogin.message | object | null | Contains the translations for overriding the introductory message on the provider login screen. |
| providerLogin.message.\$\{locale} | string | null | Sets the **Provider Login's introduction's** translation text for the specific locale (one of the available codes, such as en,es,fr, etc., for example initialScreen.title.en). Accepts the `{PROVIDER}` replacement token. Accepts applying bold when using the following tags ``. |
| providerLogin.forwardLogin | object | null | Contains translations for customizing the **Forward login** call to action.. |
| providerLogin.forwardLogin.\$\{locale} | object | null | Sets the **Forward login** translation text for the specific locale (one of the available codes, such as en,es,fr, etc., for example providerLogin.forwardLogin.en). |
| providerLogin.showPreview | object | null | Contains translations for customizing the text that shows the record previews. |
| providerLogin.showPreview.\$\{locale} | object | null | Sets the **Show preview** translation text for the specific locale (one of the available codes, such as en,es,fr, etc., for example initialScreen.title.en). |
| providerLogin.hidePreview | object | null | Contains translations for customizing the text that hides the record previews. |
| providerLogin.hidePreview.\$\{locale} | object | null | Sets the **Hide preview** translation text for the specific locale (one of the available codes, such as en,es,fr, etc., for example initialScreen.title.en). |
Locales supported are one of form `en`, `es`, `fr`, etc. If no matching translation is found for the locale in use, then the Entri's default text will be used.
Please find the full list of supported locales in [property's documentation](/connect/configuration#entrishowentriconfig).
### White label code example:
```JavaScript JavaScript theme={null}
{
"whiteLabel": {
"hideEntriLogo": true,
"hideConfetti": true,
"logo": "LOGO_URL",
"theme": {
"fg": "#fff",
"bg": "#fa7268"
},
"logoBackgroundColor": "#444444",
"removeLogoBorder": true,
"customCopy": {
"initialScreen": {
"title": {
"en": "Custom title",
"es": "Título custom"
},
"subTitle": {
"en": "Custom subtitle",
"es": "Subtítulo custom"
}
},
"manuallyScreen": {
"disableManualSetupDocumentationLink": true,
"stepByStepGuide": {
"en": "Follow our step-by-step guide",
"es": "Sigue nuestra guía paso-a-paso"
}
}
}
}
}
```