Skip to Content
Clerk logo

Clerk Docs

Ctrl + K
Go to clerkstage.dev

<SignIn /> component

Sign in component example

The <SignIn /> component renders a UI for signing in users. The functionality of the <SignIn /> component are controlled by the instance settings you specify in your Clerk Dashboard(opens in a new tab), such as sign-up options and social connections. You can further customize your <SignIn /> component by passing additional properties at the time of rendering.

The following methods available on an instance of the Clerk class are used to render and control the <SignIn /> component:

mountSignIn()

Render the <SignIn /> component to an HTML <div> element.

mountSignIn() properties

function mountSignIn(node: HTMLDivElement, props?: SignInProps): void;
NameTypeDescription
nodeHTMLDivElement(opens in a new tab)The container <div> element used to render in the <SignIn /> component
props?SignInPropsThe properties to pass to the <SignIn /> component

mountSignIn() usage

In the example below, the <SignIn /> component is rendered to a <div> element with id="sign-in". The <SignIn /> component will be rendered with the default settings specified in your Clerk Dashboard(opens in a new tab).

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'
  }
});
<!-- Add a <div> element with id="sign-in" to your HTML -->
<div id="sign-in"></div>
 
<script>
  const script = document.createElement('script');
  // Set your Clerk publishable key
  script.setAttribute('data-clerk-publishable-key', `{{pub_key}}`);
  script.async = true;
  script.src = `https://[your-domain].clerk.accounts.dev/npm/@clerk/clerk-js@latest/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>

unmountSignIn()

Unmount and run cleanup on an existing <SignIn /> component instance.

unmountSignIn() properties

function unmountSignIn(node: HTMLDivElement): void;
NameTypeDescription
nodeHTMLDivElement(opens in a new tab)The container <div> element with a rendered <SignIn /> component instance

unmountSignIn() usage

import Clerk from '@clerk/clerk-js';
 
document.querySelector<HTMLDivElement>('#app')!.innerHTML = `
  <div
    id="sign-in"
  ></div>
`
 
const signInComponent = document.querySelector<HTMLDivElement>('#sign-in')!;
 
const clerk = new Clerk('pk_[publishable_key]');
 
await clerk.load();
 
clerk.mountSignIn(signInComponent);
 
// ...
 
clerk.unmountSignIn(signInComponent);
<div id="sign-in"></div>
<script>
  const script = document.createElement('script');
  script.setAttribute('data-clerk-publishable-key', 'pk_[publishable_key]');
  script.async = true;
  script.src = `https://[your-domain].clerk.accounts.dev/npm/@clerk/clerk-js@latest/dist/clerk.browser.js`;
 
  script.addEventListener('load', async function () {
    await window.Clerk.load();
 
    const signInComponent = document.querySelector('#sign-in');
 
    window.Clerk.mountSignIn(signInComponent);
 
    // ...
 
    window.Clerk.unmountSignIn(signInComponent);
  });
  document.body.appendChild(script);
</script>

openSignIn()

Opens the <SignIn /> component as an overlay at the root of your HTML body element.

openSignIn() properties

function openSignIn(props?: SignInProps): void;
NameTypeDesciption
props?SignInPropsThe properties to pass to the <SignIn /> component

openSignIn() usage

import Clerk from '@clerk/clerk-js';
import { dark } from "@clerk/themes";
 
const clerk = new Clerk('pk_[publishable_key]');
await clerk.load();
 
clerk.openSignIn({
  appearance: {
    baseTheme: dark
  }
});
<script>
  const script = document.createElement('script');
  script.setAttribute('data-clerk-publishable-key', 'pk_[publishable_key]');
  script.async = true;
  script.src = `https://[your-domain].clerk.accounts.dev/npm/@clerk/clerk-js@latest/dist/clerk.browser.js`;
 
  script.addEventListener('load', async function () {
    await window.Clerk.load();
 
    window.Clerk.openSignIn({
      appearance: {
        baseTheme: dark
      }
    });
  });
  document.body.appendChild(script);
</script>

closeSignIn()

Closes the sign in overlay.

closeSignIn() properties

function closeSignIn(): void;

closeSignIn() usage

import Clerk from '@clerk/clerk-js';
import { dark } from "@clerk/themes";
 
const clerk = new Clerk('pk_[publishable_key]');
await clerk.load();
 
clerk.openSignIn();
 
// ...
 
clerk.closeSignIn();
<script>
  const script = document.createElement('script');
  script.setAttribute('data-clerk-publishable-key', 'pk_[publishable_key]');
  script.async = true;
  script.src = `https://[your-domain].clerk.accounts.dev/npm/@clerk/clerk-js@latest/dist/clerk.browser.js`;
 
  script.addEventListener('load', async function () {
    await window.Clerk.load();
 
    window.Clerk.openSignIn();
 
    // ...
 
    window.Clerk.closeSignIn();
  });
  document.body.appendChild(script);
</script>

SignInProps

All props below are optional.

NameTypeDescription
routing'hash' | 'path' | 'virtual'The routing strategy for your pages.
Note: If you are using environment variables for Next.js or Remix to specify your routes, this will be set to path.
pathstringThe path where the component is mounted on when path-based routing is used e.g. /sign-in.
redirectUrlstringFull URL or path to navigate after successful sign in or sign up.
The same as setting afterSignInUrl and afterSignUpUrl to the same value.
afterSignInUrlstringThe full URL or path to navigate after a successful sign in.
signUpUrlstringFull URL or path to the sign up page. Use this property to provide the target of the 'Sign Up' link that's rendered.
afterSignUpUrlstringThe full URL or path to navigate after a successful sign up.
initialValuesSignInInitialValuesThe values used to prefill the sign-in fields with.

What did you think of this content?

Clerk © 2024