Skip to Content
Clerk logo

Clerk Docs

Ctrl + K
Go to clerk.com

<SignIn />

Sign in component example

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(opens in a new tab). 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(opens in a new tab). 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 />; }
/pages/sign-in/[[...index]].tsx
import { SignIn } from "@clerk/nextjs"; const SignInPage = () => ( <SignIn path="/sign-in" routing="path" signUpUrl="/sign-up" /> ); export default SignInPage;

Properties

All props below are optional.

NameTypeDescription
appearanceAppearance | undefinedOptional 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.
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.

Customization

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

Last updated on January 10, 2024

What did you think of this content?

Clerk © 2024