swagger-api / swagger-api/swagger-ui

Accessibility : Need alternative text for images.

Open
#5,800 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

cat: a11y
Dominant language
JavaScript
Stars
29k
Forks
9.3k
Avg merge
2d 23h
Merged PRs (30d)
25

Description

Q&A (please complete the following information)
OS: Linux
Browser: Chrome
Swagger-UI version: 3.0.7

Content & configuration
This violation is referring to the SVGs used for the unlocked and locked symbols used before and after a user has entered authorization details into the authorization dialog.

Describe the bug you're encountering
The SVGs used throughout the page are described in their button element and without proper attributes may be misread.

Expected behavior

Add the attributes aria-hidden="true" and focusable="false" to the SVG element to ensure it is not read or in the tab order.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Search the Swagger UI frontend for the SVG elements used with the unlocked and locked authorization symbols, starting from the button markup shown in the issue. Update the relevant SVG elements so they are hidden from assistive technology and removed from the tab order, then verify the authorization dialog and surrounding page remain accessible.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
accessibility, frontend
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.