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

Improve localization and accessibility #8901

Open
danielchalmers opened this issue May 7, 2024 · 16 comments
Open

Improve localization and accessibility #8901

danielchalmers opened this issue May 7, 2024 · 16 comments
Labels
accessibility enhancement New feature or request epic help wanted Issue that can be implemented by the community localization

Comments

@danielchalmers
Copy link
Contributor

danielchalmers commented May 7, 2024

Is your feature request related to a problem?

MudBlazor was ranked low for accessibility but has improved. It impacts the usability and SEO of consumers (which means we need your help as we can't do it alone).

Describe the solution you'd like

Accessibility information for web authors.

Accessibility includes things like aria and role attributes and extends past keyboard navigation and semantic HTML.

At a minimum we need localized aria-labels (How?) for relevant parts of a component that aren't labeled themselves such as icon buttons. It's important to not overdo it and add labels to elements that don't need them as too many labels will makes accessibility worse ("No ARIA is better than bad ARIA.").

Have you seen this feature anywhere else?

❗ Search aria-label on the MUI button page and it will return 246 results.
(Though this particular issue is for the fundamental components, not the docs)

Describe alternatives you've considered

Hardcoding labels in English. English is a good default but it's crucial to keep it open for localization.


🙏 If you want to help, please inspect a component you use often or check the accessibility and localization labels to find more issues related to this effort. Leave a comment if you have other accessibility tips or concerns!

@danielchalmers danielchalmers added the enhancement New feature or request label May 7, 2024
@danielchalmers danielchalmers changed the title Accessibility: Add aria-label properties to all components Accessibility: Add aria-label properties to all components May 7, 2024
@danielchalmers
Copy link
Contributor Author

danielchalmers commented May 7, 2024

@henon henon added the epic label May 7, 2024
@ScarletKuro ScarletKuro added the help wanted Issue that can be implemented by the community label May 7, 2024
@ScarletKuro
Copy link
Member

Community help to address this is wanted.

@ScarletKuro
Copy link
Member

Should I pin this?

@ScarletKuro ScarletKuro pinned this issue May 7, 2024
@ScarletKuro
Copy link
Member

I unpinned the nullable one and pinned this instead as it's more important.

@danielchalmers
Copy link
Contributor Author

danielchalmers commented May 8, 2024

Don't forget roles, for example:

It's used in a few places but sparingly.

@danielchalmers danielchalmers changed the title Accessibility: Add aria-label properties to all components Accessibility: Add ARIA properties to all components May 8, 2024
danielchalmers added a commit to danielchalmers/MudBlazor that referenced this issue May 14, 2024
MudBlazor#8901

Alert:
- Using aria-live="assertive" so screen readers immediately announce the alert's content to users
- Add way of specifying the ARIA label for the close icon, with a default English one provided
- Change from a Toggle to a regular button to show intent

Buttons:
- Add MudBaseButton.AriaLabel and hooked it up
- Add ToggleIconButton.AriaLabel, ToggleIconButton.ToggledAriaLabel

Chip:
- Add role="button" to indicate the chip is interactive
- Add CloseIconAriaLabel - Closes MudBlazor#6278
- Add role="group" to ChipSet
@danielchalmers danielchalmers changed the title Accessibility: Add ARIA properties to all components Improve localization and accessibility on all components May 15, 2024
@danielchalmers danielchalmers changed the title Improve localization and accessibility on all components Improve localization and accessibility May 15, 2024
danielchalmers added a commit to danielchalmers/MudBlazor that referenced this issue May 20, 2024
…labels

Part of MudBlazor#8901. They still need to be checked for keyboard navigation and other accessibility opportunities.
@zachrybaker

This comment was marked as off-topic.

@ScarletKuro

This comment was marked as off-topic.

@henon

This comment was marked as off-topic.

@zachrybaker

This comment was marked as off-topic.

@zachrybaker

This comment was marked as off-topic.

@henon

This comment was marked as off-topic.

@tanichols

This comment was marked as off-topic.

@zachrybaker

This comment was marked as off-topic.

@zachrybaker
Copy link

From Mozilla's Accessibility guide:

Note: There is a saying "No ARIA is better than bad ARIA." In [WebAim's survey of over one million home pages (https://webaim.org/projects/million/#aria), they found that Home pages with ARIA present averaged 41% more detected errors than those without ARIA. While ARIA is designed to make web pages more accessible, if used incorrectly, it can do more harm than good.

Maybe it would be helpful to be able to disable aria properties globally until closer to compliant.

@igotinfected
Copy link
Member

@zachrybaker FWIW there's a few people (me included) working on the subject (on top of full time jobs) because we too have projects that require certain accessibility compliance. As you can tell by the recent PRs, the listing at the very top, as well as other accessibility/localization issues opened by contributors to the project, it's an actively worked on subject:

image

If you have any specific issues that don't fit the existing open issues feel free to create new ones! Maybe you'll even have the occasional spur of free time that could be spent fixing one of the issues or improving upon existing features. Everyone benefits 😄

Maybe it would be helpful to be able to disable aria properties globally until closer to compliant

None of us are experts in accessibility -- if you spot any such occurrences feel free to report or correct them. Recent PRs have mostly been based on MDN and WAI, and use tools such axe devtools, siteimprove, and WAVE to find issues and validate fixes/improvements.

@zachrybaker
Copy link

@igotinfected, My devs will be compiling a list of things they've done to work around the ADA issues. When I get that I'll back that out to a list of issues that are not being tracked.

TBH I wonder if developer expert-level in accessibility even exists! The fact that all the tools don't come to the same results, and the fact that there's so many standards thrown out there by the government...it does feel like a cat-and-mouse game. But one with legal ramifications...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accessibility enhancement New feature or request epic help wanted Issue that can be implemented by the community localization
Projects
None yet
Development

No branches or pull requests

6 participants