Skip to content

Components

PageHeader

Projects

Component reference

Properties

Use PageHeader

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

Example import style
page-header.tsxTSX
"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

PropValuesDefault
titlestringRequired
descriptionReactNode—
actionsReactNode—
headingIdstring—
headingLevel1 | 21
headingSize"page" | "large" | "display""large"
Native HTML propsOmit<HTMLAttributes<HTMLElement>, "title" | "children">Forwarded
View TypeScript source