swagger-api / swagger-api/swagger-ui

Screen Reader is not announcing name for the close button present for available authorization dialog in windows.

Open
#10,320 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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: Windows 11 24H2
Browser: Edge, chrome
Version: 133.0.3065.82 (Official build) (64-bit)
Method of installation: dist
Swagger-UI version: 5.17.14
Swagger/OpenAPI version: 3.0

Content & configuration

Example Swagger/OpenAPI definition:

# your YAML here

Swagger-UI configuration options:

SwaggerUI({
  // your config options here
})
?yourQueryStringConfig
Describe the bug you're encountering

Screen Reader is not announcing name for the close button present for available authorization dialog in windows. The lack of a name announcement for the close button in the available authorization dialog in Windows can greatly affect users who rely on screen readers, such as those with visual impairments. This issue makes it difficult for them to identify the button's function, resulting in confusion and challenges in navigating the dialog effectively.

To reproduce...

Steps to reproduce the behavior:

  1. Turn on Narrator.
  2. Open the URL: Swagger UI v5.17.14 in latest edge browser
  3. Swagger Code pen home page will be opened.
  4. Press tab key till reach Authorization button and press enter key to activate it.
  5. Available authorizations dialog will be appeared.
  6. Press tab key till reach close(x) button.
  7. Verify whether screen reader is announcing name for close button or not.
Expected behavior

Screen Reader should announce name for the close button present for available authorization dialog in windows. It should announce it as close button.

Screenshots

https://github.com/user-attachments/assets/6178f595-6bee-4a85-b5f4-116813b38299

Image
Additional context or thoughts

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

Reproduce the issue using Windows Narrator, Edge or Chrome, and Swagger UI 5.17.14 from the linked CodePen. Inspect the available authorizations dialog and its close button; done means the screen reader announces the control as a close button when reached by keyboard.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.