# Page Header (Lumen Halo): prompt.md (v1.0.0)

- id: `lumen-page-header` · version 1.0.0 · block · pro (All-Access)
- category: Layout
- build: Base UI (one set of files; its dependencies follow the build)
- install (this build): `npx shadcn@latest add @beautiful-ui-pro/lumen-page-header`
- npm dependencies: none
- registry dependencies: utils, @beautiful-ui/lumen-avatar, @beautiful-ui/lumen-badge, @beautiful-ui-pro/lumen-breadcrumb, @beautiful-ui/lumen-button, @beautiful-ui-pro/lumen-dropdown-menu, @beautiful-ui/lumen-progress, @beautiful-ui/lumen-tabs, https://beautiful-ui.dev/r/lumen-foundation.json
- docs: https://beautiful-ui.dev/components/lumen-page-header
- The install command carries everything this item needs (files, CSS, tokens, npm and registry dependencies). Prefer it to copying source by hand.

The top of an app page: breadcrumbs, the title with its status, the people on it, a progress meter, actions and tabs with counts. Scrolled past, it folds into a compact sticky bar; actions that don't fit move into a More menu as the header resizes, so nothing wraps or clips.

## Build it
- Stack: React 19 (`ref` is a plain prop), TypeScript, Tailwind CSS v4 utilities, a shadcn-initialised project with the `@/*` alias.
- Packages: none beyond React.
- Files: `components/ui/lumen/blocks/page-header.tsx`.
- Registry dependencies, installed with it automatically: shadcn `utils` (cn), `lumen-avatar`, `lumen-badge`, `lumen-breadcrumb`, `lumen-button`, `lumen-dropdown-menu`, `lumen-progress`, `lumen-tabs`, `lumen-foundation`.
- Builds: one set of files for both, but its dependencies come in Base UI and Radix builds. Install the one that matches the project (see Install): a free item's bare URL installs the Base UI build of it and its dependencies.
- Exports to keep: `PageHeader`, and every exported type.
- CSS: the install merges this item's rules (the registry `css` field) into your global stylesheet, in `@layer components`, and adds the lumen foundation (tokens, keyframes, motion levels) once. Nothing to import by hand.
- Re-running `add` (or `--overwrite`) re-applies those rules: put overrides in your own CSS, never in the installed rules.
- Tokens: retheme with the `--lumen-*` custom properties (`--lumen-accent`, `--lumen-accent-text`, `--lumen-bad`, `--lumen-bad-text`, `--lumen-focus`, `--lumen-good`, `--lumen-good-text`, `--lumen-hairline`, `--lumen-ink`, `--lumen-muted-ink`, `--lumen-series-1`, `--lumen-series-2`, `--lumen-series-3`, `--lumen-series-4`, `--lumen-series-5`, `--lumen-series-6`, `--lumen-warn`, `--lumen-warn-text`); this item's CSS also reads `--lumen-font-mono`, `--lumen-font-sans`, `--lumen-radius-k`. Never add Tailwind colour classes inside the component.

```tsx
import { PageHeader } from "@/components/ui/lumen/blocks/page-header";
```

## Parts

| Part | data-slot | What it is for |
|---|---|---|
| `PageHeader` | `page-header` | The whole header. |

Style a part with `[data-slot="<slot>"]` selectors or its `className`; keep the attributes when editing.

## Sound
- Keep every `data-slot` and `data-sound` attribute: the sound layer reads them.
- Installing this item adds no audio. Nothing plays until the app mounts `GlassSoundProvider` once (install: `npx shadcn@latest add https://beautiful-ui.dev/r/glass-sound.json`, import from `@/components/beautiful-ui/glass-sound`); `GlassSoundToggle` is its mute control. Without a provider the audio engine never loads.

## Match the original
- Read `components/ui/lumen/blocks/page-header.tsx` as the reference implementation before changing or recreating anything, and match it: sizes, colours per theme, motion timings, copy and behaviour.
- If you deviate (a prop you can't honour, a style you changed, a dependency you swapped), say so in your reply, part by part.
- Keep the accessibility contract, the keyboard map and the motion levels listed below.

## Use it when
- page header, app header, project header, breadcrumbs with actions, sticky header that collapses, overflow menu, page tabs, Lumen
- The top of a record or project page in an app
- Pages with more actions than room on phones

### Not when
- Marketing site headers: use a site header
- App-wide navigation: use Sidebar

## Mistakes
- Mark one action primary so it never moves into More
- Keep the title short; it ellipsizes before the actions give way

## Usage

```tsx
import { PageHeader } from "@/components/ui/lumen/blocks/page-header";

<PageHeader
  crumbs={[{ label: "Projects", href: "/projects" }, { label: "Spring launch" }]}
  title="Spring launch"
  status={{ label: "On track", tone: "success" }}
  actions={[{ id: "share", label: "Share" }, { id: "export", label: "Export" }, { id: "new", label: "New task", primary: true }]}
  tabs={[{ value: "overview", label: "Overview" }, { value: "tasks", label: "Tasks", count: 24 }]}
/>
```

## Props

| Prop | Type | Default | What it does |
|---|---|---|---|
| `crumbs / title / status / description` | `{ label, href? }[] / ReactNode / { label, tone? } / ReactNode` |  | What the page is and where it sits. |
| `people / progress` | `{ name, initials?, avatarUrl? }[] / { value, max?, label }` |  | Who's on it (four faces, then +N) and how far along it is. |
| `actions` | `{ id, label, onSelect?, primary?, destructive? }[]` |  | The primary action is always shown; the rest show while they fit and move into More when they don't. |
| `tabs / tab / defaultTab / onTabChange` | `{ value, label, count? }[] / string` |  | Page tabs with counts. |
| `sticky` | `boolean` | `true` | Fold into a compact bar when scrolled past. |

Full docs: https://beautiful-ui.dev/components/lumen-page-header

## Customising
- Colours: set the `--lumen-*` tokens on `:root`, or on a container with the `lumen-scope` class to retheme one area. Add the `lumen-inherit` class to follow your shadcn palette instead (`--chart-N`, `--destructive`).
- Dark mode follows the `.dark` class on an ancestor (the shadcn and next-themes convention).
- Update later by re-running the install with `--overwrite` (review the diff if you edited it). Changelog: https://beautiful-ui.dev/r/changelog.json

## Keyboard

| Keys | Action |
|---|---|
| Tab | Crumbs, actions, More, tabs |
| ← / → | Between tabs |

## Motion inventory

| Interaction | What moves |
|---|---|
| Scroll | The header folds: crumbs and details step away, the title shrinks, the bar frosts |

## Accessibility contract (preserve when editing)
- One h1; breadcrumbs are a labelled nav with the current page marked
- The More button says how many actions it holds
- The people group names everyone, including those behind +N
- Progress is a meter with its words beside it

## Install

```bash
npx shadcn@latest add @beautiful-ui-pro/lumen-page-header
```

Pro item: needs the `@beautiful-ui-pro` registry in `components.json` and `BEAUTIFUL_UI_TOKEN` in `.env.local` (https://beautiful-ui.dev/account). Setup: https://beautiful-ui.dev/docs/pro. Your components.json `style` picks the build: radix-*, new-york and default get Radix, base-* gets Base UI.

## Credits
- Built on shadcn/ui (https://ui.shadcn.com)

The lumen foundation (the tokens listed above, keyframes and motion levels) installs once with the first component; its CSS is public at https://beautiful-ui.dev/r/lumen-foundation.json.