Skip to content

Add guidance for accessibility of details component #3904

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Add guidance for accessibility of details component #3904

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d346fe0
Add guidance for accessibility of details component
CharlotteDowns Jul 15, 2024
1b4fe83
Fix broken links
CharlotteDowns Jul 15, 2024
b4adcf8
Apply suggestions from code review
CharlotteDowns Aug 23, 2024
b42f182
remove additional parentheses
CharlotteDowns Aug 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/components/details/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Use the details component to make a page easier to scan when it contains informa

## When not to use this component

Do not use the details component to hide information that the majority of your users will need.
Do not use the details component to hide information that the majority of your users will need. Read our [research on this component to consider how this affects some users of assistive technologies](/components/details/#research-on-this-component)

## Decide between using details, accordions and tabs

Expand All @@ -45,4 +45,4 @@ Make the link text short and descriptive so users can quickly work out if they n

There is [evidence that some users avoid clicking the link to show more details](https://github.com/alphagov/govuk-design-system-backlog/issues/44#issuecomment-629122091), as they think it will take them away from the page.

There are [concerns that some users of voice assist software will not be able to interact with the component](https://github.com/alphagov/govuk-design-system-backlog/issues/44#issuecomment-628082040). Some software might require the user to specifically refer to the link to show more details as a button in order to interact with it.
It is known that [some users of voice assist software will not be able to interact with the component](https://github.com/alphagov/govuk-design-system-backlog/issues/44#issuecomment-628082040). Some software might require the user to specifically refer to the link to show more details as a button in order to interact with it.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not anything you changed, but I find the second sentence confusing. I've read it 3 times now and can't work out what it's trying to tell me.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@calvin-lau-sig7 are you able to help me with making this a bit clearer?