Pagehead

Pagehead denotes the title and start of a given section.

v0.34.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 :description slot to render a short description and the :actions slot for a related action.
  • Use a succinct, one-line description for the :description slot. For longer descriptions, omit the description slot and render a paragraph below the Subhead.
  • 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

NameTypeDefaultDescription
spacious
Boolean

false

Whether to add spacing to the Subhead.

hide_border
Boolean

false

Whether to hide the border under the heading.

system_arguments
Hash

N/A

Examples

Slots

heading

The heading

NameTypeDefaultDescription
tag
Symbol

N/A

One of :div, :h1, :h2, :h3, :h4, :h5, or :h6.

danger
Boolean

N/A

Whether to style the heading as dangerous.

system_arguments
Hash

N/A

actions

Actions

NameTypeDefaultDescription
system_arguments
Hash

N/A

description

The description

NameTypeDefaultDescription
system_arguments
Hash

N/A