primer/css
1
1
Fork 0
mirror of https://github.com/primer/css.git synced 2024-11-25 18:26:14 +03:00
Code Issues Projects Releases Wiki Activity

Use <h2> instead of <div> on Subhead-heading docs (#1953)

Browse Source
This commit is contained in:
Hector Garcia 2022-02-24 17:13:22 +01:00 committed by GitHub
parent e5c5312ec8
commit 3a91a29a82
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 14 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
.changeset/shaggy-coats-relate.md Normal file
View File

@ -0,0 +1,5 @@
---
"@primer/css": patch
---
Use <h2> instead of <div> on Subhead-heading docs

18
docs/content/components/subhead.md
View File

@ -8,13 +8,13 @@ bundle: subhead
---
The basic Subhead consists of a `.Subhead` container, which has a light gray bottom border. Use `.Subhead-heading` for the heading itself. It's an `<h2>` sized heading with normal font-weight.
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.
```html live title="Subhead"
<div class="Subhead">
<div class="Subhead-heading">Plain subhead</div>
<h2 class="Subhead-heading">Plain subhead</h2>
</div>
```
@ -22,7 +22,7 @@ To add a top margin to the Subhead, use `.Subhead--spacious`. This is useful for
```html live title="Spacious Subhead"
<div class="Subhead Subhead--spacious">
<div class="Subhead-heading">Spacious subhead</div>
<h2 class="Subhead-heading">Spacious subhead</h2>
</div>
```
@ -30,7 +30,7 @@ You can add a one line description to the subhead with `.Subhead-description`.
```html live title="Subhead with description"
<div class="Subhead">
<div class="Subhead-heading">Subhead with description</div>
<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>
```
@ -39,7 +39,7 @@ For longer descriptions, it is recommended that you use a paragraph below the Su
```html live title="Subhead with longer description"
<div class="Subhead">
<div class="Subhead-heading">Plain subhead</div>
<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>
@ -50,12 +50,12 @@ You can add a button or something to the right of `.Subhead-heading` with the `.
```html live title="Subhead with actions"
<div class="Subhead">
<div class="Subhead-heading">Subhead with button</div>
<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">
<div class="Subhead-heading">Subhead with link</div>
<h2 class="Subhead-heading">Subhead with link</h2>
<div class="Subhead-actions"><a href="#url">Learn more</a></div>
</div>
```
@ -64,7 +64,7 @@ Use all the elements together to create a Subhead with actions and a description
```html live title="Subhead with actions and description"
<div class="Subhead">
<div class="Subhead-heading">Subhead with actions and description</div>
<h2 class="Subhead-heading">Subhead with actions and description</h2>
<div class="Subhead-actions"><a href="#url" class="btn btn-sm btn-primary" role="button">Action</a></div>
<div class="Subhead-description">The subhead is a subdued header style with a light bottom border.</div>
</div>
@ -74,6 +74,6 @@ Use the `.Subhead-heading--danger` modifier to make the text bold and red. This
```html live title="Subhead danger"
<div class="Subhead">
<div class="Subhead-heading Subhead-heading--danger">Danger zone</div>
<h2 class="Subhead-heading Subhead-heading--danger">Danger zone</h2>
</div>
```