codex-team/editor.js

Make editor accessible馃挕

Open

#1,510 opened on Jan 23, 2021

View on GitHub
聽(4 comments)聽(8 reactions)聽(0 assignees)TypeScript聽(26,602 stars)聽(1,985 forks)batch import
good first issue

Description

Currently the editor is not accessible for screen readers because:

  1. It does not provide accessible names for interative elements.
  2. It relies on non-iteractive elements for interaction.

Proposed solution:

  1. Add accessible names to interactive elements via aria-label attribute or visually hidden text.
  2. Add role="button" attribute to all interactive elements or (better) use button tag instead of div.
  3. Add aria-hidden="true" and focusable="false" to SVG icons.

Contributor guide

Tech stack
typescript
Domain
frontend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic knowledge of ARIA attributesFamiliarity with editor.js component structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
The issue describes specific accessibility problems and solutions. The contributor should locate the editor components (likely in the 'src' directory) and add ARIA labels, roles, and aria hidden attributes to interactive elements and SVG icons. The proposed solution is clear and localized, so no additional investigation is needed beyond understanding the existing code structure.
Make editor accessible馃挕 路 codex-team/editor.js#1510 | Good First Issue