vjeantet/hugo-theme-docdock

">" link isn't recognized by VoiceOver

Open

#157 opened on Sep 15, 2018

View on GitHub
 (1 comment) (0 reactions) (0 assignees)JavaScript (315 forks)github user discovery
enhancementhelp wanted

Repository metrics

Stars
 (614 stars)
PR merge metrics
 (PR metrics pending)

Description

Background

Sidebar entries have the form "> Foo". Both ">" and "Foo" are clickable links; ">" expands the entry, causing subsidiary elements to be displayed; "Foo" jumps the user to the "Foo" page.

Problem

Although the "Foo" link is recognized and announced by VoiceOver (on Apple's macOS), the ">" link is not. So, this affordance is inaccessible to blind users.

Contributor guide

Research direction
Inspect the HTML structure of sidebar entries, locate the '>' link element, and add appropriate ARIA attributes (e.g., role='button', aria label='Expand entry') to make it accessible to VoiceOver.
Tech stack
javascripthtmlcss
Domain
frontendaccessibility
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
HTMLCSSAccessibility (ARIA)
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80