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

A11y - Updated aria-labels for landmarks, added landmark for sidebar and plug skiplinks #5290

Merged
merged 8 commits into from Oct 24, 2023

Conversation

ichim-david
Copy link
Sponsor Member

This pull request addresses some of the issues mentioned in the following issue
#5268

  1. "The second option brings us to another scenario. The CMS's main page doesn't have a sidebar, which means the skip links should also be different from the 'edit' page."
    Added a pluggable section to skiplinks this way if you have other links that you want to skip to you can add extra links
    in a Plug.

  2. There is now a complementary role to the sidebar so you can easily focus on it using a screen reader with the landmark
    section

  3. Updated aria-label for Footer, Navigation, Sidebar and Skip links:
    Everything is now Capitalized based on examples I've seen on other websites such as Apple.com or looking at the documentation examples of https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/complementary_role

Here is a before and after landmark reading out of a Mac

current-aria-label
modified-aria-label

@ichim-david ichim-david added the 99 tag: UX Accessibility Accessibility issues label Oct 7, 2023
@ichim-david ichim-david added this to In progress in Accessibility via automation Oct 7, 2023
@netlify
Copy link

netlify bot commented Oct 7, 2023

Deploy Preview for volto ready!

Name Link
🔨 Latest commit 5273583
🔍 Latest deploy log https://app.netlify.com/sites/volto/deploys/652d2d68e7c2b30008d87679
😎 Deploy Preview https://deploy-preview-5290--volto.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.

Copy link
Member

@sneridagh sneridagh left a comment

Choose a reason for hiding this comment

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

@Wagner3UB Could you please also take a look?

Accessibility automation moved this from In progress to Reviewer approved Oct 24, 2023
@Wagner3UB
Copy link
Contributor

I'm not familiar with the pluggable component, so I can't help with that.

However, the result of these changes efficiently solves the sidebar problem.

I have a small question: When we are on the home edit page, without the sidebar, the landmarks guide shows 'sidebar empty complementary'. This way, it kinda helps show that the sidebar is empty and "doesn't work for nothing", but it's not quite accurate because it's not that there's no content in the sidebar, we don't have the sidebar. And the fact that it's clickable but doesn't take us anywhere can be confusing.

However, I'm not sure if is something possible.

@sneridagh sneridagh merged commit 6520d8e into main Oct 24, 2023
49 checks passed
Accessibility automation moved this from Reviewer approved to Done Oct 24, 2023
@sneridagh sneridagh deleted the sidebar-a11y-3901 branch October 24, 2023 14:23
sneridagh added a commit that referenced this pull request Oct 25, 2023
* main: (38 commits)
  A11y - Updated aria-labels for landmarks, added landmark for sidebar and plug skiplinks (#5290)
  (FIX): put padding so the text is not clipped (#5305)
  Add upgrade docs for users of `@kitconcept/volto-blocks-grid` addon (#5333)
  Add new multilingual acceptance tests with Seamless mode enabled (#5332)
  Fix reference to installation (#5328)
  Fix compare translations view (#5327)
  Release 17.2.0
  Fix to return correct results when loading the search block from a URL (#5298)
  Allow multiple path criteria (#5317)
  Release 17.1.1
  Added guard in `flattenScales` in edge case image is undefined (#5318)
  Normalize the shape of the image component `item` prop if it contains the serialized object after creation to match the one in the catalog. (#5266)
  Release 17.1.0
  move the function to get the lead image sizes to the block configuration (#5289)
  Removed default aspect-ratio from Image component (#5278)
  Added support for `blocksConfig` configuration in the listing block (#5310)
  fix: logo and login storybook (#5286)
  Refactor Logo component to improve the conditional link to the root (#5280)
  Fix hierarchy of readme headings
  Clean up readme and install docs (#5287)
  ...
sneridagh pushed a commit that referenced this pull request Oct 27, 2023
sneridagh added a commit that referenced this pull request Oct 30, 2023
* main: (283 commits)
  Release 17.3.0
  Fix DatetimeWidget on FF, the button default if no type is set is sen… (#5343)
  Call applyBlockDefaults from addBlock/insertBlock, add initialValue() configuration option for blocks (#5320)
  A11y - Updated aria-labels for landmarks, added landmark for sidebar and plug skiplinks (#5290)
  (FIX): put padding so the text is not clipped (#5305)
  Add upgrade docs for users of `@kitconcept/volto-blocks-grid` addon (#5333)
  Add new multilingual acceptance tests with Seamless mode enabled (#5332)
  Fix reference to installation (#5328)
  Fix compare translations view (#5327)
  Release 17.2.0
  Fix to return correct results when loading the search block from a URL (#5298)
  Allow multiple path criteria (#5317)
  Release 17.1.1
  Added guard in `flattenScales` in edge case image is undefined (#5318)
  Normalize the shape of the image component `item` prop if it contains the serialized object after creation to match the one in the catalog. (#5266)
  Release 17.1.0
  move the function to get the lead image sizes to the block configuration (#5289)
  Removed default aspect-ratio from Image component (#5278)
  Added support for `blocksConfig` configuration in the listing block (#5310)
  fix: logo and login storybook (#5286)
  ...
sneridagh added a commit that referenced this pull request Oct 30, 2023
* main:
  Release 17.3.0
  Fix DatetimeWidget on FF, the button default if no type is set is sen… (#5343)
  Call applyBlockDefaults from addBlock/insertBlock, add initialValue() configuration option for blocks (#5320)
  A11y - Updated aria-labels for landmarks, added landmark for sidebar and plug skiplinks (#5290)
  (FIX): put padding so the text is not clipped (#5305)
  Add upgrade docs for users of `@kitconcept/volto-blocks-grid` addon (#5333)
  Add new multilingual acceptance tests with Seamless mode enabled (#5332)
  Fix reference to installation (#5328)
  Fix compare translations view (#5327)
  Release 17.2.0
  Fix to return correct results when loading the search block from a URL (#5298)
  Allow multiple path criteria (#5317)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
99 tag: UX Accessibility Accessibility issues
Projects
Accessibility
  
Done
Development

Successfully merging this pull request may close these issues.

None yet

3 participants