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.