aurelia / aurelia/documentation

A11y: make the interface keyboard-navigable

Open
#333 1 comment 0 reactions 0 assignees View on GitHub
documentation enhancement
Dominant language
No language data
Stars
104
Forks
108
PR merge metrics
No merged PRs in 30d

Description

The Hub currently isn't keyboard navigable: the `nav-button`s aren't in the tabindex so navigation is impossible. This can be worked around somewhat by using search (ctrl + shift + P but see also #224) but that prevents users from getting a topic listing once they've navigated away from the top level.

Besides this, many elements that are in the tabindex currently don't have a focus outline or any other kind of focus styling, making it impossible to determine which UI element is currently focused.

Keyboard navigation is a requirement to bring the documentation to a wider audience that can't rely on mouse or touch navigation.

Contributor guide

Open the contributing guide

Research direction

Start by inspecting the Hub's nav-button elements and the existing tabindex and focus styling. Done means keyboard users can navigate the topic listings after leaving the top level, and every keyboard-focusable UI element has a visible focus indication.

Written by the indexing model from the issue text.

Assessment

Domain
accessibility, web-dev
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.