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

Update Accessibility Documentation on content structure (landmarks) #2440

Closed
dnikub opened this issue Jul 19, 2023 · 1 comment · Fixed by #2996
Closed

Update Accessibility Documentation on content structure (landmarks) #2440

dnikub opened this issue Jul 19, 2023 · 1 comment · Fixed by #2996

Comments

@dnikub
Copy link

dnikub commented Jul 19, 2023

Hello,

I noticed that inside your accessibility documentation in the section Content Structure, you have a tip for landmarks that's not up-to-date. The quote I am referring to is this:

Tip: It is recommended to use landmark HTML elements with redundant landmark role attributes in order to maximize compatibility with legacy browsers that don't support HTML5 semantic elements.

I believe this tip can be removed from the Vue 3 docs due to multiple reasons:

  • The only legacy browser referenced here is IE, which is not supported anymore since June 2022.

  • Vue 3 does not support IE, as it uses ES2015 features that cannot be polyfilled in legacy browsers (as you write yourself in your FAQs).

  • Sticking to the semantic HTML element and avoiding adding a redundant ARIA landmark role is recommended. The official W3C recommendation for ARIA in HTML in 2023 is:

    Avoid specifying redundant roles. In practice this particular instance of redundancy will likely not have unforeseen side effects, other than unnecessarily making the markup more verbose, and incorrectly signalling to other authors that this practice is useful.

I recommend replacing the current tip with the just-named information. The table of examples for landmark roles you give within your docs implies using the redundant ARIA roles is what one should do.

Thanks!

@dnikub dnikub changed the title Update Accessibility Documentation on Update Accessibility Documentation on content structure (landmarks) Jul 19, 2023
@ranjbarreza
Copy link
Contributor

ranjbarreza commented Sep 5, 2024

Hi @dnikub
I made this PR: #2996 (@bencodezen)
Could you take a look please?

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 a pull request may close this issue.

2 participants