首页
/ Headless UI Combobox 在 Portal 中渲染时的测试解决方案

Headless UI Combobox 在 Portal 中渲染时的测试解决方案

2025-05-06 13:52:06作者:廉皓灿Ida

Headless UI 是一个流行的无头 UI 组件库,它提供了完全可访问、无样式的 UI 组件,让开发者可以完全控制样式和行为。在最新版本(v2)中,Combobox 组件默认会将选项列表渲染到 Portal 中,这给测试带来了一些挑战。

问题背景

当 Combobox 使用 anchor 属性时,选项列表会被渲染到 body 元素下的 Portal 中。这种设计虽然提高了组件的灵活性和可访问性,但在使用 react-testing-library 进行测试时会出现问题:

  1. 测试用例无法找到渲染在 Portal 中的选项列表
  2. 测试会无限挂起或失败
  3. 控制台会出现关于无效 CSS 值的警告

解决方案

1. 使用 userEvent 代替 fireEvent

Headless UI 内部使用 mousedown 而非 click 事件来处理选项选择。因此,使用 userEvent.selectOptions() 更符合实际交互:

screen.getByRole("input").focus();
const option = await screen.getByRole("option", { name: "Some option" });
await userEvent.selectOptions(screen.getByRole("listbox"), option);

2. 处理动画帧问题

由于 Combobox 内部使用了 requestAnimationFrame 来处理焦点状态,这会导致测试时序问题。可以通过模拟这些 API 来解决:

const requestAnimationFrameMock = jest.spyOn(window, "requestAnimationFrame")
  .mockImplementation(setImmediate as any);
const cancelAnimationFrameMock = jest.spyOn(window, "cancelAnimationFrame")
  .mockImplementation(clearImmediate as any);

// 测试代码...

requestAnimationFrameMock.mockRestore();
cancelAnimationFrameMock.mockRestore();

3. 使用 immediate 属性

设置 immediate 属性可以简化焦点管理:

<Combobox
  multiple
  value={selectedPeople}
  onChange={setSelectedPeople}
  onClose={() => setQuery("")}
  immediate
>
  {/* ... */}
</Combobox>

4. 直接操作焦点

对于简单场景,直接操作焦点可能就足够了:

fireEvent.focus(screen.getByRole("combobox"));
screen.getByRole("option", { name: "Katelyn Rohan" });

最新进展

Headless UI 团队已经意识到这个问题,并在最新的 insider 版本中提供了修复。开发者可以通过以下命令尝试修复后的版本:

npm install @headlessui/react@insiders

总结

测试渲染在 Portal 中的组件确实会带来一些挑战,但通过理解 Headless UI 的内部实现机制,并采用适当的测试策略,这些问题是可以解决的。随着库的不断更新,这些测试体验也在不断改善。开发者可以根据自己的需求选择最适合的解决方案,或者等待官方正式发布修复版本。

登录后查看全文
热门项目推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
144
1.93 K
kernelkernel
deepin linux kernel
C
22
6
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
274
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
930
553
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
423
392
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
75
66
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.11 K
0
openHiTLS-examplesopenHiTLS-examples
本仓将为广大高校开发者提供开源实践和创新开发平台,收集和展示openHiTLS示例代码及创新应用,欢迎大家投稿,让全世界看到您的精巧密码实现设计,也让更多人通过您的优秀成果,理解、喜爱上密码技术。
C
64
511