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

19520 improve navigation experience a11y #19615

Merged
merged 3 commits into from
Jan 11, 2023

Conversation

pls78
Copy link
Member

@pls78 pls78 commented Jan 11, 2023

Context

  • We want to enhance the accessibility of our new Settings UI by allowing screen readers to notify users when they change section.

Summary

This PR can be summarized in the following changelog entry:

  • Allows screen readers to notify the user when s/he navigates to a new section in the Settings page.

Relevant technical choices:

  • The react-aria-live package has been favored over @wordpress/a11y speak because it is implemented in a way which plays nicer with our Settings UI (i.e. by using React context takes care of reading things just once when it's needed).
  • When the screen reader encounters a section containing info or warning boxes will give precedence to their content before announcing the section. This is foreseen behavior.

Test instructions

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:

  • Activate a screen reader
    • If you're on MacOS you can activate the VoiceOver screen reader by pressing (fn)+Cmd+F5
    • Tip: by pressing ctrl you can interrupt the message that is currently being spoken
  • Navigate to Yoast SEO -> Settings
  • Navigate through some sections of the Settings page and verify that, at each section change, that section is being announced with the format: section name + Settings + Yoast SEO

Relevant test scenarios

  • Changes should be tested with the browser console open
  • Changes should be tested on different posts/pages/taxonomies/custom post types/custom taxonomies
  • Changes should be tested on different editors (Block/Classic/Elementor/other)
  • Changes should be tested on different browsers
  • Changes should be tested on multisite
  • Please verify which is the suggested browser supported by your OS for what concerns accessibility (for MacOS is Safari)

Test instructions for QA when the code is in the RC

  • QA should use the same steps as above.

Impact check

This PR affects the following parts of the plugin, which may require extra testing:

  • Nothing more needs to be tested.

UI changes

  • This PR changes the UI in the plugin. I have added the 'UI change' label to this PR.

Other environments

  • This PR also affects Shopify. I have added a changelog entry starting with [shopify-seo], added test instructions for Shopify and attached the Shopify label to this PR.

Documentation

  • I have written documentation for this change.

Quality assurance

  • I have tested this code to the best of my abilities
  • I have added unit tests to verify the code works as intended
  • If any part of the code is behind a feature flag, my test instructions also cover cases where the feature flag is switched off.
  • I have written this PR in accordance with my team's definition of done.

Innovation

  • No innovation project is applicable for this PR.
  • This PR falls under an innovation project. I have attached the innovation label and noted the work hours.

Fixes #19520

@pls78 pls78 added the changelog: enhancement Needs to be included in the 'Enhancements' category in the changelog label Jan 11, 2023
@pls78 pls78 added this to the 20.0 milestone Jan 11, 2023
@pls78 pls78 marked this pull request as ready for review January 11, 2023 09:57
@pls78 pls78 linked an issue Jan 11, 2023 that may be closed by this pull request
@igorschoester igorschoester added changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog and removed changelog: enhancement Needs to be included in the 'Enhancements' category in the changelog labels Jan 11, 2023
Copy link
Member

@igorschoester igorschoester left a comment

Choose a reason for hiding this comment

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

CR && AC ✅

@igorschoester igorschoester merged commit dc29010 into release/20.0 Jan 11, 2023
@igorschoester igorschoester deleted the 19520-improve-navigation-experience-a11y branch January 11, 2023 15:56
igorschoester added a commit that referenced this pull request Apr 28, 2024
* inactive package since 5 years
* still requiring React 16.3.x
* moving over to already used WP a11y' speak
* adding a hook and wrapper component for ease of use, as per downside of original PR: #19615
igorschoester added a commit that referenced this pull request Apr 28, 2024
* inactive package since 5 years
* still requiring React 16.3.x
* moving over to already used WP a11y' speak
* adding a hook and wrapper component for ease of use, as per downside of original PR: #19615
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve navigation experience a11y
2 participants