Subhead

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 Primer::ButtonComponent or Link.

Arguments

Name	Default	Description
spacious	false	Boolean Whether to add spacing to the Subhead.
hide_border	false	Boolean Whether to hide the border under the heading.
system_arguments	N/A	Hash System arguments

Examples

Slots

heading

The heading

Name	Default	Description
tag	N/A	Symbol One of :div, :h1, :h2, :h3, :h4, :h5, or :h6.
danger	N/A	Boolean Whether to style the heading as dangerous.
system_arguments	N/A	Hash System arguments

actions

Actions

Name	Default	Description
system_arguments	N/A	Hash System arguments

description

The description

Name	Default	Description
system_arguments	N/A	Hash System arguments