Post-sign-out navigation
Set a destination after a user signs out of Clerk.
Clerk · Type Alias
ClerkOptions
ClerkOptions is the optional configuration object accepted by Clerk.load(). Its properties customize loading-related behavior, including where users go after signing out.
How it works
ClerkOptions is the optional object accepted by Clerk.load(). It configures loading behavior through properties such as post-sign-out navigation, and each property can be omitted because the entire options object is optional.
Syntax
clerk.load(options?: ClerkOptions)Parameters
| Name | Type | Description |
|---|---|---|
options | ClerkOptions | Optional configuration object accepted by load(); its documented properties are optional. |
Returns
Not specified on the referenced page.
Key points
- ClerkOptions is the object argument supplied to Clerk.load().
- You can configure only the loading behaviors relevant to your application.
- afterSignOutUrl controls the destination after the current user finishes signing out.
- The multi-session-specific sign-out redirect should be considered separately from general sign-out behavior.
Common mistakes
- Do not assume any ClerkOptions property is required when calling load().
Example: Pass options to Clerk.load()
import { Clerk } from '@clerk/clerk-js';
const clerk = new Clerk(import.meta.env.VITE_CLERK_PUBLISHABLE_KEY);
await clerk.load({
afterSignOutUrl: '/signed-out',
});Loads Clerk with an optional ClerkOptions object containing a post-sign-out destination.
When to use it
Minimal SDK configuration
Configure only selected SDK loading behaviors while leaving defaults unchanged.
Multi-session sign-out handling
Support applications where more than one session can be active.
Interview questions
QWhat is ClerkOptions used for?
ClerkOptions is the optional object passed to Clerk.load(). It contains configuration properties that control Clerk's loading behavior, and every property is optional.
Follow-up: What should you do when no loading customization is needed? Call clerk.load() without an options object.
QAre all ClerkOptions properties required?
A caller can provide only the options it needs, such as afterSignOutUrl. Omitted properties retain Clerk's default behavior.
Follow-up: How can you avoid changing unrelated behavior? Pass a narrowly scoped object containing only the desired property.
QWhere is ClerkOptions accepted?
ClerkOptions is documented under the Clerk class's load() method. The method accepts an optional object whose properties configure the SDK during loading.
Follow-up: Where should you look for the available fields? Consult the Clerk class reference for the SDK integration being used.
Related
Clerkload()afterSignOutUrlafterMultiSessionSingleSignOutUrl