PageHeader
Navigation & Chrome

PageHeader

Displays a page title, description, statistics, status, and actions.

Component behavior

PageHeader displays a page title, summary statistics, status, and actions. Supply separate stats entries for individual values.

stats displays labeled values below the title. Values use tabular numerals. Borders separate adjacent statistics.

Props

PageHeaderProps props
PropTypeDefaultDescription
titleReactNode—The page's name.
eyebrowReactNode—Section label above the title.
ledeReactNode—Description below the title.
statsPageHeaderStat[]—Labelled figures under the title.
statusReactNode—Status content beside the actions.
actionsReactNode—Buttons at the trailing edge.
breadcrumbReactNode—Nav above the eyebrow.
tabsTabItem[]—Renders a Tabs strip under the header.
activeTabstring—Controlled tab key.
onTabChange(key: string) => void—Called with the newly selected tab key.
PageHeaderStat props
PropTypeDefaultDescription
labelReactNode—Statistic label.
valueReactNode—Statistic value.
unitReactNode—Unit displayed after the value in a smaller font.
toneToneProp—Tone color applied to the value.
hintReactNode—Secondary text below the value.
titlestring—Native tooltip text.

Examples

A console page

PageHeader with stats

With a lede and no figures

Use lede for descriptive text on pages without summary statistics.

PageHeader with a lede
ImportTSX
import { PageHeader } from "@solarius/onset";
import type { PageHeaderProps, PageHeaderStat } from "@solarius/onset";