docs: add screen reader labels to badge examples - Githubissues

vmware-archive / clarity

Clarity is a scalable, accessible, customizable, open source design system built with web components. Works with any JavaScript framework, built for enterprises, and designed to be inclusive.

http://clarity.design

MIT License

6.43k stars 762 forks source link

docs: add screen reader labels to badge examples #6660

Closed ashleyryan closed 2 years ago

ashleyryan commented 2 years ago

Signed-off-by: Ashley Ryan asryan@vmware.com

PR Checklist

Please check if your PR fulfills the following requirements:

[ ] Tests for the changes have been added (for bug fixes / features)
[x] Docs have been added / updated (for bug fixes / features)
[ ] If applicable, have a visual design approval

PR Type

What kind of change does this PR introduce?

[ ] Bugfix
[ ] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[x] Documentation content changes
[ ] clarity.design website / infrastructure changes
[ ] Other... Please describe:

What is the current behavior?

The badge examples have no screen reader text indicating the status of the badge

Issue Number: N/A

What is the new behavior?

Add screen reader text indicating the status of the badges

Does this PR introduce a breaking change?

[ ] Yes
[x] No

Other information