@elastic/eui-test-helpers 1.2.0 → 1.3.0

package/src/components/datagrid/README.md

@@ -0,0 +1,25 @@
+# EuiDataGridObject
+
+Playwright Component Object for [EuiDataGrid](https://eui.elastic.co/docs/components/data-grid).
+
+## Usage
+
+```ts
+import { EuiDataGridObject } from '@elastic/eui-test-helpers';
+
+const dataGrid = new EuiDataGridObject(page, 'myDataGrid');
+await expect(dataGrid.rows).toHaveCount(10);
+await expect(dataGrid.cells('name').filter({ hasText: 'my-rule' })).toBeVisible();
+```
+
+Set `data-test-subj` on the `<EuiDataGrid>` itself — EUI spreads it onto the `.euiDataGrid` element, and the Component Object verifies that (the component-type guard throws otherwise). EUI also toggles state classes such as fullscreen on that element, so a wrapper subj would not work. When the subj is not unique on the page (e.g. portal-rendered duplicates), narrow with the `scope` constructor parameter instead of pointing the subj at a wrapper.
+
+## API
+
+| Member | Description |
+|---|---|
+| `rows` | `Locator` for the rendered rows, keeping Playwright auto-retry for count/content assertions. For a paginated grid this is the current page. Rows are virtualized: on a grid too tall for its container this is only the visible window, never the full data set. |
+| `cell(rowIndex, columnId)` | `Locator` for a single data cell. The column id is stable against column reordering and horizontal virtualization. |
+| `cells(columnId)` | `Locator` for every rendered data cell of a column (excludes the header cell). |
+| `doActionOnColumn(columnId, actionLabel)` | Opens the column's header actions and clicks the action with the given visible label (e.g. `'Hide column'`). Handles the hover/focus dance the actions button requires and the portal-rendered menu (scoped per column id, safe with multiple grids). |
+| `openFullScreenMode()` / `closeFullScreenMode()` | Toggles fullscreen via the toolbar button and settles on the synchronously-set state class. Blurs the button afterwards so its tooltip does not cover the grid. |

package/src/components/form/super_select/README.md

@@ -0,0 +1,25 @@
+# EuiSuperSelectObject
+
+Playwright Component Object for [EuiSuperSelect](https://eui.elastic.co/docs/components/forms/selection/super-select/).
+
+## Usage
+
+```ts
+import { EuiSuperSelectObject } from '@elastic/eui-test-helpers';
+
+const superSelect = new EuiSuperSelectObject(page, 'mySuperSelect');
+await superSelect.selectOptionByValue('warning');
+expect(await superSelect.getSelectedValue()).toBe('warning');
+```
+
+Set `data-test-subj` on the `<EuiSuperSelect>` — EUI spreads it onto the control `<button>` (`.euiSuperSelectControl`), which the component-type guard verifies.
+
+## API
+
+| Method | Description |
+|---|---|
+| `selectOptionByValue(value)` | Selects the option whose `value` matches. Works on any EuiSuperSelect without extra test hooks (EUI renders each option with `id={String(value)}`) and is the preferred method when the value is a stable code constant — it is immune to i18n and display changes. |
+| `selectOptionByLabel(label)` | Selects the option by its visible label. Use for dynamic, data-driven option content where the test cannot know the value. Note the dropdown shows `dropdownDisplay` when the consumer provides it, which can differ from the committed `inputDisplay` text. |
+| `getSelectedValue()` | The committed selection's `value`, read from the hidden form input EUI renders next to the control (the visible button text shows the label, not the value). |
+
+Both select methods open the dropdown if needed and wait for it to close after the click.

package/src/components/toast/README.md

@@ -0,0 +1,22 @@
+# EuiGlobalToastListObject
+
+Playwright Component Object for [EuiGlobalToastList](https://eui.elastic.co/docs/components/display/toast/).
+
+## Usage
+
+```ts
+import { EuiGlobalToastListObject } from '@elastic/eui-test-helpers';
+
+const toastList = new EuiGlobalToastListObject(page, 'globalToastList');
+await expect(toastList.toasts).toHaveCount(1);
+await toastList.closeAll();
+```
+
+Set `data-test-subj` on the `<EuiGlobalToastList>` (EUI spreads it onto the `.euiGlobalToastList` element, which the component-type guard verifies). Toasts rendered outside the list (inline `EuiToast`) are not covered.
+
+## API
+
+| Member | Description |
+|---|---|
+| `toasts` | `Locator` for the toasts currently in the list, keeping Playwright auto-retry for count and content assertions (e.g. `expect(toasts).toHaveCount(1)`, `expect(toasts).toContainText('Saved')`). |
+| `closeAll()` | Clicks every toast's close button and waits until none remain. No-op when the list is already empty, so it doubles as a "dismiss if present" teardown helper. Tolerates toasts auto-dismissing mid-iteration. |