Pagehead
Pagehead denotes the title and start of a given section.
On this page
v0.31.0BetaNot reviewed for accessibility
Description
Use Subhead as the start of a section. The :heading slot will render an <h2> font-sized text.
- Optionally set the
:descriptionslot to render a short description and the:actionsslot for a related action. - Use a succinct, one-line description for the
:descriptionslot. For longer descriptions, omit the description slot and render a paragraph below theSubhead. - Use the actions slot to render a related action to the right of the heading. Use Button or Link.
Accessibility
The :heading slot defaults to rendering a <div>. Update the tag to a heading element with the appropriate level to improve page navigation for assistive technologies.
Learn more about best heading practices (WAI Headings)
Arguments
| Name | Type | Default | Description |
|---|---|---|---|
spacious | Boolean |
| Whether to add spacing to the Subhead. |
hide_border | Boolean |
| Whether to hide the border under the heading. |
system_arguments | Hash | N/A |
Examples
Slots
heading
The heading
| Name | Type | Default | Description |
|---|---|---|---|
tag | Symbol | N/A | One of |
danger | Boolean | N/A | Whether to style the heading as dangerous. |
system_arguments | Hash | N/A |
actions
Actions
| Name | Type | Default | Description |
|---|---|---|---|
system_arguments | Hash | N/A |
description
The description
| Name | Type | Default | Description |
|---|---|---|---|
system_arguments | Hash | N/A |