Component Reference

Clerk offers a comprehensive suite of components designed to seamlessly integrate authentication and multi-tenancy into your application. With Clerk components, you can easily customize the appearance of authentication components and pages, manage the entire authentication flow to suit your specific needs, and even build robust SaaS applications.

Authentication components

• <SignIn />
• <SignUp />
• <GoogleOneTap />
• <TaskChooseOrganization />
• <TaskResetPassword />
• <TaskSetupMFA />
• <Waitlist />

User components

• <UserAvatar />
• <UserButton />
• <UserProfile />

Organization components

• <CreateOrganization />
• <OrganizationProfile />
• <OrganizationSwitcher />
• <OrganizationList />

Billing components

• <PricingTable />
• <CheckoutButton />
• <PlanDetailsButton />
• <SubscriptionDetailsButton />

Control components

Control components manage authentication-related behaviors in your application. They handle tasks such as controlling content visibility based on user authentication status, managing loading states during authentication processes, and redirecting users to appropriate pages. Control components render at <Loading /> and <Loaded /> states for assertions on the Clerk object. A common example is the <Show /> component, which allows you to conditionally render content based on authentication and authorization state.

• <AuthenticateWithRedirectCallback />
• <ClerkDegraded />
• <ClerkFailed />
• <ClerkLoaded />
• <ClerkLoading />
• <RedirectToCreateOrganization />
• <RedirectToOrganizationProfile />
• <RedirectToSignIn />
• <RedirectToSignUp />
• <RedirectToTasks />
• <RedirectToUserProfile />
• <Show />

Unstyled components

• <SignInButton />
• <SignInWithMetamaskButton />
• <SignUpButton />
• <SignOutButton />

Utilities components

• <UNSAFE_PortalProvider />

Customization guides

• Customize components with the appearance prop
• Localize components with the localization prop (experimental)
• Add pages to the <UserProfile /> component
• Add pages to the <OrganizationProfile /> component

Secured by Clerk branding

By default, Clerk displays a Secured by Clerk badge on Clerk components. You can remove this branding by following these steps:

1. In the Clerk Dashboard, navigate to your application's Settings⁠.
2. Under Branding, toggle on the Remove "Secured by Clerk" branding option.