SignUpPage API

API reference docs for the React SignUpPage component. Learn about the props, CSS, and other APIs of this exported module.

Demos

For examples and details on the usage of this React component, visit the component demo pages:

import { SignUpPage } from '@toolpad/core/SignUpPage';
// or
import { SignUpPage } from '@toolpad/core';

Name	Type	Default	Description
localeText	object	-	The labels for the account component.
providers	Array<{ id: string, name: string }>	[]	The list of authentication providers to display.
signUp	func	undefined	Callback fired when a user signs up. Signature:`function(provider: AuthProvider, formData: FormData, callbackUrl: string) => void \| Promise` `provider` The authentication provider. `formData` The form data if the provider id is 'credentials'.\ `callbackUrl` The URL to redirect to after signing up.
slotProps	{ confirmPasswordField?: object, emailField?: object, form?: object, oAuthButton?: object, passwordField?: object, privacyLink?: object, submitButton?: object, termsLink?: object }	{}	The props used for each slot inside.
slots	{ confirmPasswordField?: elementType, emailField?: elementType, passwordField?: elementType, privacyLink?: string, submitButton?: elementType, subtitle?: elementType, termsLink?: string, title?: elementType }	{}	The components used for each slot inside. See Slots API below for more details.
sx	Array<func \| object \| bool> \| func \| object	-	The prop used to customize the styles on the `SignUpPage` container See the `sx` page for more details.

The component cannot hold a ref.

Slot name	Default component	Description
emailField	`TextField`	The custom email field component used in the credentials form.
passwordField	`TextField`	The custom password field component used in the credentials form.
confirmPasswordField	`TextField`	The custom confirm password field component used in the credentials form.
submitButton	`Button`	The custom submit button component used in the credentials form.
termsLink	`Link`	The custom terms and conditions link component.
privacyLink	`Link`	The custom privacy policy link component.
title	`Typography`	A component to override the default title section
subtitle	`Typography`	A component to override the default subtitle section

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.