Skip to content

Comprehensive documentation by Role #582

Description

@dhardy

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?

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions