Skip to content

Commit

Permalink
Merge pull request #3610 from grommet/heading-guidance
Browse files Browse the repository at this point in the history
Remove contradictory heading guidance for card titles
  • Loading branch information
taysea authored Dec 7, 2023
2 parents 08c2f8b + ca8fcba commit 23d906e
Show file tree
Hide file tree
Showing 2 changed files with 178 additions and 178 deletions.
4 changes: 2 additions & 2 deletions aries-site/src/pages/foundation/typography.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,8 @@ If heading levels are not implemented in the correct hierarchy, users of screen
- Never skip heading levels. For example, a heading with `level={3}` must always following a heading with `level={2}` but can never immediately proceed a heading with `level={1}`.
- Do not use semantically incorrect headings to achieve a desired style. Instead, apply the semantically correct heading and let the size of the heading be determined by the theme.
- It is rare that you should need to use a Heading level greater than 3, as this indicates the information on that page may be very dense. Before implementing heading levels 4-6, consider if there is a more concise way to present the page information or to separate it into more sections
- Do not use Heading for Card titles since a Card does not define a page section. Instead, use [Text](#text) with a bold treatment. See examples of how to properly implement this in our [Card examples](/components/card).
- Treat Layers as if they were their own page with the exceptions that the first heading in a Layer would be a Heading with `level={2}`.
- For Card specific guidance, see [card titles](/components/card#card-titles) documentation.
- For Layer specific guidance, see [layer titles](/components/layer#layer-titles) documentation.

Below is an example of how Heading levels should be implemented for a page called "Page title" with 3 topics called Topic A, Topic B, and Topic C. Each topic has 2 subtopics.

Expand Down
Loading

0 comments on commit 23d906e

Please sign in to comment.