<Waitlist /> component
In Waitlist mode, users can register their interest in your app by joining a waitlist. This mode is ideal for apps in early development stages or those wanting to generate interest before launch. Learn more about additional features available in Waitlist mode.
The <Waitlist /> component renders a form that allows users to join for early access to your app.
Enable Waitlist mode
Before using the <Waitlist /> component, you must enable Waitlist mode in the Clerk Dashboard:
- In the Clerk Dashboard, navigate to the Restrictions page.
- Under the Sign-up modes section, enable Waitlist.
Properties
All props are optional.
- Name
afterJoinWaitlistUrl- Type
string- Description
The full URL or path to navigate to after joining the waitlist.
- Name
appearance- Type
Appearance | undefined- Description
Optional object to style your components. Will only affect Clerk components and not Account Portal pages.
- Name
fallback?- Type
ReactNode- Description
An optional element to be rendered while the component is mounting.
- Name
signInUrl- Type
string- Description
The full URL or path to the sign in page. Used for the 'Already have an account? Sign in' link that's rendered. It's recommended to use the environment variable instead.
The following example includes a basic implementation of the <Waitlist /> component. You can use this as a starting point for your own implementation.
import { Waitlist } from '@clerk/react-router'
export default function WaitlistPage() {
return <Waitlist />
}Customization
To learn about how to customize Clerk components, see the customization guide.
Feedback
Last updated on