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

List View: Remove aria-description in favor of aria-describedby #55165

Closed
afercia opened this issue Oct 9, 2023 · 3 comments · Fixed by #55264
Closed

List View: Remove aria-description in favor of aria-describedby #55165

afercia opened this issue Oct 9, 2023 · 3 comments · Fixed by #55264
Assignees
Labels
[Feature] List View Menu item in the top toolbar to select blocks from a list of links. [Focus] Accessibility (a11y) Changes that impact accessibility and need corresponding review (e.g. markup changes). Good First Issue An issue that's suitable for someone looking to contribute for the first time [Status] In Progress Tracking issues with work in progress [Type] Bug An existing feature does not function as intended

Comments

@afercia
Copy link
Contributor

afercia commented Oct 9, 2023

Description

#49907 added the ability to render an aria-description attribute to the List View.

As pointed out in other issues and PRs, aria-description is new in ARIA 1.3, which is not a finalized recommendation yet. As such, we can't use it, yet. We should instead use the traditional method to provide an accessible description:

  • aria-describedby pointing to a hidden element containing the description.

This is not just an issue about formal compliance. It's about actual support by browsers and assistive technology.
Being a new ARIA 1.3 property, aria-description may be supported by some new browser versions and by some new assistive technology versions. However, there is no guarantee of full support. Also, we need to support old combinaitons of browsers and (more importantly) assistive technology.

That said, at the moment one of the known implementation is also buggy, so that's one more reason to not use it.
See https://twitter.com/aardrian/status/1711353551518044626

The cangelog should be updated as well.
Cc: @scruffian @andrewserong @alexstine @joedolson

Step-by-step reproduction instructions

See directly in the codebase at:

aria-description={ description }

Screenshots, screen recording, code snippet

No response

Environment info

No response

Please confirm that you have searched existing issues in the repo.

Yes

Please confirm that you have tested with all plugins deactivated except Gutenberg.

Yes

@afercia afercia added [Type] Bug An existing feature does not function as intended [Focus] Accessibility (a11y) Changes that impact accessibility and need corresponding review (e.g. markup changes). [Feature] List View Menu item in the top toolbar to select blocks from a list of links. labels Oct 9, 2023
@joedolson
Copy link
Contributor

Agreed. Support for aria-description is a long way from complete, and the specification is incomplete and could change. We need to be using well supported attributes.

@alexstine
Copy link
Contributor

This should be an easy refactor if someone wants to try it. If not, I'll take it.

@alexstine alexstine added the Good First Issue An issue that's suitable for someone looking to contribute for the first time label Oct 10, 2023
@github-actions github-actions bot added the [Status] In Progress Tracking issues with work in progress label Oct 11, 2023
@scruffian
Copy link
Contributor

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Feature] List View Menu item in the top toolbar to select blocks from a list of links. [Focus] Accessibility (a11y) Changes that impact accessibility and need corresponding review (e.g. markup changes). Good First Issue An issue that's suitable for someone looking to contribute for the first time [Status] In Progress Tracking issues with work in progress [Type] Bug An existing feature does not function as intended
Projects
Development

Successfully merging a pull request may close this issue.

4 participants