AccessKit / AccessKit/accesskit

Comprehensive documentation by Role

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

Nobody has claimed this yet.

Dominant language
Rust
Stars
1.5k
Forks
114
Avg merge
8h 25m
Merged PRs (30d)
28

Description

Status quo: there are 186 Role variants, and only four of these have any documentation at all.

I've heard "accessibility is hard" before. This is especially true for those of us who know little about accessibility tooling and find little documentation. WAI-ARIA documentation is decently comprehensive, but very much oriented around web documents and not fully compatible with AccessKit.

The type of documentation I would like to see (assuming the current AccessKit API) is for each Role to document:

  • Required properties
  • Recommended properties
  • Optional properties
  • Any expectations on parent/child/sibling/ancestor/descendant nodes

As an example of the kind of question I have: can a scroll view consist of one ScrollView plus two ScrollBar nodes which are all siblings under some GenericContainer or are there other expectations on hierarchy between these? Logically, each ScrollBar should have its orientation set? The scroll_x and scroll_y properties should be set on the ScrollView or each ScrollBar or both? What other properties should be set, besides bounds on all of these and children on the ScrollView?

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

Start by reviewing the current AccessKit API and the four Role variants that already have documentation, then inventory the remaining 186 variants. Done means each Role documents required, recommended, and optional properties plus relevant node-hierarchy expectations, including resolving the ScrollView and ScrollBar example.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
accessibility, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.