Account
A component that renders an account management dropdown for your application.
The Account
component is a quick and easy way to display an account management menu for authenticated users. It is deeply integrated with the SignInPage
and DashboardLayout
components, meaning that it automatically appears in the top navigation bar inside DashboardLayout
once your users have signed in through the SignInPage
.
States
Signed In
If a session
object is present, the component is rendered as a dropdown containing the user's account details as well as an option to sign out.
Signed Out
When signed out, the component renders as an inline sign in button within the dashboard layout.
Customization
The <Account />
component is composed of multiple sub-components:
<SignInButton />
<AccountPreview />
<Popover />
<SignOutButton />
You can pass extra props to them through the slotProps
prop on the <Account />
component. You may also completely override them by passing your own custom components to <Account />
through the slots
prop.
The labels can be customized through the localeText
prop.
Slot Props
The AccountPreview
component has two variants, condensed
(the default) and expanded
. You can change the variant used inside <Account />
by passing in custom props through slotProps
:
Bharat Kashyap
Slots
You can pass in your own components inside the Account
popover through the slots
prop.
Popover Content
You can wrap the default sub-components – such as SignOutButton
and AccountPreview
– and wrap them in AccountPopoverHeader
and AccountPopoverFooter
components to create custom account popovers, as shown in the following demos:
Account Switcher
You can build advanced menus – such as a tenant switcher – by passing in a component that wraps AccountPreview
and SignOutButton
with a custom menu:
Labels
You can pass in custom labels – including of different languages – using the localeText
prop.
API
See the documentation below for a complete reference to all of the props and classes available to the components mentioned here.