The <UserButton /> component is used to render the familiar user button UI popularized by Google.
Clerk is the only provider with multi-session support, allowing users to sign into multiple accounts at once and switch between them. For multi-session apps, the <UserButton /> automatically supports instant account switching, without the need of a full page reload. For more information, you can check out the Multi-session applications guide.
The full URL or path to navigate to after a signing out from a currently active account in a multi-session app. Deprecated - Move afterSignOutUrl to <ClerkProvider/>.
Name
afterSignOutUrl (deprecated)
Type
string
Description
The full URL or path to navigate to after a successful sign-out. Deprecated - Move afterSignOutUrl to <ClerkProvider/>.
Name
afterSwitchSessionUrl
Type
string
Description
The full URL or path to navigate to after a successful account change in a multi-session app.
Controls whether the <UserButton /> should open by default during the first render.
Name
showName
Type
boolean
Description
Controls if the user name is displayed next to the user image button.
Name
signInUrl
Type
string
Description
The full URL or path to navigate to when the Add another account button is clicked. It's recommended to use the environment variable instead.
Name
userProfileMode
Type
'modal' | 'navigation'
Description
Controls whether clicking the Manage your account button will cause the <UserProfile /> component to open as a modal, or if the browser will navigate to the userProfileUrl where <UserProfile /> is mounted as a page. Defaults to: 'modal'.
Name
userProfileProps
Type
object
Description
Specify options for the underlying <UserProfile /> component. For example: {additionalOAuthScopes: {google: ['foo', 'bar'], github: ['qux']}}.
Name
userProfileUrl
Type
string
Description
The full URL or path leading to the user management interface.
In the following example, <UserButton /> is mounted inside a header component, which is a common pattern on many websites and applications. When the user is signed in, they will see their avatar and be able to open the popup menu.