Skip to content

Commit

Permalink
Merge pull request alphagov#3131 from alphagov/update-panel-guidance
Browse files Browse the repository at this point in the history
Extend panel guidance to advise not using long highlighted information
  • Loading branch information
owenatgov authored Sep 12, 2023
2 parents 0a6f2bf + b5e4472 commit 3987eee
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions src/components/panel/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,10 @@ There are 2 ways to use the panel component. You can use HTML or, if you are usi

{{ example({ group: "components", item: "panel", example: "default", html: true, nunjucks: true, open: false, size: "m", titleSuffix: "second" }) }}

### How to write heading text
### How to write panel text

Keep your heading text brief, as it's only meant for a high-level explanation of what has happened. For example, 'Application complete'.
Keep your panel text brief, as it's only meant for a high-level explanation of what has happened. For example, 'Application complete'.

If you can, use shorter words instead of longer ones. Shorter words are less likely to wrap around the panel, which can happen when users on mobile zoom in.
Aim to use short words and phrases to make sure highlighted information is easy to read at different screen sizes. For example, shorter amounts of information is less likely to wrap around the panel, which can happen when using the zoom function on mobiles.

If you need to give detailed information, or more context, use the description text under the heading text.

0 comments on commit 3987eee

Please sign in to comment.