UserButton
Authenticated user trigger button that opens the user actions dropdown.
Import
import { UserButton } from "@xylex-group/athena-auth-ui"Details
- Category:
component - Primary entrypoint:
@xylex-group/athena-auth-ui - Public entrypoints:
@xylex-group/athena-auth-ui - Source:
packages/heroui/src/components/auth/user/user-button.tsx
Props
| Prop | Type | Required | Notes |
|---|---|---|---|
className | string | undefined | No | |
size | "default" | "icon" | undefined | No | |
placement | Placement | undefined | No | The placement of the element with respect to its anchor element. |
variant | "secondary" | "tertiary" | "danger" | "danger-soft" | "ghost" | "outline" | "primary" | undefined | No | |
links | (ReactElement<unknown, string | React.JSXElementConstructor<any>> | UserButtonLink)[] | undefined | No | Additional menu entries rendered above the built-in items. |
hideSettings | boolean | undefined | No | Hide the built-in "Settings" link. Useful when replacing it via links. |
ui | AthenaAuthUiOptions | undefined | No |
Notes
- Most interactive auth components expect to be rendered under
AuthProviderso hooks such asuseAuthand the configured navigation bridge are available. - See Customization Guide for provider-level localization, route overrides, class-name slots, loading overrides, and email template key mapping.