`<ClerkProvider>`

The <ClerkProvider> component wraps your React application to provide active session and user context to Clerk's hooks and other components.

Usage

The <ClerkProvider> component must be added to your React entrypoint.

The <ClerkProvider> component needs to access headers to authenticate correctly. This means anything wrapped by the provider will be opted into dynamic rendering at request time. If you have static-optimized or ISR pages that you would prefer not to be opted into dynamic rendering, make sure they are not wrapped by <ClerkProvider>.

This is easiest to accomplish by ensuring that <ClerkProvider> is added further down the tree to wrap route groups that explicitly need authentication instead of having the provider wrap your application root as recommended above. For example, if your project includes a set of landing/marketing pages as well as a dashboard that requires sign in, you would create separate (marketing) and (dashboard) route groups. Adding <ClerkProvider> to the (dashboard)/layout.jsx layout file will ensure that only those routes are opted into dynamic rendering, allowing the marketing routes to be statically optimized.

app/layout.tsx
import React from "react";
import { ClerkProvider } from "@clerk/nextjs";
 
export default function RootLayout({
  children,
}: {
  children: React.ReactNode;
}) {
  return (
    <html lang="en">
      <head>
        <title>Next.js 13 with Clerk</title>
      </head>
      <ClerkProvider>
        <body>{children}</body>
      </ClerkProvider>
    </html>
  );
}

_app.tsx
import { ClerkProvider } from "@clerk/nextjs";
import type { AppProps } from "next/app";
 
function MyApp({ Component, pageProps }: AppProps) {
  return (
    <ClerkProvider {...pageProps}>
      <Component {...pageProps} />
    </ClerkProvider>
  );
}
 
export default MyApp;

index.tsx
import React from "react";
import ReactDOM from "react-dom";
import { ClerkProvider } from "@clerk/clerk-react";
import App from "./App";
 
const publishableKey = process.env.REACT_APP_CLERK_PUBLISHABLE_KEY;
 
ReactDOM.render(
  <React.StrictMode>
    <ClerkProvider publishableKey={publishableKey}>
      <App/>
    </ClerkProvider>
  </React.StrictMode>,
  document.getElementById("root")
);

Other meta-frameworks, like Remix and Gatsby, have wrappers around <ClerkProvider> to make their integrations tighter.

Properties

Name	Type	Description
`publishableKey`	`string`	The Clerk publishable key for your instance. This can be found in your Clerk Dashboard on the API Keys(opens in a new tab) page.
`routerPush?`	`(to: string) => Promise<unknown> \| void`	A function which takes the destination path as an argument and performs a "push" navigation.
`routerReplace?`	`(to: string) => Promise<unknown> \| void`	A function which takes the destination path as an argument and performs a "replace" navigation.
`clerkJSUrl?`	`string`	Define the URL that `@clerk/clerk-react` should hot-load `@clerk/clerk-js` from.
`clerkJSVariant?`	`string`	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.
`clerkJSVersion?`	`string`	Define the npm version for `@clerk/clerk-js`.
`supportEmail?`	`string`	Optional support email for display in authentication screens. Will only affect Clerk Components and not Account Portal pages.
`appearance?`	`Appearance \| undefined`	Optional object to style your components. Will only affect Clerk Components and not Account Portal pages.
`localization`	`Localization \| undefined`	Optional object to localize your components. Will only affect Clerk Components and not Account Portal pages.
`allowedRedirectOrigins?`	`Array<string \| RegExp>`	Optional array of domains used to validate against the query param of an auth redirect. If no match is made, the redirect is considered unsafe and the default redirect will be used with a warning passed to the console.
`afterSignInUrl?`	`string`	The default URL to use after the user signs in. Defaults to `/`. It's recommended to use the environment variable instead.
`afterSignUpUrl?`	`string`	The default URL to use after the user signs up. Defaults to `/`. It's recommended to use the environment variable instead.

| isSatellite? | boolean \| ((url: URL) => boolean) | This option defines that the application is a satellite application. | | domain? | string \| ((url: URL) => boolean) | This option sets the domain of the satellite application. If your application is a satellite application, this option is required. | | signInUrl | string | This URL will be used for any redirects that might happen and needs to point to your primary application. This option is optional for production instances and required for development instances. It's recommended to use the environment variable instead. |

| telemetry? | false \| { disabled?: boolean; debug?: boolean } \| undefined | Controls whether or not Clerk will collect telemetry data. |

Last updated on March 8, 2024