Document accesskit properties and roles that don't match ARIA

Open
#749 9 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Start by reviewing the listed AccessKit properties and comparing each with its corresponding ARIA property or concept. Record the exact mismatches rather than only the names, then determine how roles and actions should be covered. Done means the AccessKit relationship with ARIA is documented for the listed properties, with roles and actions addressed or clearly scoped.

Written by the indexing model from the issue text.

Description

Accesskit types are ported for chromium's API, which don't always match ARIA properties.

I've gone through the entire property list with @DataTriny and we wrote the mismatched properties, though my notes are sparse and I usually didn't note what the exact mismatch was. Still, if we want to document our relationship with ARIA, these properties are a good starting point:

  • IsSpellingError
  • IsGrammarError
  • IsSearchMatch
  • IsSuggestion
  • Children
  • InPageLinkTarget
  • MemberOf
  • NextOnLine
  • PreviousOnLine
  • PopupFor
  • Label
  • Value
  • ClassName
  • HtmlTag
  • Url
  • RowIndexText
  • ColumnIndexText
  • ScrollX
  • ScrollXMin
  • ScrollXMax
  • ScrollY
  • ScrollYMin
  • ScrollYMax
  • NumericValue
  • NumericValueStep
  • NumericValueJump
  • FontSize
  • FontWeight
  • BackgroundColor
  • ForegroundColor
  • Overline
  • Strikethrough
  • Underline
  • Invalid
  • Toggled
  • TextDirection
  • ListStyle
  • TextAlign
  • VerticalOffset
  • TextSelection

Ideally we should also document differences in roles and actions, but I haven't started to list those.

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

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.

More from AccessKit/accesskit

All issues in AccessKit/accesskit

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.