Shepherd 项目中的模态对话框可访问性优化指南

Shepherd 是一个流行的 JavaScript 用户引导库，它通过模态对话框帮助用户了解产品功能。本文深入分析该库在可访问性方面的一个重要问题及其解决方案。

问题背景

在 Shepherd 的模态对话框实现中，存在一个影响屏幕阅读器用户体验的设计问题。对话框内部的一个 div 元素被赋予了 tabindex="0" 属性，这导致了两个可访问性问题：

1. 该 div 并非交互元素，却获得了焦点，违反了 WAI-ARIA 设计原则
2. 屏幕阅读器会因此重复播报对话框内容，造成冗余信息

技术分析

根据 W3C 的 ARIA 设计模式指南，模态对话框的焦点管理应遵循以下原则：

• 焦点应初始设置在第一个可交互元素上（通常是关闭按钮）
• 只有真正可操作的交互元素才应获得 tabindex 属性
• 焦点管理应考虑对话框内容的性质和大小

Shepherd 当前实现中，对话框内容区域被赋予 tabindex="0"，这虽然确保了内容可滚动，但带来了不必要的焦点停留点。

解决方案

临时解决方案

开发者可以通过以下代码在初始化时移除不必要的 tabindex：

const tour = new Shepherd.Tour({
  defaultStepOptions: {
    when: {
      show: () => {
        document.querySelectorAll('.shepherd-content').forEach(element => {
          element.removeAttribute('tabindex');
        });
      }
    }
  }
});

永久修复

项目维护者已提交修复代码，从根源上移除了内容区域的 tabindex 属性。这一改动：

1. 简化了焦点流
2. 消除了屏幕阅读器的重复播报
3. 保持了对话框的可滚动性
4. 符合 WAI-ARIA 最佳实践

最佳实践建议

在实现类似模态对话框时，开发者应注意：

1. 焦点应设置在最有意义的交互元素上（通常是关闭按钮或主要操作按钮）
2. 避免给非交互容器元素添加 tabindex
3. 确保焦点被正确限制在对话框内
4. 提供清晰的关闭机制
5. 测试屏幕阅读器下的用户体验

Shepherd 团队对可访问性的重视值得赞赏，这一改进将显著提升残障用户的使用体验。