Skip to content
Gaudi

Search documentation

Search every page, heading and paragraph.

On this page

Page Header

Page or section introduction: optional eyebrow, a title (h1 by default), description and actions, with optional sticky and divider modes.

Layout@gaudi/design-system/layout/PageHeader

Installation

pnpm add github:g-udi/design-system

Import from @gaudi/design-system. Load @gaudi/design-system/global.css once and add transpilePackages: ['@gaudi/design-system'] in Next.js.

import PageHeader from '@gaudi/design-system/layout/PageHeader';

Usage

import PageHeader from '@gaudi/design-system/layout/PageHeader';
<PageHeader eyebrow='Archive' title='Projects' description='Things I have built and maintain.' divider />

Examples

Playground

Storybook

Sticky list heading

Storybook

API

12 props

Accessibility

Renders a header element with one heading at the level you choose; keep a single h1 per page and use titleAs='h2' for section headers. Give a sticky header a titleId and point the region it labels at it with aria-labelledby. Actions keep their own accessible names.