A checkbox should be named by everything drawn beside it
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 42/100
- Issue type
- Refactor
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- javascript
- Domain
- accessibility, frontend
Research direction
Start at nameOf and the NAMED list in features/tasks/index.js and read how the checkbox's aria-label is assembled today. Then look at the patterns the issue points to: sectionsDone in the sections feature, and how fields builds aria-labelledby for its date and choice groups; also find where qa assembles choice and progress names. Before editing, work out how ids are generated so they stay unique across a deck's slides and the asides' parses, since those share line numbers. Done looks like each box naming itself via aria-labelledby spans, with NAMED, nameOf and tasks' requires: ['date'] gone and existing reader/qa tests updated.
Written by the indexing model from the issue text.
Description
A checkbox or a choice is named, for a screen reader, by the words beside it. tasks puts that name together itself (nameOf in features/tasks/index.js), from the line's text and from a list of other features' tokens it knows about (NAMED). Anything else drawn beside the box is read as typed or left out, so the name and the page disagree.
- [ ] :tada: Party
- ( ) Sat :sunny:
- [ ] [link](#x){blue} after
- [ ] [@ blank]{red} Call
- Open it in reader with a screen reader, or look at each box's
aria-label.
Today: the boxes are named "🎉 Party", "Sat ☀️", "link{blue} after" and "blank{red} Call", while the page shows 🎉 and ☀️, and no braces, which style the link and the blank (#303). A feature tasks doesn't list, including one an author adds for themselves, is read the same way, and the only fix is a change to tasks naming it. Before #275, a date beside a box was dropped from its name the same way.
Instead: a box's name is what's drawn beside it, whatever drew it: an emoji as its character, a date as its words, a link as its text, and anything a feature reader doesn't know about as what it shows.
Suggested fix
Let the browser work out the name: wrap the item's own words in a span with an id, and point the box at it with aria-labelledby, as a heading's Done button already does (sectionsDone) and as fields does for its date and choice groups. Unlike a <label>, it doesn't pass clicks on a link among the words to the box.
- Ids have to be unique on the page, including a deck's slides and the asides' own parses, which share line numbers.
- A staged box ("Stage the kickoff: 1 of 3") and a Done button ("Done: Plan") add words to the name: a span of their own in the
aria-labelledbylist, oraria-describedby. - qa's choices and progress put names together the same way, and would follow.
NAMED,nameOfand tasks'requires: ['date'](from #275) go, so the order of features no longer matters for names (#296).
- Dominant language
- JavaScript
- Stars
- 0
- Forks
- 1
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 26
Getting set up
- Ships a Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from jzheaux/reader
-
polish
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
Maintainers usually reply within 1 day
-
accessibility bug good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Maintainers usually reply within 1 day
-
enhancement
Difficulty 3/5 1-2 days Newbie friendliness 55/100
Maintainers usually reply within 1 day
-
enhancement
Difficulty 4/5 3-5 days Newbie friendliness 35/100
Maintainers usually reply within 1 day
-
polish
Difficulty 3/5 1-2 days Newbie friendliness 64/100
Maintainers usually reply within 1 day
Similar issues
-
Radix number block generates NaN after switching a negative or decimal number to binary, octal or hexPossibly taken @matthewalberto claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 64/100
mit-cml/appinventor-sources#4246 · 1 comment ·
Maintainers usually reply within 1 day
-
marketing
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
accessibility good first issue languages
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 77/100
Maintainers usually reply within 2 days
-
bug help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 78/100