Skip to content

Account API

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

Demos

Import

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

Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the native component are also available.

NameTypeDefaultDescription
signInLabelstring'Sign In'

The label for the sign in button.

signOutLabelstring'Sign Out'

The label for the sign out button.

slotProps{ avatar?: object, iconButton?: object, signInButton?: object, signOutButton?: object }{}

Props to pass to the constituent components in the Account component.

The component cannot hold a ref.

Source code

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