Skip to Content
Clerk logo

Clerk Docs

Ctrl + K
Go to

<SignUp />

Sign up component example

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


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

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

The example below shows the Sign In page mounted on the url /sign-in. For more information on how to implement this, check out the <SignIn /> UI page.
import { SignUp } from "@clerk/nextjs"; export default function Page() { return <SignUp />; }
import { SignUp } from "@clerk/nextjs"; const SignUpPage = () => ( <SignUp path="/sign-up" routing="path" signInUrl="/sign-in" /> ); export default SignUpPage;


All props below are optional.

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-up.
redirectUrlstringFull URL or path to navigate to 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 to after a successful sign in.
signInUrlstringFull URL or path to the sign in page. Use this property to provide the target of the 'Sign In' link that's rendered.
afterSignUpUrlstringThe full URL or path to navigate after a successful sign up.
unsafeMetadataobjectAn object with the key and value for unsafeMetadata that will be saved to the user after sign up.
E.g. { "company": "companyID1234" }
initialValuesSignUpInitialValuesThe values used to prefill the sign-up fields with.

What did you think of this content?

Clerk © 2023