@clerk/nextjs
Version:
Clerk SDK for NextJS
33 lines • 1.53 kB
TypeScript
import type { ClerkProviderProps } from '@clerk/react';
import type { Ui } from '@clerk/react/internal';
import type { Without } from '@clerk/shared/types';
import type React from 'react';
export type NextClerkProviderProps<TUi extends Ui = Ui> = Without<ClerkProviderProps<TUi>, 'publishableKey'> & {
/**
* Used to override the default NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY env variable if needed.
* This is optional for NextJS as the ClerkProvider will automatically use the NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY env variable if it exists.
*/
publishableKey?: string;
/**
* If set to true, the NextJS middleware will be invoked
* every time the client-side auth state changes (sign-out, sign-in, organization switch etc.).
* That way, any auth-dependent logic can be placed inside the middleware.
* Example: Configuring the middleware to force a redirect to `/sign-in` when the user signs out
*
* @default true
*/
__internal_invokeMiddlewareOnAuthStateChange?: boolean;
/**
* If set to true, ClerkProvider will opt into dynamic rendering and make auth data available to all wrapper components.
*
* @default false
*/
dynamic?: boolean;
/**
* @internal
* When provided, the client ClerkProvider will render this slot instead of the default ClerkScripts.
* Used by the server provider to pass scripts rendered in a Suspense boundary.
*/
__internal_scriptsSlot?: React.ReactNode;
};
//# sourceMappingURL=types.d.ts.map