smrt
Open the smrt source on GitHub Switch to dark color scheme
← All UI components

Layout

PageHeader

One header per page: an ancestors-only breadcrumb row, the page title (`<h1>`), and the page's own actions, right-aligned.

Public export

typescript
import { PageHeader } from '@happyvertical/smrt-ui/layout';
Import path
@happyvertical/smrt-ui/layout
Props
12
Props described
12 of 12
Bindable state
0
Callback events
0
Verified release
0.62.10

Props

NameTypeRequiredDescription
titlestringYesPage title
subtitlestringNoOptional subtitle/description
crumbsreadonly PageHeaderCrumb[]NoAll ancestors of this page, outermost first (never the page itself). Overrides the shell's trail; usually pass `parents` instead.
parentsreadonly PageHeaderCrumb[]NoAncestors past the shell's nav, outermost first.
shortTitlestringNoShorter title for the shell (e.g. its phone top bar); default `title`.
crumbsLabelstringNoAccessible name of the breadcrumb nav.
backHrefstringNoBack navigation URL.
backLabelstringNoBack link label
titleFieldSnippetNoAn editable title rendered inside the `<h1>` in place of `title`'s text (a labelled text field styled as the heading). `title` still names the page for the shell; keep it in sync with the field's value.
actionsSnippetNoSlot for action buttons (right-aligned beside the title)
metaSnippetNoSmall line under the title (status, dates, counts)
childrenSnippetNoSlot for additional content below the title row (e.g. page tabs)

Bindable state

This component has no bindable public state.

Callback events

This component declares no callback event props.

Examples and explanation