Layout & Display
Semantic page/section heading with an optional icon, subtitle, and tooltip.
6 props across 3 groups
| Prop | Type | Default | Description |
|---|---|---|---|
title | ReactNode | "Title" | Heading text/content. |
icon | ReactNode | — | Icon rendered beside the title. |
subtitle | ReactNode | — | Secondary text rendered below the title. |
title
ReactNode
Default: "Title"
Heading text/content.
icon
ReactNode
Default: —
Icon rendered beside the title.
subtitle
ReactNode
Default: —
Secondary text rendered below the title.
| Prop | Type | Default | Description |
|---|---|---|---|
color | "default" | "primary" | "secondary" | "info" | "success" | "warning" | "danger" | "black" | "white" | string | — | Text color; inherits currentColor when unset. |
colorDepth | number | 500 | Shade depth for the selected color. |
iconPosition | "start" | "end" | start | Icon placement relative to the title. |
color
"default" | "primary" | "secondary" | "info" | "success" | "warning" | "danger" | "black" | "white" | string
Default: —
Text color; inherits currentColor when unset.
colorDepth
number
Default: 500
Shade depth for the selected color.
iconPosition
"start" | "end"
Default: start
Icon placement relative to the title.
| Prop | Type | Default | Description |
|---|---|---|---|
as | "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "h4" | Semantic heading element rendered. |
tooltip | ReactNode | boolean | (Omit<TooltipProps, "children"|"content"> & { content?: ReactNode }) | — | Wraps the title in a Tooltip. A plain value is shorthand content; bare true derives content from title; an object accepts any Tooltip prop plus an optional content override. |
as
"h1" | "h2" | "h3" | "h4" | "h5" | "h6"
Default: "h4"
Semantic heading element rendered.
tooltip
ReactNode | boolean | (Omit<TooltipProps, "children"|"content"> & { content?: ReactNode })
Default: —
Wraps the title in a Tooltip. A plain value is shorthand content; bare true derives content from title; an object accepts any Tooltip prop plus an optional content override.
| Prop | Type | Default | Description |
|---|---|---|---|
onKeyDown | (e: KeyboardEvent<HTMLDivElement>) => void | — | Keydown handler on the root element. |
onKeyDown
(e: KeyboardEvent<HTMLDivElement>) => void
Default: —
Keydown handler on the root element.
| Prop | Type | Default | Description |
|---|---|---|---|
className | string | — | Class applied to the root element. |
classNames | Partial<Record<PageTitleSlot, string>> | — | Per-slot class overrides (base/title/icon/subtitle). |
style | CSSProperties | — | Inline styles for the root element. |
className
string
Default: —
Class applied to the root element.
classNames
Partial<Record<PageTitleSlot, string>>
Default: —
Per-slot class overrides (base/title/icon/subtitle).
style
CSSProperties
Default: —
Inline styles for the root element.