@eds/heading
v4.0.10
Heading
Headings are used to summarise text content in a section or page.Prop | Required | Description | Type |
|---|---|---|---|
level | ✅ | The semantic level of the heading. @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/Heading_Elements | 1 | 2 | 3 | 4 | 5 | 6 |
as | — | ElementType<any> | |
ref | — | MutableRefObject | |
color | — | The color property sets the text color of an element. | "themePrimaryBase" | "themePrimary100" | "themePrimary200" | "themePrimary300" | "themePrimary400" | "themePrimary500" | "themePrimary600" | "themeAccentBase" | "themeAccent100" | "themeAccent200" | "themeAccent300" | "themeAccent400" | "themeAccent500" | "themeAccent600" | "neutralSubtle" | "neutralBold" | "neutralBoldInverted" | "neutralDisabled" | "positive" | "informative" | "caution" | "critical"Supports responsive prop syntax |
scrollMarginTop | — | Offset the heading from the top of the page when it is scrolled to. | string | number |
className | — | The className prop can be used to add CSS classes to the heading. | string |