Announce moves to screen readers and make the board one tab stop

Open
#56 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
55/100
Issue type
Feature
Clarity
Clearly specified
Activity status
Active
Tech stack
javascript

Research direction

Read js/board.js:23-24 and js/board.js:99-136 for square creation and keyboard focus, then trace move handling in js/game.js:255-258 and the live region in index.html:25-27. Review css/board.css for animation rules and run npm test and npm run lint. Done when the board is one Tab stop, screen readers announce moves and check, and reduced motion is respected.

Written by the indexing model from the issue text.

Description

enhancement help wanted severity: medium

Summary

Every square is in the tab order, so a keyboard user presses Tab 64 times to get past the board. The only live region announces whose turn it is, never the move that was played or that the king is in check.

Where

  • js/board.js:23-24 (role="gridcell", tabindex="0" on every square; no role="row" parents)
  • js/board.js:99-136 (keyboard handler and focusSquare)
  • index.html:25-27 (#game-status live region), js/game.js:255-258
  • CSS has no prefers-reduced-motion rule

Proposal

  • Roving tabindex: one square has tabindex="0", the rest -1, updated in focusSquare.
  • Wrap squares in role="row" containers.
  • Announce the move in the live region, for example "White knight to f3. Check. Black's turn", built from the existing move object.
  • Give legal targets of the selected piece a non-visual marker (label suffix or aria-describedby).
  • Add a prefers-reduced-motion rule.

Who benefits

Keyboard and screen reader users. The README lists keyboard navigation and ARIA support as features.

Acceptance criteria

  • One Tab press moves focus past the board
  • A screen reader announces each move and check
  • Animations are reduced when the user asks for reduced motion

Getting started

  • Relevant files: js/board.js, js/game.js, index.html, css/board.css
  • How to run tests: npm install, then npm test and npm run lint
  • Related docs: docs/ARCHITECTURE.md, .github/CONTRIBUTING.md

Filed by repo-audit/full-audit at 8a2c86c. Severity: medium. Effort: M. audit-key: enhancement|js/board.js|createBoard.tabindex

Dominant language
JavaScript
Stars
4
Forks
2
PR merge metrics
No merged PRs in 30d

Getting set up

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.

More from TMHSDigital/Static_Chess

All issues in TMHSDigital/Static_Chess

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.