āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāā ā š shadcn/directory/clerk/clerk-docs/_partials/clerk-provider/properties ā āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāā
āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāā
ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā
{/* GH file: https://github.com/clerk/javascript/blob/main/packages/react/src/types.ts */}
<Properties> - `afterMultiSessionSingleSignOutUrl` - `string`The full URL or path to navigate to after a signing out from a currently active account in a multi-session app.
afterSignOutUrlstringThe full URL or path to navigate to after a successful sign-out.
allowedRedirectOriginsArray<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.
allowedRedirectProtocolsArray<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.
appearanceOptional object to style your components. Will only affect Clerk components and not Account Portal pages.
clerkJSUrlstringDefine the URL that @clerk/clerk-js should be hot-loaded from.
clerkJSVariant'headless' | ''If your web application only uses control components, you can set this value to headless and load a minimal ClerkJS bundle for optimal page performance.
clerkJSVersionstringDefine the npm version for @clerk/clerk-js.
domainstring | ((url: URL) => boolean)Required if your application is a satellite application. Sets the domain of the satellite application.
dynamicboolean(For Next.js only) Indicates whether or not Clerk should make dynamic auth data available based on the current request. Defaults to false. Opts the application into dynamic rendering when true. For more information, see Next.js rendering modes and Clerk.
initialStateInitialStateProvide an initial state of the Clerk client during server-side rendering. You don't need to set this value yourself unless you're developing an SDK.
isSatelliteboolean | ((url: URL) => boolean)Whether the application is a satellite application.
localizationOptional object to localize your components. Will only affect Clerk components and not Account Portal pages.
noncestringThis nonce value will be passed to the @clerk/clerk-js script tag. Use it to implement a strict-dynamic CSP. Requires the dynamic prop to also be set.
publishableKeystringThe Clerk Publishable Key for your instance. This can be found on the API keys page in the Clerk Dashboard.
proxyUrlstring | ((url: URL) => string)The URL that Clerk will proxy requests to. Required for applications that run behind a reverse proxy. Can be either a relative path (/__clerk) or a full URL (https://<your-domain>/__clerk).
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.
sdkMetadata{ name: string; version: string; environment: string }Contains information about the SDK that the host application is using. You don't need to set this value yourself unless you're developing an SDK.
selectInitialSession(client: ClientResource) => ActiveSessionResource | nullBy default, the last active session is used during client initialization. This option allows you to override that behavior, e.g. by selecting a specific session.
signInFallbackRedirectUrlstringThe 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.
signUpFallbackRedirectUrlstringThe 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.
signInForceRedirectUrlstringIf provided, this URL will always be redirected to after the user signs in. It's recommended to use the environment variable instead.
signUpForceRedirectUrlstringIf provided, this URL will always be redirected to after the user signs up. It's recommended to use the environment variable instead.
signInUrlstringThis URL will be used for any redirects that might happen and needs to point to your primary application on the client-side. This option is optional for production instances. It is required to be set for a satellite application in a development instance. It's recommended to use the environment variable instead.
signUpUrlstringThis URL will be used for any redirects that might happen and needs to point to your primary application on the client-side. This option is optional for production instances but must be set for a satellite application in a development instance. It's recommended to use the environment variable instead.
standardBrowserbooleanBy default, ClerkJS is loaded with the assumption that cookies can be set (browser setup). On native platforms this value must be set to false.
supportEmailstringOptional support email for display in authentication screens. Will only affect Clerk components and not Account Portal pages.
syncHoststringChrome Extension only To enable, pass the URL of the web application that the extension will sync the authentication state from. See the dedicated guide for more information.
taskUrlsRecord<string, string>The URL paths users are redirected to after sign-up or sign-in when specific session tasks need to be completed. For example, { 'choose-organization': '/onboarding/choose-organization' } redirects users to /onboarding/choose-organization after sign-up if they need to choose an organization.
telemetryfalse | { disabled: boolean; debug: boolean } | undefinedControls whether or not Clerk will collect telemetry data. If set to debug, telemetry events are only logged to the console and not sent to Clerk.
touchSessionbooleanBy default, the Clerk Frontend API touch endpoint{{ target: '_blank' }} is called during page focus to keep the last active session alive. This option allows you to disable this behavior.
waitlistUrlstringThe full URL or path to the waitlist page. If undefined, will redirect to the Account Portal waitlist page.
</Properties>
ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā
āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāā