<SignIn /> | Clerk

The <SignIn /> component renders a UI for signing in users. The functionality of the <SignIn /> component is controlled by the instance settings you specify in your Clerk Dashboard. You can further customize your <SignIn /> component by passing additional properties at the time of rendering.

Usage

Below is basic implementation of the <SignIn /> component. You can use this as a starting point for your own implementation.

You can embed the <SignIn /> component using the Next.js optional catch-all route. This allows you to redirect the user inside your application. The <SignIn /> component should be mounted on a public page.

/app/sign-in/[[...sign-in]]/page.tsx
  import { SignIn } from "@clerk/nextjs";
 
  export default function Page() {
    return <SignIn path="/sign-in" signUpUrl="/sign-up" />
  };

You will notice a path prop is being passed to the SignIn /> component. This is because, by default, the routing strategy is set to path, requiring the path prop to be passed. In Next.js applications, you can either pass the path prop to the <SignIn /> component, or you can define the NEXT_PUBLIC_CLERK_SIGN_IN_URL and NEXT_PUBLIC_CLERK_SIGN_UP_URL environment variables.

The example below shows how to mount the <SignIn /> component on a page without a path prop. Select the .env.local tab to see an example of how to define the appropriate environment variables.

/app/sign-in/[[...sign-in]]/page.tsx
import { SignIn } from "@clerk/nextjs";
 
export default function Page() {
  return <SignIn />;
}

.env.local
NEXT_PUBLIC_CLERK_SIGN_IN_URL=/sign-in
NEXT_PUBLIC_CLERK_SIGN_UP_URL=/sign-up

/src/sign-in/[[...index]].tsx
import { SignIn } from "@clerk/clerk-react";
 
const SignInPage = () => (
  <SignIn path="/sign-in" />
);
 
export default SignInPage;

app/routes/sign-in/$.tsx
import { SignIn } from "@clerk/remix";
 
export default function SignInPage() {
  return (
    <div style={{ border: "2px solid blue", padding: "2rem" }}>
      <h1>Sign In route</h1>
      <SignIn path="/sign-in" />
    </div>
  );
}

/pages/sign-in.js
import { SignIn } from "gatsby-plugin-clerk";
 
export default function SignInPage() {
  return (
    <div style={{ border: "2px solid blue", padding: "2rem" }}>
      <h1>Sign In Up route</h1>
      <SignIn path="/sign-in" />
    </div>
  );
}

In the example below, the mountSignIn() method is used to render the <SignIn /> component to a <div> element with id="sign-in".

To learn more about the methods available for rendering and controlling the <SignIn /> component in a JavaScript application, see the JavaScript reference docs.

index.js
import Clerk from '@clerk/clerk-js';
import { dark } from "@clerk/themes";
 
// Add a <div> element with id="sign-in" to your HTML
document.querySelector<HTMLDivElement>('#app')!.innerHTML = `
  <div
    id="sign-in"
  >
  </div>
`;
 
const signInComponent = document.querySelector<HTMLDivElement>('#sign-in')!;
 
// Initialize Clerk with your Clerk publishable key
const clerk = new Clerk(`{{pub_key}}`);
await clerk.load();
 
clerk.mountSignIn(signInComponent, {
  appearance: {
    baseTheme: dark
  }
});

index.html
<!-- Add a <div> element with id="sign-in" to your HTML -->
<div id="sign-in"></div>
 
<script>
  // Get this URL and Publishable Key from the Clerk Dashboard
  const clerkPublishableKey = {{pub_key}};
  const frontendApi = '[your-domain].clerk.accounts.dev';
  const version = '@latest'; // Set to appropriate version
 
  // Creates asynchronous script
  const script = document.createElement('script');
  script.setAttribute('data-clerk-frontend-api', frontendApi);
  script.setAttribute('data-clerk-publishable-key', clerkPublishableKey);
  script.async = true;
  script.src = `https://${frontendApi}/npm/@clerk/clerk-js${version}/dist/clerk.browser.js`;
 
  script.addEventListener('load', async function () {
    await window.Clerk.load();
 
    const signInComponent = document.querySelector('#sign-in');
 
    window.Clerk.openSignIn(signInComponent, {
      appearance: {
        baseTheme: dark
      }
    });
  });
  document.body.appendChild(script);
</script>

Properties

All props below are optional.

Name	Type	Description
`appearance`	`Appearance \| undefined`	Optional object to style your components. Will only affect Clerk Components and not Account Portal pages.
`routing`	`'hash' \| 'path' \| 'virtual'`	The routing strategy for your pages. Defaults to `'path'`.
`path`	`string`	The path where the component is mounted on when path-based routing is used. This prop will be required for Next.js and Remix applications that do not set the appropriate environment variables, and is required for all other SDK's. This prop is ignored in hash- and virtual-based routing.
`redirectUrl`	`string`	Full URL or path to navigate after successful sign in or sign up. The same as setting `afterSignInUrl` and `afterSignUpUrl` to the same value.
`afterSignInUrl`	`string`	The full URL or path to navigate after a successful sign in. Defaults to `/`.
`signUpUrl`	`string`	Full URL or path to the sign up page. Use this property to provide the target of the 'Sign Up' link that's rendered.
`afterSignUpUrl`	`string`	The full URL or path to navigate after a successful sign up. Defaults to `/`.
`initialValues`	`SignInInitialValues`	The values used to prefill the sign-in fields with.

Customization

To learn about how to customize Clerk components, see the customization documentation.