Skip to content

PageHeader

Shared Components

Reusable page header with title, description, breadcrumbs, and action slot.

BreadcrumbsDescriptionAction slot
Open preview

Responsive viewport — resize the window to explore. Direction and density apply only to this preview. Theme applies to the docs too.

Usage

Provide a page title and optional description, breadcrumbs, and action children. It stacks on small screens and places actions beside the title on larger screens.

Import
import { PageHeader } from "@dashboardpack/core/components/shared/page-header";

Available in the included @dashboardpack/core package. Copy the complete example from Source code for all imports and state. Add "use client" when using hooks or event handlers. See installation and theming for project setup.

API reference

Common props and defaults. Slot-specific props are named below; native elements also accept their standard HTML attributes. The component TypeScript definitions are the complete type reference.

PageHeader props
PropType / DefaultDescription
titlestring

Default: required

Main h1 heading.
descriptionstring

Default: —

Supporting page context.
breadcrumbs{ label: string; href?: string }[]

Default: —

Last item is the current page.
childrenReactNode

Default: —

Primary and secondary page actions.

Build with these too