Consider including a note on the accessibility issues of wrapped text in columns
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Domain
- accessibility, cli, documentation
Research direction
Start by locating the documentation or user-facing guidance for wrapped text in columns and reviewing how CLI options are described. Use the proposed warning as the requested content, then verify that the accessibility limitation and opt-in guidance are clearly documented.
Written by the indexing model from the issue text.
Description
Since wrapped text doesn’t make sense for people using a screen reader, it might be a good idea to include a warning that it should only be used as an option, when possible. (Otherwise, you will be locking people who rely on screen readers out of using your app.)
Possible copy:
Warning: Using wrapped text in columns in command-line interfaces is inaccessible to people who rely on screen readers. Please consider making wrapped text an option that people opt into – perhaps by supplying a special flag – and ensure that your apps are usable by people of all abilities.
This is how I implemented it in my app:
More (thread): https://mastodon.ar.al/@aral/105231108540229990
- Dominant language
- JavaScript
- Stars
- 395
- Forks
- 44
- Avg merge
- 6m
- Merged PRs (30d)
- 3
Contributor guide
No contributing guide indexed for this repository
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 yargs/cliui
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
-
Difficulty 3/5 1-2 days Newbie friendliness 55/100
-
task
Difficulty 4/5 3-5 days Newbie friendliness 35/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 35/100
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
antfu-collective/icones#398 ·
-
ECmail.com Open
Difficulty 1/5 Under an hour Newbie friendliness 90/100
wesbos/burner-email-providers#554 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
radiantearth/stac-browser#1023 ·
-
HMR stops working Open
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
components-web-app/docs#92 ·