-
Notifications
You must be signed in to change notification settings - Fork 566
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
[Accessibility][Storybook] Add aria-labels to the multiple item progress bar + enforce aria-label in progressbar.item #5559
base: main
Are you sure you want to change the base?
Conversation
🦋 Changeset detectedLatest commit: f02fd75 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
size-limit report 📦
|
packages/react/src/ProgressBar/ProgressBar.features.stories.tsx
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Makes sense!
- Do you think that
aria-label
should be required onProgressBar.Item
? - I see this was an Axe violation. I thought all Primer React storybook examples have Axe checks...maybe this doesn't'? do you know why this wasn't flagged?
@khiga8 I like this, good catch.
Its failing on storybook prod. 🤔 Do we not have an a CI check? |
There's some kind of CI axe checks running, but I'm not sure if it's running on this story... |
fcda31a
to
328b979
Compare
👋 Hi, this pull request contains changes to the source code that github/github depends on. If you are GitHub staff, we recommend testing these changes with github/github using the integration workflow. Thanks! |
@TylerJDev what do you think should this be minor changeset? Since the props now enforce developers add aria-labels? |
@kendallgassner, let's see how it runs in Dotcom's CI! I'll run an integration test PR for us. I feel like minor is the right call, but we'll see if it's a breaking change or not in the test PR 🤔 |
👋 Hi from github/github! Your integration PR is ready: https://github.com/github/github/pull/358710 |
🔴 golden-jobs completed with status |
3 ish changes needed for 🔴 golden-jobs to pass. I will make a PR in dotcom. |
If we are making the prop required it should be a breaking change; even if it's not breaking dotcom, it might be breaking for other users of Primer React. |
Now switching this to a 'console.warn' so I think we can move back to patch. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice! Thanks for following up and investigating if/how to require the aria-label
prop! Good call pivoting to a dev-only console warning! :)
do you think this component would benefit from more comprehensive improvements (re: role="meter"
vs role="progressbar"
) at a future time, or do you think it's at a good place now?
Yes! I think it would be beneficial to investigate splitting up this component so that when progress is not dynamically changing we use role="meter" |
ee98f8f
to
b3b2235
Compare
248d844
to
a413163
Compare
Closes https://github.com/github/accessibility-audits/issues/10134
In this PR I add an aria-label to each role='progressbar'. I also have updated the ProgressBar.item props to enforce that aria-labels are always added
Changelog
New
Changed
Removed
Rollout strategy
I am updating a storybook story.
Testing & Reviewing
Tested with a screen reader.
Merge checklist