@elastic/eui-test-helpers 1.2.0 → 1.3.0

package/README.md

@@ -47,6 +47,9 @@ their own version at runtime.
 | Component | Documentation |
 |---|---|
 | `EuiComboBoxObject` | [src/components/combo_box/README.md](src/components/combo_box/README.md) |
+| `EuiDataGridObject` | [src/components/datagrid/README.md](src/components/datagrid/README.md) |
+| `EuiSuperSelectObject` | [src/components/form/super_select/README.md](src/components/form/super_select/README.md) |
+| `EuiGlobalToastListObject` | [src/components/toast/README.md](src/components/toast/README.md) |
 
 ## Contributing
 

package/lib/cjs/components/datagrid/selectors.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Stable selectors for
+ * {@link https://eui.elastic.co/docs/components/data-grid|EuiDataGrid}.
+ * `*_SELECTOR` values are CSS; `*_TEST_SUBJ` values are `data-test-subj` names.
+ */
+export declare const EuiDataGridSelectors: {
+    /** Root element (the `.euiDataGrid` div carrying the consumer's `data-test-subj`). */
+    ROOT_SELECTOR: string;
+    /** Root element only while fullscreen mode is active (state class set synchronously). */
+    FULL_SCREEN_ROOT_SELECTOR: string;
+    /** A rendered data row. Rows are virtualized — only a window is mounted. */
+    ROW_SELECTOR: string;
+    /**
+     * A rendered data cell. Cells carry `data-gridcell-column-id` (stable column
+     * id, unaffected by column order) and `data-gridcell-row-index`. Header cells
+     * carry `data-gridcell-column-id` too, so cell queries must include this
+     * class to exclude them.
+     */
+    ROW_CELL_SELECTOR: string;
+    /** A column header cell (also carries `data-gridcell-column-id`). */
+    HEADER_CELL_SELECTOR: string;
+    /** The header cell's actions button, interactable on focus/hover. */
+    HEADER_ACTIONS_BUTTON_SELECTOR: string;
+    FULL_SCREEN_BUTTON_TEST_SUBJ: string;
+    /**
+     * A column's header actions menu. It renders in a portal, but EUI names it
+     * per column id, which keeps lookups safe when several grids coexist.
+     */
+    headerActionsMenuFor: (columnId: string) => string;
+    /** A rendered data cell addressed by column id and row index. */
+    cellFor: (columnId: string, rowIndex: number) => string;
+    /** All rendered data cells of a column. */
+    columnCellsFor: (columnId: string) => string;
+    /** A column's header cell. */
+    headerCellFor: (columnId: string) => string;
+};

package/lib/cjs/components/datagrid/selectors.js

@@ -0,0 +1,50 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.EuiDataGridSelectors = void 0;
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+/**
+ * Stable selectors for
+ * {@link https://eui.elastic.co/docs/components/data-grid|EuiDataGrid}.
+ * `*_SELECTOR` values are CSS; `*_TEST_SUBJ` values are `data-test-subj` names.
+ */
+const EuiDataGridSelectors = exports.EuiDataGridSelectors = {
+  /** Root element (the `.euiDataGrid` div carrying the consumer's `data-test-subj`). */
+  ROOT_SELECTOR: '.euiDataGrid',
+  /** Root element only while fullscreen mode is active (state class set synchronously). */
+  FULL_SCREEN_ROOT_SELECTOR: '.euiDataGrid--fullScreen',
+  /** A rendered data row. Rows are virtualized — only a window is mounted. */
+  ROW_SELECTOR: '.euiDataGridRow',
+  /**
+   * A rendered data cell. Cells carry `data-gridcell-column-id` (stable column
+   * id, unaffected by column order) and `data-gridcell-row-index`. Header cells
+   * carry `data-gridcell-column-id` too, so cell queries must include this
+   * class to exclude them.
+   */
+  ROW_CELL_SELECTOR: '.euiDataGridRowCell',
+  /** A column header cell (also carries `data-gridcell-column-id`). */
+  HEADER_CELL_SELECTOR: '.euiDataGridHeaderCell',
+  /** The header cell's actions button, interactable on focus/hover. */
+  HEADER_ACTIONS_BUTTON_SELECTOR: '.euiDataGridHeaderCell__button',
+  FULL_SCREEN_BUTTON_TEST_SUBJ: 'dataGridFullScreenButton',
+  /**
+   * A column's header actions menu. It renders in a portal, but EUI names it
+   * per column id, which keeps lookups safe when several grids coexist.
+   */
+  headerActionsMenuFor: columnId => `[data-test-subj="dataGridHeaderCellActionGroup-${columnId}"]`,
+  /** A rendered data cell addressed by column id and row index. */
+  cellFor: (columnId, rowIndex) => `.euiDataGridRowCell[data-gridcell-column-id="${columnId}"][data-gridcell-row-index="${rowIndex}"]`,
+  /** All rendered data cells of a column. */
+  columnCellsFor: columnId => `.euiDataGridRowCell[data-gridcell-column-id="${columnId}"]`,
+  /** A column's header cell. */
+  headerCellFor: columnId => `.euiDataGridHeaderCell[data-gridcell-column-id="${columnId}"]`
+};

package/lib/cjs/components/form/super_select/selectors.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Stable selectors for
+ * {@link https://eui.elastic.co/docs/components/forms/selection/super-select/|EuiSuperSelect}.
+ * `*_SELECTOR` values are CSS.
+ */
+export declare const EuiSuperSelectSelectors: {
+    /**
+     * Root element (the control `<button>` carrying the consumer's
+     * `data-test-subj` — EUI spreads rest props onto it).
+     */
+    ROOT_SELECTOR: string;
+    /**
+     * The popover wrapper around the control. The hidden form input holding the
+     * committed value is a sibling of the button inside it.
+     */
+    WRAPPER_SELECTOR: string;
+    /**
+     * The options listbox. It renders in a popover portal, but EUI keeps at most
+     * one super-select dropdown open at a time, so a page-level lookup is safe.
+     */
+    LISTBOX_SELECTOR: string;
+    /**
+     * The hidden form input holding the committed `value` — a direct child of
+     * the popover wrapper, scoped as such so hidden inputs a consumer might
+     * render inside prepend/append content are never matched.
+     */
+    HIDDEN_INPUT_SELECTOR: string;
+    /**
+     * An option addressed by its `value` — EUI renders every option with
+     * `id={String(value)}`.
+     */
+    optionByValue: (value: string) => string;
+};

package/lib/cjs/components/form/super_select/selectors.js

@@ -0,0 +1,47 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.EuiSuperSelectSelectors = void 0;
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+/**
+ * Stable selectors for
+ * {@link https://eui.elastic.co/docs/components/forms/selection/super-select/|EuiSuperSelect}.
+ * `*_SELECTOR` values are CSS.
+ */
+const EuiSuperSelectSelectors = exports.EuiSuperSelectSelectors = {
+  /**
+   * Root element (the control `<button>` carrying the consumer's
+   * `data-test-subj` — EUI spreads rest props onto it).
+   */
+  ROOT_SELECTOR: '.euiSuperSelectControl',
+  /**
+   * The popover wrapper around the control. The hidden form input holding the
+   * committed value is a sibling of the button inside it.
+   */
+  WRAPPER_SELECTOR: '.euiSuperSelect',
+  /**
+   * The options listbox. It renders in a popover portal, but EUI keeps at most
+   * one super-select dropdown open at a time, so a page-level lookup is safe.
+   */
+  LISTBOX_SELECTOR: '.euiSuperSelect__listbox[role="listbox"]',
+  /**
+   * The hidden form input holding the committed `value` — a direct child of
+   * the popover wrapper, scoped as such so hidden inputs a consumer might
+   * render inside prepend/append content are never matched.
+   */
+  HIDDEN_INPUT_SELECTOR: ':scope > input[type="hidden"]',
+  /**
+   * An option addressed by its `value` — EUI renders every option with
+   * `id={String(value)}`.
+   */
+  optionByValue: value => `[role="option"][id="${value}"]`
+};

package/lib/cjs/components/toast/selectors.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Stable selectors for
+ * {@link https://eui.elastic.co/docs/components/display/toast/|EuiGlobalToastList}.
+ * `*_SELECTOR` values are CSS; `*_TEST_SUBJ` values are `data-test-subj` names.
+ */
+export declare const EuiGlobalToastListSelectors: {
+    /** Root element (the list carrying the consumer's `data-test-subj`). */
+    ROOT_SELECTOR: string;
+    /** A toast inside the list. */
+    TOAST_SELECTOR: string;
+    CLOSE_BUTTON_TEST_SUBJ: string;
+};

package/lib/cjs/components/toast/selectors.js

@@ -0,0 +1,26 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.EuiGlobalToastListSelectors = void 0;
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+/**
+ * Stable selectors for
+ * {@link https://eui.elastic.co/docs/components/display/toast/|EuiGlobalToastList}.
+ * `*_SELECTOR` values are CSS; `*_TEST_SUBJ` values are `data-test-subj` names.
+ */
+const EuiGlobalToastListSelectors = exports.EuiGlobalToastListSelectors = {
+  /** Root element (the list carrying the consumer's `data-test-subj`). */
+  ROOT_SELECTOR: '.euiGlobalToastList',
+  /** A toast inside the list. */
+  TOAST_SELECTOR: '.euiToast',
+  CLOSE_BUTTON_TEST_SUBJ: 'toastCloseButton'
+};

package/lib/cjs/index.d.ts

@@ -1,2 +1,5 @@
 export { BaseObject, type ObjectScope } from './playwright/base_object';
 export { EuiComboBoxObject } from './playwright/components/combo_box/object';
+export { EuiDataGridObject } from './playwright/components/datagrid/object';
+export { EuiSuperSelectObject } from './playwright/components/form/super_select/object';
+export { EuiGlobalToastListObject } from './playwright/components/toast/object';

package/lib/cjs/index.js

@@ -15,5 +15,26 @@ Object.defineProperty(exports, "EuiComboBoxObject", {
     return _object.EuiComboBoxObject;
   }
 });
+Object.defineProperty(exports, "EuiDataGridObject", {
+  enumerable: true,
+  get: function () {
+    return _object2.EuiDataGridObject;
+  }
+});
+Object.defineProperty(exports, "EuiGlobalToastListObject", {
+  enumerable: true,
+  get: function () {
+    return _object4.EuiGlobalToastListObject;
+  }
+});
+Object.defineProperty(exports, "EuiSuperSelectObject", {
+  enumerable: true,
+  get: function () {
+    return _object3.EuiSuperSelectObject;
+  }
+});
 var _base_object = require("./playwright/base_object");
-var _object = require("./playwright/components/combo_box/object");
+var _object = require("./playwright/components/combo_box/object");
+var _object2 = require("./playwright/components/datagrid/object");
+var _object3 = require("./playwright/components/form/super_select/object");
+var _object4 = require("./playwright/components/toast/object");

package/lib/cjs/playwright/components/datagrid/object.d.ts

@@ -0,0 +1,51 @@
+import type { Locator } from '@playwright/test';
+import { BaseObject, type ObjectScope } from '../../base_object';
+/**
+ * Playwright Component Object for {@link
+ * https://eui.elastic.co/docs/components/data-grid EuiDataGrid}.
+ *
+ * `testSubj` must match the `data-test-subj` set by the consumer on the
+ * `EuiDataGrid` itself (the component-type guard enforces it) — EUI toggles
+ * state classes (fullscreen) on that element. When the subj is not unique on
+ * the page (e.g. portal-rendered duplicates), narrow with the `scope`
+ * parameter instead of pointing the subj at a wrapper.
+ */
+export declare class EuiDataGridObject extends BaseObject {
+    constructor(scope: ObjectScope, testSubj: string);
+    /**
+     * The rows currently mounted in the DOM, as a `Locator` so callers keep
+     * Playwright auto-retry for count and content assertions
+     * (e.g. `expect(rows).toHaveCount(pageSize)`, `expect(rows).not.toHaveCount(0)`).
+     * For a paginated grid this is the current page's rows. Rows are virtualized,
+     * so on a grid too tall for its container this is only the visible window —
+     * never treat it as the full data set.
+     */
+    get rows(): Locator;
+    /**
+     * A single data cell, addressed by row index and column id. Column order and
+     * virtualized horizontal scrolling do not affect the column id.
+     */
+    cell(rowIndex: number, columnId: string): Locator;
+    /**
+     * All currently rendered data cells of a column. Rows are virtualized, so
+     * this is the rendered window, not necessarily every row.
+     */
+    cells(columnId: string): Locator;
+    /**
+     * Opens the header actions of a column and clicks the given action.
+     * `columnId` is the grid column id (matched verbatim), `actionLabel` is the
+     * visible action label (e.g. 'Hide column', 'Sort A-Z').
+     */
+    doActionOnColumn(columnId: string, actionLabel: string): Promise<void>;
+    /** Enters fullscreen mode via the toolbar button. */
+    openFullScreenMode(): Promise<void>;
+    /** Exits fullscreen mode via the toolbar button. */
+    closeFullScreenMode(): Promise<void>;
+    /** The grid element only while it carries the fullscreen state class. */
+    private get fullScreenGrid();
+    /**
+     * The fullscreen button sits in a tooltip wrapper and keeps focus after the
+     * click, which keeps the tooltip open over the grid — blur it right away.
+     */
+    private clickFullScreenButton;
+}

package/lib/cjs/playwright/components/datagrid/object.js

@@ -0,0 +1,119 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.EuiDataGridObject = void 0;
+var _base_object = require("../../base_object");
+var _selectors = require("../../../components/datagrid/selectors");
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+/**
+ * Playwright Component Object for {@link
+ * https://eui.elastic.co/docs/components/data-grid EuiDataGrid}.
+ *
+ * `testSubj` must match the `data-test-subj` set by the consumer on the
+ * `EuiDataGrid` itself (the component-type guard enforces it) — EUI toggles
+ * state classes (fullscreen) on that element. When the subj is not unique on
+ * the page (e.g. portal-rendered duplicates), narrow with the `scope`
+ * parameter instead of pointing the subj at a wrapper.
+ */
+class EuiDataGridObject extends _base_object.BaseObject {
+  constructor(scope, testSubj) {
+    super(scope, testSubj, _selectors.EuiDataGridSelectors.ROOT_SELECTOR);
+  }
+
+  /**
+   * The rows currently mounted in the DOM, as a `Locator` so callers keep
+   * Playwright auto-retry for count and content assertions
+   * (e.g. `expect(rows).toHaveCount(pageSize)`, `expect(rows).not.toHaveCount(0)`).
+   * For a paginated grid this is the current page's rows. Rows are virtualized,
+   * so on a grid too tall for its container this is only the visible window —
+   * never treat it as the full data set.
+   */
+  get rows() {
+    return this.root.locator(_selectors.EuiDataGridSelectors.ROW_SELECTOR);
+  }
+
+  /**
+   * A single data cell, addressed by row index and column id. Column order and
+   * virtualized horizontal scrolling do not affect the column id.
+   */
+  cell(rowIndex, columnId) {
+    return this.root.locator(_selectors.EuiDataGridSelectors.cellFor(columnId, rowIndex));
+  }
+
+  /**
+   * All currently rendered data cells of a column. Rows are virtualized, so
+   * this is the rendered window, not necessarily every row.
+   */
+  cells(columnId) {
+    return this.root.locator(_selectors.EuiDataGridSelectors.columnCellsFor(columnId));
+  }
+
+  /**
+   * Opens the header actions of a column and clicks the given action.
+   * `columnId` is the grid column id (matched verbatim), `actionLabel` is the
+   * visible action label (e.g. 'Hide column', 'Sort A-Z').
+   */
+  async doActionOnColumn(columnId, actionLabel) {
+    const headerCell = this.root.locator(_selectors.EuiDataGridSelectors.headerCellFor(columnId));
+    // The actions button only becomes interactable when the header cell is
+    // focused/hovered and inside the viewport.
+    await headerCell.scrollIntoViewIfNeeded();
+    await headerCell.focus();
+    await headerCell.hover();
+    await headerCell.locator(_selectors.EuiDataGridSelectors.HEADER_ACTIONS_BUTTON_SELECTOR).click();
+    const actionsMenu = this.root.page().locator(_selectors.EuiDataGridSelectors.headerActionsMenuFor(columnId));
+    await actionsMenu.waitFor({
+      state: 'visible'
+    });
+    // Role+name query auto-escapes the label and matches the accessible name
+    // (Kibana's lint also forbids getByTitle in favor of role queries).
+    await actionsMenu.getByRole('button', {
+      name: actionLabel,
+      exact: true
+    }).click();
+    await actionsMenu.waitFor({
+      state: 'hidden'
+    });
+  }
+
+  /** Enters fullscreen mode via the toolbar button. */
+  async openFullScreenMode() {
+    await this.clickFullScreenButton();
+    await this.fullScreenGrid.waitFor({
+      state: 'visible'
+    });
+  }
+
+  /** Exits fullscreen mode via the toolbar button. */
+  async closeFullScreenMode() {
+    await this.clickFullScreenButton();
+    await this.fullScreenGrid.waitFor({
+      state: 'detached'
+    });
+  }
+
+  /** The grid element only while it carries the fullscreen state class. */
+  get fullScreenGrid() {
+    return this.root.and(this.root.page().locator(_selectors.EuiDataGridSelectors.FULL_SCREEN_ROOT_SELECTOR));
+  }
+
+  /**
+   * The fullscreen button sits in a tooltip wrapper and keeps focus after the
+   * click, which keeps the tooltip open over the grid — blur it right away.
+   */
+  async clickFullScreenButton() {
+    const button = this.root.getByTestId(_selectors.EuiDataGridSelectors.FULL_SCREEN_BUTTON_TEST_SUBJ);
+    await button.click();
+    await button.blur();
+  }
+}
+exports.EuiDataGridObject = EuiDataGridObject;

package/lib/cjs/playwright/components/form/super_select/object.d.ts

@@ -0,0 +1,40 @@
+import { BaseObject, type ObjectScope } from '../../../base_object';
+/**
+ * Playwright Component Object for {@link
+ * https://eui.elastic.co/docs/components/forms/selection/super-select/ EuiSuperSelect}.
+ *
+ * `testSubj` must match the `data-test-subj` set by the consumer on the
+ * `<EuiSuperSelect>` — EUI spreads it onto the control `<button>`
+ * (`.euiSuperSelectControl`).
+ */
+export declare class EuiSuperSelectObject extends BaseObject {
+    constructor(scope: ObjectScope, testSubj: string);
+    /**
+     * Selects an option by its `value`. EUI renders every option with
+     * `id={String(value)}`, so this works for any EuiSuperSelect without extra
+     * test hooks and is the preferred method when the value is a stable code
+     * constant.
+     */
+    selectOptionByValue(value: string): Promise<void>;
+    /**
+     * Selects an option by its visible label. Use for dynamic, data-driven
+     * option content where the value is not known to the test. Note the dropdown
+     * shows `dropdownDisplay` when the consumer provides it, which can differ
+     * from the committed `inputDisplay` text.
+     */
+    selectOptionByLabel(label: string): Promise<void>;
+    /**
+     * 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).
+     */
+    getSelectedValue(): Promise<string>;
+    /** Opens the dropdown if it is not already open. */
+    private open;
+    private get listbox();
+    /**
+     * The hidden input is a sibling of the control button; reach it through the
+     * `.euiSuperSelect` popover wrapper that contains this instance's button.
+     */
+    private get hiddenInput();
+}

package/lib/cjs/playwright/components/form/super_select/object.js

@@ -0,0 +1,93 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.EuiSuperSelectObject = void 0;
+var _base_object = require("../../../base_object");
+var _selectors = require("../../../../components/form/super_select/selectors");
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+/**
+ * Playwright Component Object for {@link
+ * https://eui.elastic.co/docs/components/forms/selection/super-select/ EuiSuperSelect}.
+ *
+ * `testSubj` must match the `data-test-subj` set by the consumer on the
+ * `<EuiSuperSelect>` — EUI spreads it onto the control `<button>`
+ * (`.euiSuperSelectControl`).
+ */
+class EuiSuperSelectObject extends _base_object.BaseObject {
+  constructor(scope, testSubj) {
+    super(scope, testSubj, _selectors.EuiSuperSelectSelectors.ROOT_SELECTOR);
+  }
+
+  /**
+   * Selects an option by its `value`. EUI renders every option with
+   * `id={String(value)}`, so this works for any EuiSuperSelect without extra
+   * test hooks and is the preferred method when the value is a stable code
+   * constant.
+   */
+  async selectOptionByValue(value) {
+    await this.open();
+    await this.listbox.locator(_selectors.EuiSuperSelectSelectors.optionByValue(value)).click();
+    await this.listbox.waitFor({
+      state: 'detached'
+    });
+  }
+
+  /**
+   * Selects an option by its visible label. Use for dynamic, data-driven
+   * option content where the value is not known to the test. Note the dropdown
+   * shows `dropdownDisplay` when the consumer provides it, which can differ
+   * from the committed `inputDisplay` text.
+   */
+  async selectOptionByLabel(label) {
+    await this.open();
+    await this.listbox.getByRole('option', {
+      name: label
+    }).click();
+    await this.listbox.waitFor({
+      state: 'detached'
+    });
+  }
+
+  /**
+   * 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).
+   */
+  async getSelectedValue() {
+    return this.hiddenInput.inputValue();
+  }
+
+  /** Opens the dropdown if it is not already open. */
+  async open() {
+    if (await this.listbox.isVisible()) {
+      return;
+    }
+    await this.root.click();
+    await this.listbox.waitFor({
+      state: 'visible'
+    });
+  }
+  get listbox() {
+    return this.root.page().locator(_selectors.EuiSuperSelectSelectors.LISTBOX_SELECTOR);
+  }
+
+  /**
+   * The hidden input is a sibling of the control button; reach it through the
+   * `.euiSuperSelect` popover wrapper that contains this instance's button.
+   */
+  get hiddenInput() {
+    return this.scope.locator(_selectors.EuiSuperSelectSelectors.WRAPPER_SELECTOR).filter({
+      has: this.root
+    }).locator(_selectors.EuiSuperSelectSelectors.HIDDEN_INPUT_SELECTOR);
+  }
+}
+exports.EuiSuperSelectObject = EuiSuperSelectObject;

package/lib/cjs/playwright/components/toast/object.d.ts

@@ -0,0 +1,24 @@
+import { type Locator } from '@playwright/test';
+import { BaseObject, type ObjectScope } from '../../base_object';
+/**
+ * Playwright Component Object for {@link
+ * https://eui.elastic.co/docs/components/display/toast/ EuiGlobalToastList}.
+ *
+ * `testSubj` must match the `data-test-subj` set by the consumer on the
+ * `<EuiGlobalToastList>` (the `.euiGlobalToastList` element). Toasts rendered
+ * outside the list (inline `EuiToast`) are not covered.
+ */
+export declare class EuiGlobalToastListObject extends BaseObject {
+    constructor(scope: ObjectScope, testSubj: string);
+    /**
+     * The toasts currently in the list. Exposed as a `Locator` so callers keep
+     * Playwright auto-retry for count and content assertions
+     * (e.g. `expect(toasts).toHaveCount(1)`).
+     */
+    get toasts(): Locator;
+    /**
+     * Closes every toast in the list and waits until none remain. No-op when the
+     * list is empty (dismissing "if present" is a common teardown need).
+     */
+    closeAll(): Promise<void>;
+}

package/lib/cjs/playwright/components/toast/object.js

@@ -0,0 +1,55 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.EuiGlobalToastListObject = void 0;
+var _test = require("@playwright/test");
+var _base_object = require("../../base_object");
+var _selectors = require("../../../components/toast/selectors");
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+/**
+ * Playwright Component Object for {@link
+ * https://eui.elastic.co/docs/components/display/toast/ EuiGlobalToastList}.
+ *
+ * `testSubj` must match the `data-test-subj` set by the consumer on the
+ * `<EuiGlobalToastList>` (the `.euiGlobalToastList` element). Toasts rendered
+ * outside the list (inline `EuiToast`) are not covered.
+ */
+class EuiGlobalToastListObject extends _base_object.BaseObject {
+  constructor(scope, testSubj) {
+    super(scope, testSubj, _selectors.EuiGlobalToastListSelectors.ROOT_SELECTOR);
+  }
+
+  /**
+   * The toasts currently in the list. Exposed as a `Locator` so callers keep
+   * Playwright auto-retry for count and content assertions
+   * (e.g. `expect(toasts).toHaveCount(1)`).
+   */
+  get toasts() {
+    return this.root.locator(_selectors.EuiGlobalToastListSelectors.TOAST_SELECTOR);
+  }
+
+  /**
+   * Closes every toast in the list and waits until none remain. No-op when the
+   * list is empty (dismissing "if present" is a common teardown need).
+   */
+  async closeAll() {
+    const closeButtons = await this.root.getByTestId(_selectors.EuiGlobalToastListSelectors.CLOSE_BUTTON_TEST_SUBJ).all();
+    for (const closeButton of closeButtons) {
+      // A toast may auto-dismiss while iterating; ignore clicks that miss.
+      await closeButton.click({
+        timeout: 5_000
+      }).catch(() => {});
+    }
+    await (0, _test.expect)(this.toasts).toHaveCount(0);
+  }
+}
+exports.EuiGlobalToastListObject = EuiGlobalToastListObject;

package/lib/cjs/selectors.d.ts

@@ -1 +1,4 @@
 export { EuiComboBoxSelectors } from './components/combo_box/selectors';
+export { EuiDataGridSelectors } from './components/datagrid/selectors';
+export { EuiSuperSelectSelectors } from './components/form/super_select/selectors';
+export { EuiGlobalToastListSelectors } from './components/toast/selectors';