SignIn component is the fastest way to add a sign in flow to your application.
By default, Clerk hosts the component on your "accounts" subdomain, which you configure in production with a CNAME in your DNS records.
SignIn component can also be mounted within your application, or presented as a modal over your application.
To mount the
SignIn component, first import it from our NPM package:
Then, place it anywhere in your JSX:
The mounted component uses hash-based routing by default. As the user signs in, the hash portion of the URL will update to reflect the current step.
With additional configuration, the mounted component can use path-based routing instead of hash-based routing.
First, ensure your
<ClerkProvider> component has its
navigate prop configured.
Then, add the
routing props to your
SignIn component. Set
path to the path where the component renders:
Important: When using path-based routing, the component must render on
path and all of its subpaths.
For Next.js, use an optional catch-all route like
For React Router, use a wildcard path like
Presenting as a modal
SignIn component can also be presented as a modal. This is typically used on pages that show content whether or not the user is signed in.