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

fix: add aria label to select element for content types #7133

Merged
merged 12 commits into from
Mar 31, 2021

Conversation

gileswells
Copy link
Contributor

The goal here is to add aria-labels to the dropdowns to provide people using assistive tech like screen readers with more information about the page / part of the page they're interacting with.

Description

We added an ariaLabel prop to the ContentType component and then updated instances where <ContentType /> is used to include the new prop.

Motivation and Context

At the VA we have always have a focus on accessibility and SwaggerUI has been on our radar as something we use that could receive some accessibility love. There isn't any specific issue to link on this repo but there have been past accessibility issues that we hope overlap.

How Has This Been Tested?

We've tested this using VoiceOver on Mac and JAWS for Windows. With there being no visual changes for this we didn't see any regressions elsewhere in the project.

Checklist

My PR contains...

  • No code changes (src/ is unmodified: changes to documentation, CI, metadata, etc.)
  • Dependency changes (any modification to dependencies in package.json)
  • Bug fixes (non-breaking change which fixes an issue)
  • Improvements (misc. changes to existing features)
  • Features (non-breaking change which adds functionality)

My changes...

  • are breaking changes to a public API (config options, System API, major UI change, etc).
  • are breaking changes to a private API (Redux, component props, utility functions, etc.).
  • are breaking changes to a developer API (npm script behavior changes, new dev system dependencies, etc).
  • are not breaking changes.

Documentation

  • My changes do not require a change to the project documentation.
  • My changes require a change to the project documentation.
  • If yes to above: I have updated the documentation accordingly.

Automated tests

  • My changes can not or do not need to be tested.
  • My changes can and should be tested by unit and/or integration tests.
  • If yes to above: I have added tests to cover my changes.
  • If yes to above: I have taken care to cover edge cases in my tests.
  • All new and existing tests passed.

@tim-lai
Copy link
Contributor

tim-lai commented Mar 30, 2021

@gileswells Thanks for the PR! It looks good. If you can rebase, or better yet given asynchronous timing, allow maintainers to make edits to this PR, I will be able to merge this PR.

@gileswells
Copy link
Contributor Author

@tim-lai I thought I had checked that box. I pulled master back to our fork. If there's something else you need or if there's a better way to submit a PR I'll keep an eye out here but I'm also available on the IRC channel if that's easier.

@tim-lai
Copy link
Contributor

tim-lai commented Mar 30, 2021

@gileswells Thanks. I saw your reply right after I merged a different PR. I'm still not able to update branch for this PR though. Can you rebase one more time, and I'll hold until I see this one updated.

@gileswells
Copy link
Contributor Author

@tim-lai sorry missed your comment. This is merged again for you.

@tim-lai tim-lai merged commit 4abbc62 into swagger-api:master Mar 31, 2021
@tim-lai
Copy link
Contributor

tim-lai commented Mar 31, 2021

@gileswells PR merged! Thanks again!

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 this pull request may close these issues.

None yet

4 participants