shuding/nextra

a11y keyboard navigation and screen reader improvements

Open

#3,721 建立於 2024年11月20日

在 GitHub 查看
 (6 留言) (0 反應) (0 負責人)TypeScript (13,807 star) (1,413 fork)user submission
enhancementhelp wanted

描述

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"

貢獻者指南

技術棧
typescriptreactnextjshtmlcss
領域
frontendaccessibility
議題類型
accessibility
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
half day
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
fresh
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
mostly clear
前置要求
basic HTML and ARIA knowledgefamiliarity with Nextra components
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
60
研究方向
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