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 763 forks source link

fix(a11y): wizard TOC state available for SR #6588

Closed pniv closed 2 years ago

pniv commented 2 years ago

Resolves https://github.com/vmware/clarity/issues/3976

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

What is the current behavior?

Issue Number: N/A

Clarity Wizard TOC indicates completion state only with colour. This is not accessible.

What is the new behavior?

Added support for screen readers for Error and Complete state of TOC item.

Does this PR introduce a breaking change?

Other information

vmwclabot commented 2 years ago

@pniv, you must sign every commit in this pull request acknowledging our Developer Certificate of Origin before your changes are merged. This can be done by adding Signed-off-by: John Doe <john.doe@email.org> to the last line of each Git commit message. The e-mail address used to sign must match the e-mail address of the Git author. Click here to view the Developer Certificate of Origin agreement.

netlify[bot] commented 2 years ago

✔️ Deploy Preview for zzz-angular-clarity-design-old ready!

🔨 Explore the source changes: f2166dd3d12b13abd2d647c147c5ccca594d1e52

🔍 Inspect the deploy log: https://app.netlify.com/sites/zzz-angular-clarity-design-old/deploys/61eec077ff909200085f792b

😎 Browse the preview: https://deploy-preview-6588--zzz-angular-clarity-design-old.netlify.app

hippee-lee commented 2 years ago

Hello @pniv - thank you for the contribution. It looks like the build is failing because the changes to the golden file were not formatted properly. Formatting usually happens when a change is committed with the tooling run during the pre-commit hook. I believe that this could be fixed on the branch by running npm run lint:ts:fix. Then you can do a test run on your local by running npm run build:ci. If that passes you are good to go, squash the commits into one and push that up to the branch.

If it doesn't work, let me know what causes problems and I'll try to help.

vmwclabot commented 2 years ago

@pniv, you must sign every commit in this pull request acknowledging our Developer Certificate of Origin before your changes are merged. This can be done by adding Signed-off-by: John Doe <john.doe@email.org> to the last line of each Git commit message. The e-mail address used to sign must match the e-mail address of the Git author. Click here to view the Developer Certificate of Origin agreement.

pniv commented 2 years ago

Thank you, @hippee-lee! The problem was in "golden/clr-angular.d.ts". @Jinnie helped me to fix it and add it to the pull request.

hippee-lee commented 2 years ago

Awesome. Thanks for the contribution.