Component API

<page-header>

Open live example

Page title block for the top of a dashboard view: an optional breadcrumb
trail, the page heading with a right-aligned cluster of page-level actions
beside it, and an optional description of what the page is for underneath.
The actions sit in the title row rather than beside the whole block, so a
longer or wrapping description never moves them. It only lays these out —
the breadcrumb links and action buttons are entirely the consumer's, so it
stays framework- and router-agnostic.

Install

import "@f-ewald/components/page-header.js";

Usage

<page-header heading="Team members" description="Everyone with access to this workspace.">
  <nav slot="breadcrumb" aria-label="Breadcrumb">Home / Settings / Members</nav>
  <ui-button slot="actions" variant="primary">Invite</ui-button>
</page-header>

Attributes / properties

PropertyAttributeTypeDefaultDescription
headingheadingstring""The page heading text.
descriptiondescriptionstring""Optional supporting line under the heading, explaining what the page does.

Events

None.

Slots

None.

CSS custom properties

Custom property
--ui-font
--ui-font-size
--ui-font-size-lg
--ui-font-size-sm
--ui-font-weight-regular
--ui-font-weight-semibold
--ui-line-height-normal
--ui-line-height-tight
--ui-text
--ui-text-muted