Page Header

The PageHeader component presents page titles, metadata, actions, and supporting content in a consistent header.

Usage & Examples

Settings Header

Workspace

Billing settings

Manage seats, invoices, and payment methods.

settings-header.tsx
<PageHeader
  eyebrow="Workspace"
  title="Billing settings"
  subtitle="Manage seats, invoices, and payment methods."
  actions={<Button size="small">Add seat</Button>}
/>

Props API

30 props
Columns
Page Header props API
Default
Description
actionsReactNodeNopropsPrimary action area rendered at the end of the header.
actionsClassNamestringNopropsAdditional class name for the actions area.
as"div" | "header" | "section"Noprops"header"Semantic element used for the root.
beforeReactNodeNopropsOptional content rendered before the title block.
childrenReactNodeNopropsAdditional header content.
classNamestringNostylingAdditional class name for the root.
compactbooleanNopropsfalseWhether title/actions should stack more tightly.
contentClassNamestringNopropsAdditional class name for the content area.
data-testidstringNotestingBackward-compatible alias for test ID attributes.
disabledbooleanNopropsfalseWhether the header is visually disabled.
eyebrowReactNodeNopropsSmall text rendered above the title.
footerReactNodeNopropsOptional content rendered after the main row.