Skip to content

Commit

Permalink
Change all instances to 'summary line'
Browse files Browse the repository at this point in the history
  • Loading branch information
calvin-lau-sig7 authored Dec 14, 2021
1 parent cb67731 commit c25a114
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions src/components/accordion/index.md.njk
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ An accordion will usually start with all sections hidden. To show a section, the

The heading button includes all of these areas:
- heading text
- summary text (if you decide to add one)
- summary line (if you decide to add one)
- call-to-action text to 'show' or 'hide'

For users of screen readers, all the text in the button will be read as a single statement (separated by commas to allow for slight pauses). There’s also some visually hidden content in the heading text to help announce the call-to-action as 'show this section' or 'hide this section'.
Expand All @@ -81,7 +81,7 @@ For users of screen readers, all the text in the button will be read as a single

#### Write clear button text

Write the heading and summary text like any other button text. Use sentence case, describe the content that will show, and keep it short.
Write the heading and summary line like any other button text. Use sentence case, describe the content that will show, and keep it short.
Users of screen readers might find it difficult to navigate the accordion if the button text is too long.

If you struggle to come up with clear button text, it might be because the way you’ve separated the content is not clear. Organise sections in a way that makes sense to users, based on their needs.
Expand Down Expand Up @@ -132,4 +132,4 @@ Adding a summary line with more than a few short words will likely make the butt

We need to better understand when service teams use summary lines and how this affects users of screen readers. [Share your findings and research with us](https://github.com/alphagov/govuk-design-system-backlog/issues/1).

However, summary text in accordions is widely used by services so we want to get feedback to inform us what to do next.
However, summary lines are widely used by services so we want to get feedback to inform us what to do next.

0 comments on commit c25a114

Please sign in to comment.