Settings
Settings section header
The title, description and actions above a block of settings. The unit every settings screen is stacked from.
Available
Ports as-is
Examples
Rendered live from the maintained Storybook story. Lantern stores only the story id and embeds Storybook rather than duplicating the component or its demo.
Settings section header
Rendered live from Storybook
Storybook must be running for this to load — bun run start:storybook from the monorepo root, or set NEXT_PUBLIC_STORYBOOK_URL to a deployed instance.
Props
The component's public API, read from its TypeScript source. Descriptions come from TSDoc on the prop, so this table cannot drift from the component.
| Prop | Type | Default | Description |
|---|---|---|---|
title* | React.ReactNode | — | Section name — "Access", "Manage", "Notifications". |
description | React.ReactNode | — | One-line explanation of what the pane below configures. |
icon | React.ReactNode | <UilSlidersVAlt size="16" className="text-foreground" /> | Leading 16px glyph. Defaults to the generic settings sliders icon; panes pass their own (`UilLock` for Access, `Bell` for Notifications, …). Pass `null` to render the title with no glyph. |
actions | React.ReactNode | — | Optional right-aligned slot (a "Learn more" link, a status pill). |
className | string | — | Undocumented — add TSDoc to the prop in the library. |
Reference
Transcribed from the component audit. If this disagrees with the source, the source is right.
- Source
src/components/settings/SettingsSectionHeader.tsx- Portability
- Copies across unchanged — only the utils import path moves.
- States to cover
title onlywith descriptionwith iconwith actions