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

Make search bar and results more accessible #255

Merged
merged 5 commits into from
Oct 16, 2023

Conversation

smythp
Copy link
Collaborator

@smythp smythp commented Sep 26, 2023

Changes

Added information on how to navigate to results in the aria-label attribute on the search bar

Added a new field to English internationalization with instructions on how to navigate to search results. This field will appear via the aria-label to screen reader users.

Added an enclosing div informing screen readers to update when the search results populate.

Notes

Resolves #254

Creating this issue as a draft for testing with other devices.

Added information on how to navigate to results in the aria-label
attribute on the search bar

Added a new field to English internationalization with instructions on
how to navigate to search results. This field will appear via the
aria-label to screen reader users.

Added an enclosing div informing screen readers to update when the
search results populate.

Signed-off-by: Patrick Smyth <[email protected]>
@netlify
Copy link

netlify bot commented Sep 26, 2023

Deploy Preview for docssigstore ready!

Name Link
🔨 Latest commit 4ee2c27
🔍 Latest deploy log https://app.netlify.com/sites/docssigstore/deploys/652463d85c601500087847cf
😎 Deploy Preview https://deploy-preview-255--docssigstore.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Made label instructing how to access search results less verbose

Signed-off-by: Patrick Smyth <[email protected]>
Signed-off-by: Patrick Smyth <[email protected]>
After testing, we found it better to include the word search.

Signed-off-by: Patrick Smyth <[email protected]>
@smythp
Copy link
Collaborator Author

smythp commented Oct 9, 2023

@ltagliaferri , this PR adds an aria-live region to the search bar, meaning that search results are read out loud when a screen reader user types in the bar. In addition, a short note with information on navigating to the results has been included as a label.

You won't perceive any changes on this PR without using a screen reader like NVDA or VoiceOver.

This is ready to merge when you have a chance, thank you!

@smythp smythp marked this pull request as ready for review October 9, 2023 20:40
@ltagliaferri ltagliaferri merged commit 813f020 into sigstore:main Oct 16, 2023
5 checks passed
@smythp smythp deleted the search-accessibility branch October 23, 2023 21:15
@smythp smythp restored the search-accessibility branch October 23, 2023 21:15
@smythp smythp deleted the search-accessibility branch October 23, 2023 21:15
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.

Search mechanism inaccessibility with screen reader
2 participants