FronteggAppOptions overview

This guide will discuss the various capbilities within the FronteggAppOptions plugin which is exposed in all client-side SDKs as </FronteggProvider> in the React SDK, FronteggAppModule in the Angular SDK or Frontegg in Vue SDK. All the attributes that are discussed below can be found under the @frontegg folder in your node_modules.

contextOptions

contextOptions: ContextOptions - is used for passing your application's or environment credentials, or context when tenantResolver is being used for [Login per tenant] is configured.

events

events?: CustomEventsOptions - can be used for catching various user lifecycle event details (sign-up, user verification and etc), on Frontegg's embedded login. For Hosted login, please use the [Google Tag Manager] integration.

withCompanyName

withCompanyName?: boolean - this attribute can be used for adding or removing the Company name field from Frontegg's sign-up page when using Frontegg's embedded login. The same can be achieved, through the Login box builder for both hosted and embedded login integrations.

hostedLoginBox

hostedLoginBox?: boolean - this attribute defines various OOTB functionalities within the authentication flow and hence important to be passed as true or false, depending on what type of login integration is being used.

customLoader

customLoader?: boolean | ((loading: boolean) => void) - this attribute can be used when you would like to replace Frontegg's default loader with your own application's loader. It can be used for both Embedded and Hosted Login but on Hosted login, the attribute will apply only on your application's pages.

customLoginBox

customLoginBox?: boolean - this attribute is optional and can be passed as true if you do not wish using Frontegg's OOTB UI, you may pass this attribute and use your own UI with Frontegg's authentication and entitlement functionalities. Note, that passing customLoginBox: true, will disable all of the Frontegg's pages, including reset password, tenant invitation accepted and so on.

localizations

localizations?: LocalizationsOverrides - this attribute can be used with Frontegg's embedded login for translations or overriding Frontegg's default texts. The full guide can be founde here.

themeOptions

themeOptions?: FronteggThemeOptions - this attribute can be used with Frontegg's embedded login for overriding Frontegg's default styles. The full guide can be founde here.

entitlementsOptions

entitlementsOptions?: EntitlementsOptions - this attribute should be passed when you're using Frontegg's Entitlements in your application.