Redocly / Redocly/redoc

Accessibility: Accessibility of menu for keyboard-only user not possible

Open
#2,426 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Type: Enhancement
Dominant language
TypeScript
Stars
25.9k
Forks
2.4k
Avg merge
13h 10m
Merged PRs (30d)
4

Description

Dear Redoc Team,

We have an accessibility-related request concerning your library. Our goal is to make OpenAPI specifications more accessible to individuals with disabilities. With the current version redoc@2.1.2, we have noticed that it is possible to navigate between endpoints using tabs for forward and backward navigation. However, we are encountering difficulties when attempting to navigate using the spacebar, as it does not take us to the desired position.

We are interested in knowing if you already have plans to address this accessibility issue in a future version of your library.

Thank you in advance for your support and look forward to a positive response.

Best regards,

Saskia

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

No file, test, or entry point is identified in the report. First reproduce the keyboard-only navigation behavior in Redoc 2.1.2 and clarify the expected result of pressing Space; done should mean the menu can be navigated as intended without a mouse and the behavior is covered by a test.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
accessibility, frontend
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.