Skip to content
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.

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

Prevent hyphens being read out by screen readers #3164

Merged
merged 1 commit into from
Apr 24, 2024

Conversation

beccapearce
Copy link
Contributor

@beccapearce beccapearce commented Apr 19, 2024

What

Use the list from govuk-publishing-component to render the list of corporate information pages for worldwide organisations.

Why

The list component means we can remove the hyphens that were rendered previously. These were read out as either “dash“ or “hyphen“ before each item/link in the Corporate information list. Screen reader users found that frustrating to read through, so this should improve the experience.

Screenshots

Before After
image image

Trello card: https://trello.com/c/pVeGF0WE

@govuk-ci govuk-ci temporarily deployed to government-frontend-pr-3164 April 19, 2024 13:52 Inactive
@beccapearce beccapearce marked this pull request as ready for review April 19, 2024 14:07
@beccapearce beccapearce force-pushed the ensure-dashes-no-read-in-corporate-information branch from a051f70 to 955b1c4 Compare April 24, 2024 09:12
@govuk-ci govuk-ci temporarily deployed to government-frontend-pr-3164 April 24, 2024 09:13 Inactive
@beccapearce beccapearce force-pushed the ensure-dashes-no-read-in-corporate-information branch from 955b1c4 to eefb14e Compare April 24, 2024 09:18
@govuk-ci govuk-ci temporarily deployed to government-frontend-pr-3164 April 24, 2024 09:18 Inactive
Use the publishing components `list` to render corporate information page
links on the worldwide_organisation show page.

this component will stop the hyphens in lists from being read out by
screenreaders by replacing them with bullet points.

Also added a method to return the corporate information pages as a list
of hyperlinks (as expected by the component).
@beccapearce beccapearce force-pushed the ensure-dashes-no-read-in-corporate-information branch from eefb14e to 1298397 Compare April 24, 2024 09:49
@govuk-ci govuk-ci temporarily deployed to government-frontend-pr-3164 April 24, 2024 09:49 Inactive
@beccapearce beccapearce requested a review from hannako April 24, 2024 10:19
Copy link
Contributor

@hannako hannako left a comment

Choose a reason for hiding this comment

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

LGTM!

@beccapearce beccapearce merged commit 856ee01 into main Apr 24, 2024
15 checks passed
@beccapearce beccapearce deleted the ensure-dashes-no-read-in-corporate-information branch April 24, 2024 13:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants