@orangecheck/ui / OcAccountMenuViewProps
Interface: OcAccountMenuViewProps
Defined in: account-menu.tsx:601
Extends
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
<a id="property-build"></a> build? | OcAccountMenuBuildInfo | Optional BuildFooter info. When present, renders a tiny mono footer at the bottom of the popover with site · vX.Y.Z · sha — the SHA links to the matching GitHub commit when repo is also provided. Drive this from your next.config.ts via NEXT_PUBLIC_APP_VERSION / NEXT_PUBLIC_BUILD_SHA env vars. | OcAccountMenuProps.build | account-menu.tsx:204 |
<a id="property-classname"></a> className? | string | className overrides for layout-level customisation. | OcAccountMenuProps.className | account-menu.tsx:212 |
<a id="property-current"></a> current | EcosystemSlug | Which family property this site IS. Used to label the section header (§ signed in · vault.ochk.io) and to suppress the family-dashboard menu item when the user is already on home. | OcAccountMenuProps.current | account-menu.tsx:144 |
<a id="property-menuitems"></a> menuItems? | readonly OcAccountMenuItem[] | Site-specific menu items, rendered between the section header and the family-dashboard / sign-out rows. Keep this short — 2–6 entries is the sweet spot. Pass [] (or omit) for sites with no per-site routes worth surfacing. | OcAccountMenuProps.menuItems | account-menu.tsx:173 |
<a id="property-popoverclassname"></a> popoverClassName? | string | - | OcAccountMenuProps.popoverClassName | account-menu.tsx:214 |
<a id="property-primarynavlinks"></a> primaryNavLinks? | readonly OcAccountMenuItem[] | Centered primary nav links (typically dashboard · docs · spec). Rendered inside the popover at viewport widths below sm (640px) — these are the same links the <OcPrimaryNav> row shows inline at sm+, but at ultra-small widths the inline row hides and this popover section takes its place. The result: one dropdown surface owns navigation on phones, no separate hamburger drawer required. | OcAccountMenuProps.primaryNavLinks | account-menu.tsx:183 |
<a id="property-secondarynavlinks"></a> secondaryNavLinks? | readonly OcAccountMenuItem[] | Tertiary nav links (about / contact / status / privacy / etc.). Always visible inside the popover. Folds the legacy mobile-only hamburger drawer's contents into the same dropdown as everything else, so there's exactly one nav surface to learn. | OcAccountMenuProps.secondaryNavLinks | account-menu.tsx:190 |
<a id="property-session"></a> session | OcAccountMenuSession | The session to render. When using <OcAccountMenuView> directly (rather than the connected <OcAccountMenu>), pass an adapter over your local auth context. | - | account-menu.tsx:607 |
<a id="property-showfamilydashboard"></a> showFamilyDashboard? | boolean | When true (default), shows a family dashboard ↗ link to https://ochk.io/dashboard. Set false for home (already there) or for sites that don't want it. | OcAccountMenuProps.showFamilyDashboard | account-menu.tsx:196 |
<a id="property-signinlabel"></a> signInLabel? | string | Label for the anonymous "sign in" affordance. Default 'sign in'. | OcAccountMenuProps.signInLabel | account-menu.tsx:153 |
<a id="property-signinurl"></a> signInUrl? | string | Where the anonymous "sign in" affordance points. Default '/signin' — works with every site's in-place <OcSignIn> page. Pass 'https://ochk.io/signin' if you want to bounce to the auth host instead. | OcAccountMenuProps.signInUrl | account-menu.tsx:151 |
<a id="property-signoutredirect"></a> signOutRedirect? | string | Where the browser lands after the user signs out. Default '/' — the current site's own home. On sign-out the menu fires signOut() (whose logout round-trip is keepalive, so it survives the navigation) and immediately hard-navigates here. Navigating in the same tick is deliberate: it forecloses the race where an auth-gated page observes the session flip to anonymous and runs its own redirect-to-sign-in first. Sign-out means "leave", not "go sign in again" — so the family default is the site's home, never a sign-in page or the auth host. | OcAccountMenuProps.signOutRedirect | account-menu.tsx:166 |
<a id="property-sitestate"></a> siteState? | SiteState | Optional lifecycle chip rendered inside the BuildFooter line (between site and version). Mirrors the chip on the logo so both surfaces agree. | OcAccountMenuProps.siteState | account-menu.tsx:210 |
<a id="property-triggerclassname"></a> triggerClassName? | string | - | OcAccountMenuProps.triggerClassName | account-menu.tsx:213 |