oc · docs
docs / documentation

@orangecheck/design


@orangecheck/design / OcAccountMenuViewProps

Interface: OcAccountMenuViewProps

Defined in: chrome/account-menu.tsx:616

Extends

Properties

PropertyTypeDescriptionInherited fromDefined in
<a id="property-build"></a> build?OcAccountMenuBuildInfoOptional 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.buildchrome/account-menu.tsx:215
<a id="property-classname"></a> className?stringclassName overrides for layout-level customisation.OcAccountMenuProps.classNamechrome/account-menu.tsx:223
<a id="property-current"></a> currentEcosystemSlugWhich 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.currentchrome/account-menu.tsx:155
<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.menuItemschrome/account-menu.tsx:184
<a id="property-popoverclassname"></a> popoverClassName?string-OcAccountMenuProps.popoverClassNamechrome/account-menu.tsx:225
<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.primaryNavLinkschrome/account-menu.tsx:194
<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.secondaryNavLinkschrome/account-menu.tsx:201
<a id="property-session"></a> sessionOcAccountMenuSessionThe session to render. When using <OcAccountMenuView> directly (rather than the connected <OcAccountMenu>), pass an adapter over your local auth context.-chrome/account-menu.tsx:622
<a id="property-showfamilydashboard"></a> showFamilyDashboard?booleanWhen 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.showFamilyDashboardchrome/account-menu.tsx:207
<a id="property-signinlabel"></a> signInLabel?stringLabel for the anonymous "sign in" affordance. Default 'sign in'.OcAccountMenuProps.signInLabelchrome/account-menu.tsx:164
<a id="property-signinurl"></a> signInUrl?stringWhere 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.signInUrlchrome/account-menu.tsx:162
<a id="property-signoutredirect"></a> signOutRedirect?stringWhere 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.signOutRedirectchrome/account-menu.tsx:177
<a id="property-sitestate"></a> siteState?SiteStateOptional lifecycle chip rendered inside the BuildFooter line (between site and version). Mirrors the chip on the logo so both surfaces agree.OcAccountMenuProps.siteStatechrome/account-menu.tsx:221
<a id="property-triggerclassname"></a> triggerClassName?string-OcAccountMenuProps.triggerClassNamechrome/account-menu.tsx:224