<SignUp /> | Clerk

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.

Usage

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.

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

You will notice a path prop is being passed to the SignUp /> 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 <SignUp /> 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 <SignUp /> 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.

/pages/sign-up/[[...index]].tsx
import { SignUp } from "@clerk/nextjs";
 
const SignUpPage = () => (
  <SignUp />
);
export default SignUpPage;

.env.local
CLERK_SIGN_IN_URL=/sign-in
CLERK_SIGN_UP_URL=/sign-up

sign-up.jsx
import { SignUp } from "@clerk/clerk-react";
 
function SignUpPage() {
  return <SignUp path="/sign-up" />;
}

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

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

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

To learn more about the methods available for rendering and controlling the <SignUp /> 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-up"
  >
  </div>
`;
 
const signUpComponent = document.querySelector<HTMLDivElement>('#sign-up')!;
 
// Initialize Clerk with your Clerk publishable key
const clerk = new Clerk(`{{pub_key}}`);
await clerk.load();
 
clerk.mountSignUp(signUpComponent, {
  appearance: {
    baseTheme: dark
  }
});

index.html
<!-- Add a <div> element with id="sign-up" to your HTML -->
<div id="sign-up"></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-up');
 
    window.Clerk.openSignUp(signUpComponent, {
      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. Note: If you are using environment variables for Next.js or Remix to specify your routes, this will be set to `path`.
`path`	`string`	The path where the component is mounted on when path-based routing is used For example, `/sign-up` This prop is ignored in hash- and virtual-based routing.
`redirectUrl`	`string`	Full URL or path to navigate to 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 to after a successful sign in. Defaults to `/`.
`signInUrl`	`string`	Full URL or path to the sign in page. Use this property to provide the target of the 'Sign In' link that's rendered.
`afterSignUpUrl`	`string`	The full URL or path to navigate after a successful sign up. Defaults to `/`.
`unsafeMetadata`	`object`	An object with the key and value for unsafeMetadata that will be saved to the user after sign up. E.g. `{ "company": "companyID1234" }`
`initialValues`	`SignUpInitialValues`	The values used to prefill the sign-up fields with.

Customization

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