āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāā ā š shadcn/directory/clerk/clerk-docs/_partials/javascript/clerk-options ā āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāā
āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāā
ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā
The load() method accepts an optional object that accepts the following props. All props are optional.
Optional object to style your components. Will only affect [Clerk components][components-ref] and not [Account Portal][ap-ref] pages.
localizationOptional object to localize your components. Will only affect [Clerk components][components-ref] and not [Account Portal][ap-ref] pages.
routerPush?(to: string) => Promise<unknown> | voidA function which takes the destination path as an argument and performs a "push" navigation.
routerReplace?(to: string) => Promise<unknown> | voidA function which takes the destination path as an argument and performs a "replace" navigation.
pollingboolean | undefinedDictates if we should poll against Clerk's backend every 5 minutes. Defaults to true.
selectInitialSessionAn optional function which allows you to control which active session is the initial session to base a user's state off of. Defaults to the first session in the client's sessions array.
standardBrowserboolean | undefinedControls if ClerkJS will load with the standard browser set up using Clerk cookies. Defaults to true.
supportEmailstring | undefinedOptional support email for display in authentication screens.
touchSessionboolean | undefinedIndicates whether the session should be "touched" when user interactions occur, used to record these interactions. Defaults to true.
signInUrlstring | undefinedThe default URL to use to direct to when the user signs in. It's recommended to use the environment variable instead.
signUpUrlstring | undefinedThe default URL to use to direct to when the user signs up. It's recommended to use the environment variable instead.
signInForceRedirectUrl?stringIf provided, this URL will always be redirected to after the user signs in. It's recommended to use the environment variable instead.
signUpForceRedirectUrl?stringIf provided, this URL will always be redirected to after the user signs up. It's recommended to use the environment variable instead.
signInFallbackRedirectUrl?stringThe fallback URL to redirect to after the user signs in, if there's no redirect_url in the path already. Defaults to /. It's recommended to use the environment variable instead.
signUpFallbackRedirectUrl?stringThe fallback URL to redirect to after the user signs up, if there's no redirect_url in the path already. Defaults to /. It's recommended to use the environment variable instead.
afterSignOutUrl?stringThe full URL or path to navigate to after a successful sign-out.
allowedRedirectOrigins?Array<string | RegExp>An optional array of domains to validate user-provided redirect URLs against. If no match is made, the redirect is considered unsafe and the default redirect will be used with a warning logged in the console.
allowedRedirectProtocols?Array<string>An optional array of protocols to validate user-provided redirect URLs against. If no match is made, the redirect is considered unsafe and the default redirect will be used with a warning logged in the console.
isSatelliteboolean | ((url: URL) => boolean) | undefinedClerk flag for satellite apps. Experimental.
telemetry?false | { disabled?: boolean; debug?: boolean } | undefinedControls whether or not Clerk will collect telemetry data. </Properties>
ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā
āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāā