shadcn-ui-expansions项目中多选组件在模态框中的焦点问题解析

问题背景

在使用shadcn-ui-expansions项目中的可创建多选组件时，开发者发现当该组件被放置在模态对话框中时，键盘导航会出现异常行为。具体表现为：组件能够正确获取焦点，但随后焦点会意外转移到对话框本身，而不是按预期移动到下一个可聚焦元素。

问题分析

这个问题本质上是一个焦点管理问题，主要涉及以下几个方面：

1. 模态对话框的特殊性：模态对话框通常会捕获焦点并限制焦点在其内部元素间循环，这是为了确保无障碍访问和良好的用户体验。

2. 多选组件的复杂性：可创建多选组件通常包含输入框、选项列表等多个可交互元素，其内部焦点管理本身就较为复杂。

3. 组合组件的交互：当这两个复杂组件组合使用时，焦点管理逻辑可能出现冲突，特别是在键盘导航场景下。

解决方案探讨

官方建议方案

项目维护者建议可以尝试将模态对话框的modal属性设置为false，但这需要开发者自行处理以下附加功能：

• 实现DialogOverlay来锁定背景滚动
• 手动管理对话框关闭的点击事件

不过维护者也指出，这个问题可能与底层使用的radix库有关，目前尚未找到完美的解决方案。

开发者贡献方案

一位开发者提供了更为详细的解决方案，通过自定义键盘事件处理来手动控制焦点转移：

1. 拦截Tab键事件：在多选组件的输入元素上添加自定义的onKeyDown处理程序，拦截Tab键的默认行为。

2. 手动焦点转移：

   • 当按下Tab键时，阻止默认行为
   • 根据是否同时按下Shift键，决定向前或向后移动焦点
   • 调用自定义函数实现精确的焦点控制

3. 可聚焦元素查询：实现一个工具函数，能够智能地查找页面中所有可通过键盘聚焦的元素，并考虑它们的可见性和可交互状态。

实现细节

焦点转移函数

function focusRelativeElement(direction: 'next' | 'prev') {
  const focusableElements = getKeyboardFocusableElements();
  const currentIndex = focusableElements.findIndex((el) => el === document.activeElement);
  const targetIndex = direction === 'next' ? currentIndex + 1 : currentIndex - 1;
  const target = focusableElements[targetIndex];
  target?.focus();
}

可聚焦元素查询

function getKeyboardFocusableElements(container: HTMLElement | Document = document): HTMLElement[] {
  const focusableSelector = [
    'a[href]:not([tabindex^="-"])',
    'area[href]:not([tabindex^="-"])',
    'input:not([disabled]):not([tabindex^="-"])',
    'select:not([disabled]):not([tabindex^="-"])',
    'textarea:not([disabled]):not([tabindex^="-"])',
    'button:not([disabled]):not([tabindex^="-"])',
    'iframe:not([tabindex^="-"])',
    '[tabindex]:not([tabindex^="-"])',
    '[contenteditable]:not([tabindex^="-"])',
  ].join(',');

  const nodes = Array.from(container.querySelectorAll<HTMLElement>(focusableSelector));

  return nodes.filter((el) => {
    const style = window.getComputedStyle(el);
    return style.visibility !== 'hidden' && style.display !== 'none' && el.tabIndex >= 0;
  });
}

最佳实践建议

1. 全面测试：在实现自定义焦点管理后，务必进行全面的键盘导航测试，确保在各种场景下都能正常工作。

2. 无障碍考虑：确保自定义的焦点管理方案不会破坏无障碍访问体验，特别是对于屏幕阅读器用户。

3. 性能优化：可聚焦元素查询函数可能会被频繁调用，考虑对结果进行缓存或优化查询逻辑。

4. 渐进增强：可以先尝试官方建议的方案，如果不能满足需求再考虑实现自定义的焦点管理。

总结

shadcn-ui-expansions项目中多选组件与模态对话框的焦点管理问题是一个典型的组件交互挑战。通过理解问题的本质和探索不同的解决方案，开发者可以根据项目需求选择最适合的解决路径。无论是采用官方建议的配置方案，还是实现自定义的焦点管理逻辑，关键都在于确保最终用户能够获得流畅、可预测的键盘导航体验。