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
Swagger UI is not accessible compliant #7350
Comments
Hi @satprpa thank you for pushing the a11y agenda! May I ask a few questions?
As far as PRs go, large ones are harder to get merged than smaller ones. Smaller PRs are able to get reviewed/addressed much quicker. If there are features that aren't applicable to the project it may be feasible to build them into a plugin, so that you don't need to maintain a private fork (which can be PITA :D ). And once again, thank you for helping more people with their APIs through accessibility! |
Hello @ponelat , Thanks a lot for your response. Pls find response to your questions below. How was the report above produced?
Do you know if the JAWS/NVDA tools provide suggestions on what would fix their issues? (I'm unfamiliar with these tools, but hopefully they suggest semantic fixes that are general). Given there is one Critical issue in the above report, how can it be reproduced? It appears to work for me. Are you able to link to your fork or is it to remain private for now? Hope it clarifies your queries. Looking forward to collaberate on these issues with you soon! |
Hello @ponelat, PFA document, it contains all these issues with repro steps, expected behavior, evidence videos etc. https://drive.google.com/file/d/1jET5FqdZZ3EcqqoNj3BncWe_DqZcXNgE/view?usp=sharing Would love to have a call if you are interested. We can discuss the plan to fix all of these issues. Pls let me know. Note: Pls open the above URL by copying & pasting the link in a different tab rather than clicking on it directly |
@satprpa you did a great job mapping the issues; please give us some time to properly analyze your evidence provided in attached google doc. We're looking into it now. |
@satprpa thanks for your patience. Will update you soon on this issue, and the steps we can do going forward. |
@satprpa if you're on Twitter, could you reach out and we can organize a chat? My handle is https://twitter.com/jponelat |
Hey @ponelat I followed you on twitter. Pls follow me back with this handle https://twitter.com/spparida. Then we can start chat I believe. |
As discussed, going to start with a PR for keyboard navigation and work from there. Looking forward to the collaboration! |
- Update tabs to use <button> elements instead of <a> - Add aria roles for tablist, tabs, and tabpanel - Add aria attributes for additional a11y compliance and screen reader accessibility - Replace ids with data-name attribute for tabpanels - Add cypress test 7463 and update swos-63 - Move tabs test file to tests/a11y directory - Rename test file to be more descriptive of what is being tested. - Add id attributes to both tabs and tabpanels to leverage aria-controls and aria-labelledby attributes Co-authored-by: Calvin Gonzalez <calvin.gonzalez@oddball.io> Co-authored-by: Vladimir Gorej <vladimir.gorej@gmail.com> Closes #7463 Refs #7350
I think, in order to make the UI accessible, we first need to fix elementary errors in the HTML markup. Consider servers dropdown. <div>
<span class="servers-title">Servers</span>
<div class="servers">
<label for="servers">
<select>
<option value="https://example.com">https://example.com - Production Server</option>
</select>
</label>
</div>
</div> Why was it done this way? Most of accessibility violations will disappear once we bring the markup in compliance with the HTML specification. |
Are the above issues being dealt with or is there a reason this has gone stale? |
We use Sort Site and are getting multiple Level A accessibility violations. Should we file a new issue to get these addressed? |
Content & configuration
Is your feature request related to a problem?
Hi Team, We have taken a strong dependency on swagger-ui-dist package in one of our projects. When we went through the accessibility compliance review, we received 28 sev1/sev2 issues. We have observed similar requests earlier raised by other developers, but it's not addressed for 2+ years yet.
#5290
#5248
I just want to know why these accessibility issues are not yet addressed? is there any specific reason?
Describe the solution you'd like
Since these issues are not taking care of for so long we are afraid to raise the PR and keep waiting. Is there any plan to address these accessibility-related PRs?
Describe alternatives you've considered
Currently, we are using one private fork to address these issues by knowing we will have maintenance challenges etc.
Additional context
Issue list for reference:
<style> </style>The text was updated successfully, but these errors were encountered: