SignInPage API

API reference docs for the React SignInPage 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 { SignInPage } from '@toolpad/core/SignInPage';
// or
import { SignInPage } from '@toolpad/core';

Props of the native component are also available.

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.
signIn	func	undefined	Callback fired when a user signs in. 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 in.
slotProps	{ emailField?: object, forgotPasswordLink?: object, form?: object, oAuthButton?: object, passwordField?: object, rememberMe?: object, signUpLink?: object, submitButton?: object }	{}	The props used for each slot inside.
slots	{ emailField?: elementType, forgotPasswordLink?: elementType, passwordField?: elementType, rememberMe?: elementType, signUpLink?: elementType, submitButton?: elementType, subtitle?: elementType, 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 `SignInPage` 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.
submitButton	`Button`	The custom submit button component used in the credentials form.
forgotPasswordLink	`Link`	The custom forgot password link component used in the credentials form.
signUpLink	`Link`	The custom sign up link component used in the credentials form.
title	`Typography`	A component to override the default title section
subtitle	`Typography`	A component to override the default subtitle section
rememberMe	`FormControlLabel`	A custom checkbox placed in the credentials form

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