Redocly / Redocly/redoc

Tracking: Web interface isn't accessibility friendly

Open
#1,279 11 comments 8 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

I'm looking at ReDoc v2 (nice job by the way) but I'm running into problems where the interface isn't very accessible. Looking at the "Accessibility" tab in Firefox, it's mostly div and span tags with onClick events attached that are tripping me up. In order to be useful to more people (and for us to potentially adopt this at work), it would be great to review these and see if some of them could be implemented with some alternative markup or made focusable with tabindex.

Work items
  • #1280 Make Response status accordions clickable
  • #1281 Enable "Copy", "Expand All" and "Collapse All" to be focusable
  • #1282 Make request content type dropdowns accessible
  • #1283 UI review/update on method/path dropdown
  • #1330 Cannot access response schema details
  • #1331 Response samples can't be selected
  • #1332 Make API endpoint selectable/focusable
  • #1341 Make callbacks expandable
  • #1342 Right hand bar body samples can't be expanded/collapsed
  • #1410 All non-text content has a text alternative (WCAG 1.1.1)
  • #2405
  • #2406
  • #2407
  • #2408
  • #2402

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

This tracking issue is organized around the linked accessibility work items, with several completed and several still unchecked. Start by reviewing the remaining WCAG 1.1.1 item and the blank work items, then consider the tracking work complete when each remaining accessibility concern has a defined and completed item.

Written by the indexing model from the issue text.

Assessment

Tech stack
react, typescript
Domain
accessibility, frontend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.