0e74c3f3fa
* Add links to PVC
And break some bundles (e.g. navigation) apart
* Ignore some of the new pages
* Revert "Ignore some of the new pages"
This reverts commit 854802e7ca.
2.9 KiB
| title | path | status | status_issue | source | rails | bundle |
|---|---|---|---|---|---|---|
| Subhead | components/subhead | Stable | https://github.com/github/design-systems/issues/101 | https://github.com/primer/css/tree/main/src/subhead | https://primer.style/view-components/components/subhead | subhead |
The basic Subhead consists of a .Subhead container, which has a light gray bottom border. Use .Subhead-heading for the heading itself. It is styled as an <h2> sized heading with normal font-weight.
Use a heading element whenever possible as they can be used as navigation for assistive technologies, and avoid skipping levels.
<div class="Subhead">
<h2 class="Subhead-heading">Plain subhead</h2>
</div>
To add a top margin to the Subhead, use .Subhead--spacious. This is useful for separating sections on a settings page.
<div class="Subhead Subhead--spacious">
<h2 class="Subhead-heading">Spacious subhead</h2>
</div>
You can add a one line description to the subhead with .Subhead-description.
<div class="Subhead">
<h2 class="Subhead-heading">Subhead with description</h2>
<div class="Subhead-description">The subhead is a subdued header style with a light bottom border.</div>
</div>
For longer descriptions, it is recommended that you use a paragraph below the Subhead.
<div class="Subhead">
<h2 class="Subhead-heading">Plain subhead</h2>
</div>
<p>
This is a longer description that is sitting below the Subheader. It's much longer than a description that could sit comfortably in the Subhead. It might even have <strong>bold</strong> text. <a href="#">Click to learn more.</a>
</p>
You can add a button or something to the right of .Subhead-heading with the .Subhead-actions element.
<div class="Subhead">
<h2 class="Subhead-heading">Subhead with button</h2>
<div class="Subhead-actions"><a href="#url" class="btn btn-sm btn-primary" role="button">Action</a></div>
</div>
<div class="Subhead Subhead--spacious">
<h2 class="Subhead-heading">Subhead with link</h2>
<div class="Subhead-actions"><a href="#url">Learn more</a></div>
</div>
Use all the elements together to create a Subhead with actions and a description.
<div class="Subhead">
<h2 class="Subhead-heading">Subhead with actions and description</h2>
<div class="Subhead-description">The subhead is a subdued header style with a light bottom border.</div>
<div class="Subhead-actions"><a href="#url" class="btn btn-sm btn-primary" role="button">Action</a></div>
</div>
Use the .Subhead-heading--danger modifier to make the text bold and red. This is useful for warning users.
<div class="Subhead">
<h2 class="Subhead-heading Subhead-heading--danger">Danger zone</h2>
</div>