AccessKit / AccessKit/accesskit

Feature request: accesskit_consumer API documentation

Open
#381 3 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

Hi! Very cool project, really glad this exists and eager to learn more about how to interact with the accesskit_consumer API. I'm using egui and have been exploring its integration with accesskit and am pretty impressed with the out-of-the-box experience with Voiceover in my app.

I've started poking at the source a bit, but haven't quite found the right entry point to do anything useful yet and was hoping to get pointed at a good place to start.

At a high level what I think needs to happen is something like:

  • Get a reference to a window that provides accesskit metadata
  • Implement a handler to receive accessibility tree updates from the window
  • Do something with the update

If it's welcomed, I'd be happy to document what I learn for the project so it's easier for the next person. Thank you!

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 locating the public accesskit_consumer API and the egui/accesskit integration entry points; the issue does not name specific files or tests. Document how to obtain a window reference, receive accessibility tree updates, and use those updates, with the relevant API flow clear enough for a new user to follow.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
accessibility, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.