shuding/nextra

a11y keyboard navigation and screen reader improvements

Open

#3,721 opened on Nov 20, 2024

View on GitHub
 (6 comments) (0 reactions) (0 assignees)TypeScript (13,807 stars) (1,413 forks)user submission
enhancementhelp wanted

Description

Some accessibility fixes I'm planning on patching when I've got some time, jotting it down as a start...

  • Skip to content for keyboard navigation (something like GDS) WONT FIX : this is avaliable in v4
  • Missing aria-label
    • Search box input
    • Breadcrumb (follow NHS / APG) -- also change div to nav
  • SVGs add role="presentation" when pre-described by other content
    • Top nav grouped dropdown, chevron icon
    • Light/dark mode icon
    • Sidebar collapse icon (more investigation needed to see if this is actually required)
  • ARIA hidden element must not be focusable or contain focusable elements
    • "Scroll to top"

Contributor guide

Tech stack
typescriptreactnextjshtmlcss
Domain
frontendaccessibility
Issue type
accessibility
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
basic HTML and ARIA knowledgefamiliarity with Nextra components
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Investigate the search box input and breadcrumb components to add missing aria labels. For breadcrumbs, change the container from <div> to <nav> and follow WAI ARIA breadcrumb pattern. Add role="presentation" to SVG icons like the chevron and light/dark mode icon. Ensure the "Scroll to top" button, which is aria hidden, does not contain focusable elements. Relevant files likely include components like Search, Breadcrumb, and Layout.
a11y keyboard navigation and screen reader improvements · shuding/nextra#3721 | Good First Issue