Auth
Routes to the correct authentication screen based on a supplied `view` or route `path`.
Import
import { Auth } 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/auth.tsx
Props
| Prop | Type | Required | Notes |
|---|---|---|---|
className | string | undefined | No | |
path | string | undefined | No | |
socialLayout | SocialLayout | undefined | No | |
socialPosition | "top" | "bottom" | undefined | No | |
ui | AthenaAuthUiOptions | undefined | No | |
variant | "default" | "secondary" | "tertiary" | "transparent" | undefined | No | |
view | AuthUiView | undefined | No | Built-in or plugin auth view id. |
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.