Skip to content

docs(sdk): sync ui@0.13.0 #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Xaxis merged 1 commit into from
May 18, 2026
Merged

docs(sdk): sync ui@0.13.0 #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/pages/sdk/ui/functions/OcAccountMenu.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ export const metadata = {
function OcAccountMenu(props: OcAccountMenuProps): any;
```

Defined in: [account-menu.tsx:456](https://github.com/orangecheck/oc-packages/blob/main/ui/src/account-menu.tsx#L456)
Defined in: [account-menu.tsx:533](https://github.com/orangecheck/oc-packages/blob/main/ui/src/account-menu.tsx#L533)

Connected variant — pulls the session from `useOcSession()`. This is
what every consumer site with `<OcSessionProvider>` mounted should
Expand Down
2 changes: 1 addition & 1 deletion src/pages/sdk/ui/functions/OcAccountMenuView.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ export const metadata = {
function OcAccountMenuView(__namedParameters: OcAccountMenuViewProps): any;
```

Defined in: [account-menu.tsx:494](https://github.com/orangecheck/oc-packages/blob/main/ui/src/account-menu.tsx#L494)
Defined in: [account-menu.tsx:571](https://github.com/orangecheck/oc-packages/blob/main/ui/src/account-menu.tsx#L571)

Presentational variant — takes a session as an explicit prop. Use
this when your site runs its own auth context (e.g. ochk.io's
Expand Down
4 changes: 2 additions & 2 deletions src/pages/sdk/ui/interfaces/OcAccountMenuViewProps.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ export const metadata = {

# Interface: OcAccountMenuViewProps

Defined in: [account-menu.tsx:479](https://github.com/orangecheck/oc-packages/blob/main/ui/src/account-menu.tsx#L479)
Defined in: [account-menu.tsx:556](https://github.com/orangecheck/oc-packages/blob/main/ui/src/account-menu.tsx#L556)

## Extends

Expand All @@ -28,7 +28,7 @@ Defined in: [account-menu.tsx:479](https://github.com/orangecheck/oc-packages/bl
| &lt;a id="property-popoverclassname">&lt;/a> `popoverClassName?` | `string` | - | [`OcAccountMenuProps`](OcAccountMenuProps.mdx).[`popoverClassName`](OcAccountMenuProps.mdx#property-popoverclassname) | [account-menu.tsx:185](https://github.com/orangecheck/oc-packages/blob/main/ui/src/account-menu.tsx#L185) |
| &lt;a id="property-primarynavlinks">&lt;/a> `primaryNavLinks?` | readonly [`OcAccountMenuItem`](OcAccountMenuItem.mdx)[] | 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`](OcAccountMenuProps.mdx).[`primaryNavLinks`](OcAccountMenuProps.mdx#property-primarynavlinks) | [account-menu.tsx:154](https://github.com/orangecheck/oc-packages/blob/main/ui/src/account-menu.tsx#L154) |
| &lt;a id="property-secondarynavlinks">&lt;/a> `secondaryNavLinks?` | readonly [`OcAccountMenuItem`](OcAccountMenuItem.mdx)[] | 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`](OcAccountMenuProps.mdx).[`secondaryNavLinks`](OcAccountMenuProps.mdx#property-secondarynavlinks) | [account-menu.tsx:161](https://github.com/orangecheck/oc-packages/blob/main/ui/src/account-menu.tsx#L161) |
| &lt;a id="property-session">&lt;/a> `session` | [`OcAccountMenuSession`](OcAccountMenuSession.mdx) | The session to render. When using `<OcAccountMenuView>` directly (rather than the connected `<OcAccountMenu>`), pass an adapter over your local auth context. | - | [account-menu.tsx:485](https://github.com/orangecheck/oc-packages/blob/main/ui/src/account-menu.tsx#L485) |
| &lt;a id="property-session">&lt;/a> `session` | [`OcAccountMenuSession`](OcAccountMenuSession.mdx) | The session to render. When using `<OcAccountMenuView>` directly (rather than the connected `<OcAccountMenu>`), pass an adapter over your local auth context. | - | [account-menu.tsx:562](https://github.com/orangecheck/oc-packages/blob/main/ui/src/account-menu.tsx#L562) |
| &lt;a id="property-showfamilydashboard">&lt;/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`](OcAccountMenuProps.mdx).[`showFamilyDashboard`](OcAccountMenuProps.mdx#property-showfamilydashboard) | [account-menu.tsx:167](https://github.com/orangecheck/oc-packages/blob/main/ui/src/account-menu.tsx#L167) |
| &lt;a id="property-signinlabel">&lt;/a> `signInLabel?` | `string` | Label for the anonymous "sign in" affordance. Default `'sign in'`. | [`OcAccountMenuProps`](OcAccountMenuProps.mdx).[`signInLabel`](OcAccountMenuProps.mdx#property-signinlabel) | [account-menu.tsx:124](https://github.com/orangecheck/oc-packages/blob/main/ui/src/account-menu.tsx#L124) |
| &lt;a id="property-signinurl">&lt;/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`](OcAccountMenuProps.mdx).[`signInUrl`](OcAccountMenuProps.mdx#property-signinurl) | [account-menu.tsx:122](https://github.com/orangecheck/oc-packages/blob/main/ui/src/account-menu.tsx#L122) |
Expand Down