SuperAPI AI 工具集

implementing-a11y

前端与建站

查看项目

更新于 10-20 11:38

技能介绍

用途

该技能用于在编写 UI 组件和页面之前与过程中落实无障碍要求,是 a11y-specialist-skills 中的实现入口。它只保存实现流程,不含无障碍知识本身;具体知识位于 a11y-knowledge 知识库中。

主要能力

  • 引导使用者先列出要编写组件对应的 ARIA 角色(如 dialog,内含 button、textbox),按角色而非视觉名称(modal、toggle)整理。
  • 通过 index-by-component.md 查找各角色适用的成功准则。
  • 对于整页与多页层面的准则(2.4.1、2.4.2、3.1.1、1.4.1、1.3.3、3.2.3、3.2.4、3.2.6),在编写布局、模板或页面骨架时改用 index-by-criterion.md,挑选性质为「整页」或「多页」的准则。
  • 针对每条准则,只阅读 ../a11y-knowledge/references/criteria/<number>.md 中「Judgment lines」和「When building」两节,不一次通读全部内容。
  • 实现时优先使用原生 HTML 元素(button、a href、input、dialog、details);仅当标准元素无法表达时才用 ARIA 添加角色;自定义组件遵循 WAI-ARIA APG 模式(键盘交互、角色、状态)。
  • 完成后自检,并对只能通过目视或操作确认的项目,在代码注释或 PR 描述中标注「needs visual verification」,不把未亲自验证的项目写成「handled」。

使用方式

  1. 按角色列出要编写的组件;2. 查找各角色适用的成功准则;3. 阅读每条准则的「Judgment lines」与「When building」;4. 按上述原则构建;5. 自检并记录目视验证事项。

实现时需同时输出:

Success criteria considered for accessibility

  • dialog: 2.1.2 (focus containment), 2.4.3 (focus on open/close), 4.1.2
  • button: 2.5.8, 4.1.2

Needs visual verification

  • [ ] Focus returns to the opening button after closing (2.4.3)
  • [ ] The focus ring is visible against the background (2.4.7)

[Our interpretation] judgment lines overridden

  • (if any: what and why)

关于判断线的解释:[Understanding] 类判断线基于 Understanding 文档,应予以遵循;[Our interpretation] 类为操作性解释,项目自身的决定(设计规范、现有组件构建方式)可以覆盖,但覆盖时需在代码注释或 PR 描述中记录原因。

适用场景与限制

适用于开发前的准则查询与开发中的实现指导。若需要对已写内容报告问题,应使用 reviewing-a11y;若需要按成功准则逐条给出 Pass/Fail 的正式审计,应使用 auditing-wcag。知识库通过相对路径 ../a11y-knowledge/ 引用,作为插件安装时才能解析;若以符号链接方式单独安装各技能目录,需同时链接 a11y-knowledge。