Skip to main content

SectionHeader

Layout

A consistent page/section heading row with optional actions.

import { SectionHeader } from "@elabs-ai/components-ui";
Install
npm install @elabs-ai/components-tokens @elabs-ai/components-ui

Skipping the @source line is the most common first failure: Tailwind does not scan node_modules, so every component renders unstyled. The one-time wiring

Prompt for your coding agent

Paste it into Claude Code, Cursor, Codex or any other coding agent. Text in [brackets] is yours to fill in.

Add the brand-ui SectionHeader component (from @elabs-ai/components-ui) to this project.

1. Read https://elabs-ai.com/llms.txt first: it maps every package and the rules. If you can use MCP servers, connect https://elabs-ai.com/mcp and use its search, docs and tokens tools. If not, run the same lookups in the terminal: `npx -y @elabs-ai/components-cli search "<what you need>"` and `npx -y @elabs-ai/components-cli docs <Component>`.
2. Look SectionHeader up before writing code: `npx -y @elabs-ai/components-cli docs SectionHeader` prints its real props, variants, what it pairs with and what to avoid.
3. If @elabs-ai/components-ui is not installed yet: `pnpm add @elabs-ai/components-tokens @elabs-ai/components-ui` (or `npm install @elabs-ai/components-tokens @elabs-ai/components-ui`). If this is the first brand-ui package in the project, wire it once: import `@elabs-ai/components-tokens/styles.css` plus the `themes/light.css` and `themes/dark.css` stylesheets in the CSS entry, add one Tailwind `@source` line per installed @elabs-ai package (Tailwind does not scan node_modules, so without it everything renders unstyled), and wrap the app root in `ThemeProvider` from `@elabs-ai/components-tokens`.
4. Use it here: [the screen or file, and what it should show]
5. Rules: use only @elabs-ai/components-* components and the semantic tokens — no raw colours, no raw font sizes, no arbitrary Tailwind values. Look up each component's real props with the docs tool before you use it; never guess a prop.
6. Done means: the typecheck passes, `npx -y @elabs-ai/components-cli audit src --strict` reports nothing, and you have opened the app and looked at every screen you touched in the light and the dark theme.

Examples

4 live examples

Page Title

`as` picks the heading LEVEL, never the size — the title renders at `text-title` for every value. Reach for `as="h1"` when this header titles the page itself; a screen whose highest heading is an `<h2>` has no document outline root at all (WCAG 1.3.1).

Default Level Is H 2

The default is still `<h2>`, so every existing caller is untouched.

Large For Long Pages

`size="lg"` is for the sections of a LONG page — a landing page, a docs overview — that a reader scans by its headings: the title moves up to the display rung and the description keeps a readable measure. The eyebrow stays small above it, and the heading level is still `as`'s business, so the outline is unchanged.

API

SectionHeader

PropTypeDescription
titlerequiredReactNode
descriptionReactNode
actionsReactNodeRight-aligned actions (buttons, menus).
eyebrowReactNodeOptional element rendered above the title (eyebrow / breadcrumbs).
as"h1" | "h2" | "h3" | "h4" | "h5" | "h6"The heading LEVEL the title contributes to the document outline. The visual is identical for every value — pick the level the page's structure calls for, not the size you want (WCAG 1.3.1); the size is `size`. Use `as="h1"` when this header titles the PAGE (a screen whose route it names); leave it at the default when it titles a section INSIDE a page that already has an `<h1>` elsewhere. @default "h2"
size"default" | "lg"Title size: `"default"` (`text-title`) for a section inside a screen; `"lg"` (`text-display`, description at a readable measure) for the sections of a LONG page a reader scans by its headings — a landing page, a docs overview. Visual only: it never changes the heading level (`as`). @default "default"
classNamestring