Skip to content

docs(layout): add maxVisible and mobileMaxVisible to page-header's PageHeaderProps key list#6257

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
yinlianghui merged 1 commit into from
Aug 25, 2026
Merged

docs(layout): add maxVisible and mobileMaxVisible to page-header's PageHeaderProps key list #6257

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
13 changes: 11 additions & 2 deletions content/docs/layout/page-header.mdx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -65,8 +65,17 @@ interface PageHeaderComponentProps extends React.HTMLAttributes<HTMLDivElement>

`subtitle` is the canonical key: `@objectstack/spec/ui`'s `PageHeaderProps` — the contract
for the authored `page:header` node — declares `title / subtitle / breadcrumb / actions /
recordChrome / showStar / showCopyId / aria` and has no `description`. Both `title` and
`subtitle` interpolate `{field.path}` tokens against the surrounding record context.
recordChrome / showStar / showCopyId / maxVisible / mobileMaxVisible / aria` and has no
`description`. Both `title` and `subtitle` interpolate `{field.path}` tokens against the
surrounding record context.

`maxVisible` and `mobileMaxVisible` are the canonical node's action-overflow budget, and
they belong to that contract rather than to this component: the `page:header` renderer in
`@object-ui/components` reads them, and `@object-ui/layout`'s `PageHeader` — the component
documented above — does not. The shape describes them as "How many header actions render as
inline buttons before the rest fold into the overflow menu (renderer default 3)" and "The
`maxVisible` budget on mobile viewports (renderer default 1)";
[Slotted pages](/docs/guide/slotted-pages) shows them authored on a page.

`icon` is deliberately **not** in that list, and the distinction matters because this page
documents a React component while the spec governs an authored node. `PageHeaderProps.icon`
Expand Down