# PageHeader

The main page heading with optional supporting text and page actions.

Connect Flood once using [the installation guide](https://flood.md/docs/installation). Then import the components you use; no per-component add command is needed.

## Example

```tsx
"use client";

import { FloodRoot, PageHeader, Button } from "@flood-md/react";
import "@flood-md/react/styles.css";

export function Example() {
  return (
    <FloodRoot>
      <PageHeader title="Projects" actions={<Button>New project</Button>} />
    </FloodRoot>
  );
}
```

## Design notes

- Use inside main for the page's h1. An embedded preview can choose headingLevel={2}. Use Section for titled content within the page.
- Add a description only when it supplies context the title cannot. Keep filters in the collection toolbar.
- Actions wrap below the title when the header's own container narrows. The heading stays first in reading and keyboard order.

## API reference

| Prop | Values | Default |
| --- | --- | --- |
| `title` | `string` | `Required` |
| `description` | `ReactNode` | `—` |
| `actions` | `ReactNode` | `—` |
| `headingId` | `string` | `—` |
| `headingLevel` | `1 \| 2` | `1` |
| `headingSize` | `"page" \| "large" \| "display"` | `"large"` |
| `Native HTML props` | `Omit<HTMLAttributes<HTMLElement>, "title" \| "children">` | `Forwarded` |