# @elastic/eui-test-helpers 中文文档

规范地址：https://npmcn.com/package/%40elastic/eui-test-helpers/

版本：2\.4\.0
npm 元数据更新时间：2026-11-16T18:24:07.055Z
中文译文更新时间：2026-11-16T18:25:25.326Z
软件包许可：SEE LICENSE IN LICENSE\.txt

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40elastic/eui-test-helpers
原文对照：https://npmcn.com/package/%40elastic/eui-test-helpers/?lang=original
项目主页：https://github.com/elastic/eui/blob/main/packages/test-helpers
源码仓库：https://github.com/elastic/eui

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：568 kB，366 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：@playwright/test ^1\.50\.0
- 首次发布：2026-07-02T10:28:59.083Z
- 最新版本发布：2026-11-16T18:24:06.448Z
- 近 30 天下载量：289610（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：161（近 12 个月 161 个）

## 中文简介

RTL、 Cypress 和 Scout 的 EUI 测试助手库

## 安装

```sh
npm install @elastic/eui-test-helpers
```

也可以使用：`pnpm add @elastic/eui-test-helpers`、`yarn add @elastic/eui-test-helpers`、`bun add @elastic/eui-test-helpers`

## README

# EUI 测试助手

`@elastic/eui-test-helpers` 提供与 EUI 组件可靠互动的助手 消费者测试——不再猜测只有CSS选择者 _看来_ 对 今天它飞来飞去 **剧作家组件对象** 页:1 [童子军](https://github.com/elastic/kibana/tree/main/src/platform/packages/shared/kbn-scout)编号 :[剧作家](https://playwright.dev/) 消费者; [齐压](https://github.com/cypress-io/cypress) 财务报告和审定财务报表 [反应测试库](https://github.com/testing-library/react-testing-library) 帮助者可以跟随.

> \[注\] 该图书馆处于早期开发阶段,缺少许多有用的设施。 请提供或 [打开特性请求](https://github.com/elastic/eui/issues/new?template=feature_request.md) 如果你发现 东西不见了!

该库为EUI组件提供非三进制的公用设备来编写测试. 请使用内置 用于测试由您选择的测试框架提供的简单、类似本地组件的方法.

## 安装

此库独立于 `@elastic/eui`。因为帮助者的目标是EUI的组件DOM和 `data-test-subj`s, 选择一个符合 `@elastic/eui` 你正在测试的版本.

```shell
yarn add --dev @elastic/eui-test-helpers
```

## 剧作家组件对象

对于Playwright/Scout的消费者,这个包裹船 **组件对象** —— 说 单个 Playwright 周围的语义包装 `Locator` 封装 特定 EUI 组件的用户类交互.

```ts
import { EuiComboBoxObject } from '@elastic/eui-test-helpers';

const comboBox = new EuiComboBoxObject(page, 'dataViewSelector');
await comboBox.setSelectedOptions(['logs-*']);
expect(await comboBox.getSelectedOptions()).toEqual(['logs-*']);
```

每个组件对象构建器需要 `(scope, testSubj)`数字 :

-   `scope` - 一个剧作家 `Page` 或者说 `Locator` 在内部搜索
-   `testSubj` - 那个 `data-test-subj` 在应用程序中设置组件根元素的值

`@playwright/test` 被宣布为 `peerDependency` - 消费者提供 运行时他们自己的版本.

### 可用组件对象

| 构成部分 | 文档 |
| --- | --- |
| `EuiComboBoxObject` | [src/ 组件/ combo box/README. md](https://npmcn.com/package/%40elastic/eui-test-helpers/src/components/combo_box/README.md) |
| `EuiDataGridObject` | [src/组件/数据网/README.md](https://npmcn.com/package/%40elastic/eui-test-helpers/src/components/datagrid/README.md) |
| `EuiSuperSelectObject` | [src/ 组件/ 窗体/ 超级 选择/README. md](https://npmcn.com/package/%40elastic/eui-test-helpers/src/components/form/super_select/README.md) |
| `EuiGlobalToastListObject` | [斜弧/组件/塔斯/README.md](https://npmcn.com/package/%40elastic/eui-test-helpers/src/components/toast/README.md) |
| `EuiSelectableObject` | [sc/组件/可选/README.md](https://npmcn.com/package/%40elastic/eui-test-helpers/src/components/selectable/README.md) |
| `EuiSideNavObject` | [src/ 组件/ side nav/README.md](https://npmcn.com/package/%40elastic/eui-test-helpers/src/components/side_nav/README.md) |
| `EuiDraggableObject` | [src/ 组件/ drag and drop/README. md](https://npmcn.com/package/%40elastic/eui-test-helpers/src/components/drag_and_drop/README.md) |
| `EuiFilterButtonObject` | [src/ 组件/ filter 按钮/README.md](https://npmcn.com/package/%40elastic/eui-test-helpers/src/components/filter_button/README.md) |
| `EuiFieldSearchObject` | [src/组件/形式/场 研究/README.md](https://npmcn.com/package/%40elastic/eui-test-helpers/src/components/form/field_search/README.md) |
| `EuiSearchBarObject` | [src/ 组件/ search bar/README.md](https://npmcn.com/package/%40elastic/eui-test-helpers/src/components/search_bar/README.md) |
| `EuiRangeObject` | [src/组件/形式/范围/README.md](https://npmcn.com/package/%40elastic/eui-test-helpers/src/components/form/range/README.md) |
| `EuiCheckboxObject` | [src/组件/形式/检查框/README.md](https://npmcn.com/package/%40elastic/eui-test-helpers/src/components/form/checkbox/README.md) |
| `EuiSwitchObject` | [src/组件/形式/开关/README.md](https://npmcn.com/package/%40elastic/eui-test-helpers/src/components/form/switch/README.md) |
| `EuiFieldTextObject` | [src/组件/窗体/字段 文本/README.md](https://npmcn.com/package/%40elastic/eui-test-helpers/src/components/form/field_text/README.md) |
| `EuiSelectObject` | [src/组件/形式/选择/README.md](https://npmcn.com/package/%40elastic/eui-test-helpers/src/components/form/select/README.md) |
| `EuiPopoverObject` | [src/组件/人口过剩/README.md](https://npmcn.com/package/%40elastic/eui-test-helpers/src/components/popover/README.md) |
| `EuiFlyoutObject` | [src/组件/飞出/README.md](https://npmcn.com/package/%40elastic/eui-test-helpers/src/components/flyout/README.md) |
| `EuiAccordionObject` | [弧/组件/相干/README.md](https://npmcn.com/package/%40elastic/eui-test-helpers/src/components/accordion/README.md) |
| `EuiContextMenuObject` | [src/ 组件/ 文本 菜单/README. md](https://npmcn.com/package/%40elastic/eui-test-helpers/src/components/context_menu/README.md) |
| `EuiModalObject` | [src/组件/模式/README.md](https://npmcn.com/package/%40elastic/eui-test-helpers/src/components/modal/README.md) |
| `EuiTableObject` | [src/组件/表/README.md](https://npmcn.com/package/%40elastic/eui-test-helpers/src/components/table/README.md) |
| `EuiTabsObject` | [src/组件/tabs/README.md](https://npmcn.com/package/%40elastic/eui-test-helpers/src/components/tabs/README.md) |
| `EuiMarkdownEditorObject` | [src/ 组件/ markdown editor/README. md](https://npmcn.com/package/%40elastic/eui-test-helpers/src/components/markdown_editor/README.md) |
| `EuiPaginationObject` | [rc/组件/修补/README.md](https://npmcn.com/package/%40elastic/eui-test-helpers/src/components/pagination/README.md) |
| `EuiBasicTableObject` | [src/ 组件/基本表/README.md](https://npmcn.com/package/%40elastic/eui-test-helpers/src/components/basic_table/README.md) |
| `EuiCallOutObject` | [src/组件/调用/README.md](https://npmcn.com/package/%40elastic/eui-test-helpers/src/components/call_out/README.md) |
| `EuiCardObject` | [sc/组件/卡/README.md](https://npmcn.com/package/%40elastic/eui-test-helpers/src/components/card/README.md) |
| `EuiButtonGroupObject` | [sc/ 组件/ 按钮/ 按钮 组/ README. md](https://npmcn.com/package/%40elastic/eui-test-helpers/src/components/button/button_group/README.md) |
| `EuiColorPickerObject` | [src/ 组件/ color pickers/README. md](https://npmcn.com/package/%40elastic/eui-test-helpers/src/components/color_picker/README.md) |
| `EuiTreeViewObject` | [src/ 组件/ 树上视图/ README. md](https://npmcn.com/package/%40elastic/eui-test-helpers/src/components/tree_view/README.md) |
| `EuiToolTipObject` | [src/ 组件/ 工具 tip/README. md](https://npmcn.com/package/%40elastic/eui-test-helpers/src/components/tool_tip/README.md) |

### 选择器

每个组件对象的稳定选择器在一个下导出 `selectors` 对象,按组件键取(`selectors.comboBox`, (中文(简体) ), `selectors.dataGrid`这样 (电话). `*_SELECTOR` 值是 CSS 类选择器, `*_TEST_SUBJ` 值为 `data-test-subj` 名称 EUI 设置本身.

```ts
import { selectors } from '@elastic/eui-test-helpers';

page.locator(selectors.basicTable.ROW_SELECTOR);
```

优先使用组件对象。 选择器用于工具, 如 lint 在消费者测试中标出手写EUI选择者的规则 范围界定需要对象尚未覆盖 .

## 捐款

见 [捐款额](https://npmcn.com/package/%40elastic/eui-test-helpers/CONTRIBUTING.md) 用于设计原理、目录结构以及如何添加新的组件对象.

## 常见问题

### @elastic/eui-test-helpers 是什么？

RTL、 Cypress 和 Scout 的 EUI 测试助手库

### 如何安装 @elastic/eui-test-helpers？

在项目目录运行 npm install @elastic/eui-test-helpers，或使用 pnpm add / yarn add / bun add。

### @elastic/eui-test-helpers 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @elastic/eui-test-helpers 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @elastic/eui-test-helpers 可以商用吗？

@elastic/eui-test-helpers 使用 SEE LICENSE IN LICENSE\.txt 许可。许可条款写在包内的独立文件中，请阅读该文件确认可否商用。以上为概括，不构成法律意见，请以许可原文为准。

### @elastic/eui-test-helpers 的下载量有多少？

根据 npm 官方下载统计，@elastic/eui-test-helpers 在 2026/10/14 – 2026/11/12 这 30 天内被下载 289,610 次，日均约 9,654 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @elastic/eui-test-helpers 还在维护吗？

最新版本 2\.4\.0 发布于 2026/11/17（今天）；至今共发布 161 个版本，其中过去 12 个月发布了 161 个；首次发布于 2026/07/02。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

