@elastic/eui-test-helpers 2.2.0 → 2.3.0

package/lib/esm/selectors.js

@@ -8,6 +8,7 @@
 import { EuiAccordionSelectors } from './components/accordion/selectors';
 import { EuiBasicTableSelectors } from './components/basic_table/selectors';
 import { EuiCallOutSelectors } from './components/call_out/selectors';
+import { EuiCardSelectors } from './components/card/selectors';
 import { EuiColorPickerSelectors } from './components/color_picker/selectors';
 import { EuiComboBoxSelectors } from './components/combo_box/selectors';
 import { EuiContextMenuSelectors } from './components/context_menu/selectors';
@@ -16,6 +17,7 @@ import { EuiDraggableSelectors } from './components/drag_and_drop/selectors';
 import { EuiFieldSearchSelectors } from './components/form/field_search/selectors';
 import { EuiFilterButtonSelectors } from './components/filter_button/selectors';
 import { EuiFlyoutSelectors } from './components/flyout/selectors';
+import { EuiMarkdownEditorSelectors } from './components/markdown_editor/selectors';
 import { EuiModalSelectors } from './components/modal/selectors';
 import { EuiPaginationSelectors } from './components/pagination/selectors';
 import { EuiPopoverSelectors } from './components/popover/selectors';
@@ -25,6 +27,7 @@ import { EuiSelectableSelectors } from './components/selectable/selectors';
 import { EuiSideNavSelectors } from './components/side_nav/selectors';
 import { EuiSuperSelectSelectors } from './components/form/super_select/selectors';
 import { EuiTableSelectors } from './components/table/selectors';
+import { EuiTabsSelectors } from './components/tabs/selectors';
 import { EuiGlobalToastListSelectors } from './components/toast/selectors';
 import { EuiToolTipSelectors } from './components/tool_tip/selectors';
 import { EuiTreeViewSelectors } from './components/tree_view/selectors';
@@ -38,6 +41,7 @@ export const selectors = {
     accordion: EuiAccordionSelectors,
     basicTable: EuiBasicTableSelectors,
     callOut: EuiCallOutSelectors,
+    card: EuiCardSelectors,
     colorPicker: EuiColorPickerSelectors,
     comboBox: EuiComboBoxSelectors,
     contextMenu: EuiContextMenuSelectors,
@@ -46,6 +50,7 @@ export const selectors = {
     fieldSearch: EuiFieldSearchSelectors,
     filterButton: EuiFilterButtonSelectors,
     flyout: EuiFlyoutSelectors,
+    markdownEditor: EuiMarkdownEditorSelectors,
     modal: EuiModalSelectors,
     pagination: EuiPaginationSelectors,
     popover: EuiPopoverSelectors,
@@ -55,6 +60,7 @@ export const selectors = {
     sideNav: EuiSideNavSelectors,
     superSelect: EuiSuperSelectSelectors,
     table: EuiTableSelectors,
+    tabs: EuiTabsSelectors,
     globalToastList: EuiGlobalToastListSelectors,
     toolTip: EuiToolTipSelectors,
     treeView: EuiTreeViewSelectors,

package/lib/esm/selectors.js.map

@@ -1 +1 @@
-{"version":3,"file":"selectors.js","sourceRoot":"","sources":["../../src/selectors.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAE,qBAAqB,EAAE,MAAM,kCAAkC,CAAC;AACzE,OAAO,EAAE,sBAAsB,EAAE,MAAM,oCAAoC,CAAC;AAC5E,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AACtE,OAAO,EAAE,uBAAuB,EAAE,MAAM,qCAAqC,CAAC;AAC9E,OAAO,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AACxE,OAAO,EAAE,uBAAuB,EAAE,MAAM,qCAAqC,CAAC;AAC9E,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AACvE,OAAO,EAAE,qBAAqB,EAAE,MAAM,sCAAsC,CAAC;AAC7E,OAAO,EAAE,uBAAuB,EAAE,MAAM,0CAA0C,CAAC;AACnF,OAAO,EAAE,wBAAwB,EAAE,MAAM,sCAAsC,CAAC;AAChF,OAAO,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,EAAE,sBAAsB,EAAE,MAAM,mCAAmC,CAAC;AAC3E,OAAO,EAAE,mBAAmB,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,EAAE,iBAAiB,EAAE,MAAM,mCAAmC,CAAC;AACtE,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC1E,OAAO,EAAE,sBAAsB,EAAE,MAAM,mCAAmC,CAAC;AAC3E,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AACtE,OAAO,EAAE,uBAAuB,EAAE,MAAM,0CAA0C,CAAC;AACnF,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,EAAE,2BAA2B,EAAE,MAAM,8BAA8B,CAAC;AAC3E,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AACtE,OAAO,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AAExE;;;;;GAKG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG;IACvB,SAAS,EAAE,qBAAqB;IAChC,UAAU,EAAE,sBAAsB;IAClC,OAAO,EAAE,mBAAmB;IAC5B,WAAW,EAAE,uBAAuB;IACpC,QAAQ,EAAE,oBAAoB;IAC9B,WAAW,EAAE,uBAAuB;IACpC,QAAQ,EAAE,oBAAoB;IAC9B,SAAS,EAAE,qBAAqB;IAChC,WAAW,EAAE,uBAAuB;IACpC,YAAY,EAAE,wBAAwB;IACtC,MAAM,EAAE,kBAAkB;IAC1B,KAAK,EAAE,iBAAiB;IACxB,UAAU,EAAE,sBAAsB;IAClC,OAAO,EAAE,mBAAmB;IAC5B,KAAK,EAAE,iBAAiB;IACxB,SAAS,EAAE,qBAAqB;IAChC,UAAU,EAAE,sBAAsB;IAClC,OAAO,EAAE,mBAAmB;IAC5B,WAAW,EAAE,uBAAuB;IACpC,KAAK,EAAE,iBAAiB;IACxB,eAAe,EAAE,2BAA2B;IAC5C,OAAO,EAAE,mBAAmB;IAC5B,QAAQ,EAAE,oBAAoB;CACtB,CAAC"}
+{"version":3,"file":"selectors.js","sourceRoot":"","sources":["../../src/selectors.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAE,qBAAqB,EAAE,MAAM,kCAAkC,CAAC;AACzE,OAAO,EAAE,sBAAsB,EAAE,MAAM,oCAAoC,CAAC;AAC5E,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AACtE,OAAO,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AAC/D,OAAO,EAAE,uBAAuB,EAAE,MAAM,qCAAqC,CAAC;AAC9E,OAAO,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AACxE,OAAO,EAAE,uBAAuB,EAAE,MAAM,qCAAqC,CAAC;AAC9E,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AACvE,OAAO,EAAE,qBAAqB,EAAE,MAAM,sCAAsC,CAAC;AAC7E,OAAO,EAAE,uBAAuB,EAAE,MAAM,0CAA0C,CAAC;AACnF,OAAO,EAAE,wBAAwB,EAAE,MAAM,sCAAsC,CAAC;AAChF,OAAO,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,EAAE,0BAA0B,EAAE,MAAM,wCAAwC,CAAC;AACpF,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,EAAE,sBAAsB,EAAE,MAAM,mCAAmC,CAAC;AAC3E,OAAO,EAAE,mBAAmB,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,EAAE,iBAAiB,EAAE,MAAM,mCAAmC,CAAC;AACtE,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC1E,OAAO,EAAE,sBAAsB,EAAE,MAAM,mCAAmC,CAAC;AAC3E,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AACtE,OAAO,EAAE,uBAAuB,EAAE,MAAM,0CAA0C,CAAC;AACnF,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AAC/D,OAAO,EAAE,2BAA2B,EAAE,MAAM,8BAA8B,CAAC;AAC3E,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AACtE,OAAO,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AAExE;;;;;GAKG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG;IACvB,SAAS,EAAE,qBAAqB;IAChC,UAAU,EAAE,sBAAsB;IAClC,OAAO,EAAE,mBAAmB;IAC5B,IAAI,EAAE,gBAAgB;IACtB,WAAW,EAAE,uBAAuB;IACpC,QAAQ,EAAE,oBAAoB;IAC9B,WAAW,EAAE,uBAAuB;IACpC,QAAQ,EAAE,oBAAoB;IAC9B,SAAS,EAAE,qBAAqB;IAChC,WAAW,EAAE,uBAAuB;IACpC,YAAY,EAAE,wBAAwB;IACtC,MAAM,EAAE,kBAAkB;IAC1B,cAAc,EAAE,0BAA0B;IAC1C,KAAK,EAAE,iBAAiB;IACxB,UAAU,EAAE,sBAAsB;IAClC,OAAO,EAAE,mBAAmB;IAC5B,KAAK,EAAE,iBAAiB;IACxB,SAAS,EAAE,qBAAqB;IAChC,UAAU,EAAE,sBAAsB;IAClC,OAAO,EAAE,mBAAmB;IAC5B,WAAW,EAAE,uBAAuB;IACpC,KAAK,EAAE,iBAAiB;IACxB,IAAI,EAAE,gBAAgB;IACtB,eAAe,EAAE,2BAA2B;IAC5C,OAAO,EAAE,mBAAmB;IAC5B,QAAQ,EAAE,oBAAoB;CACtB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elastic/eui-test-helpers",
-  "version": "2.2.0",
+  "version": "2.3.0",
   "description": "A library of EUI test helpers for RTL, Cypress and Scout",
   "license": "SEE LICENSE IN LICENSE.txt",
   "repository": {

package/src/components/card/README.md

@@ -0,0 +1,30 @@
+# EuiCardObject
+
+Playwright Component Object for [EuiCard](https://eui.elastic.co/docs/components/display/card/).
+
+## Usage
+
+```ts
+import { EuiCardObject } from '@elastic/eui-test-helpers';
+
+const card = new EuiCardObject(page, 'myCard');
+expect(await card.getTitle()).toBe('Logs');
+await card.click();
+```
+
+Set `data-test-subj` on `<EuiCard>`. EUI spreads it onto the panel, which the component-type guard verifies.
+
+## API
+
+| Member | Description |
+|---|---|
+| `selectButton` | `Locator` for the `selectable` toggle button, absent on plain cards. |
+| `getTitle()` | The title text. |
+| `getDescription()` | The description text, or `null` when the card has none. |
+| `click()` | Click the card, which follows `href` or fires `onClick`. |
+| `isSelected()` | Whether the `selectable` toggle is checked. |
+| `toggleSelected()` | Click the `selectable` toggle and wait for it to flip. |
+
+## Deliberately excluded
+
+`children`, `footer`, `betaBadgeProps` and `icon`. They are consumer content, so assert on them through `locator`. `EuiCheckableCard` is a different component built on a radio or checkbox.

package/src/components/markdown_editor/README.md

@@ -0,0 +1,30 @@
+# EuiMarkdownEditorObject
+
+Playwright Component Object for [EuiMarkdownEditor](https://eui.elastic.co/docs/components/editors-and-syntax/markdown-editor/).
+
+## Usage
+
+```ts
+import { EuiMarkdownEditorObject } from '@elastic/eui-test-helpers';
+
+const editor = new EuiMarkdownEditorObject(page, 'myEditor');
+await editor.setValue('# Hello');
+expect(await editor.getValue()).toBe('# Hello');
+```
+
+Set `data-test-subj` on `<EuiMarkdownEditor>`. EUI spreads it onto the wrapper, which the component-type guard verifies.
+
+## API
+
+| Member | Description |
+|---|---|
+| `textArea` | `Locator` for the `<textarea>` holding the markdown source. |
+| `preview` | `Locator` for the rendered markdown, only in the DOM while previewing. |
+| `setValue(text)` | Replace the markdown source. Switches back to editing first if needed. |
+| `getValue()` | The current markdown source. |
+| `isPreviewing()` | Whether the rendered preview is shown instead of the textarea. |
+| `togglePreview()` | Switch between the textarea and the rendered preview. |
+
+## Deliberately excluded
+
+The formatting toolbar buttons and the drop zone. They are consumer facing (`toolbarProps`, `uiPlugins`, `dropHandlers`), so drive them with `locator` and the `euiMarkdownEditorToolbarButton*` test subjects EUI sets.

package/src/components/tabs/README.md

@@ -0,0 +1,29 @@
+# EuiTabsObject
+
+Playwright Component Object for [EuiTabs](https://eui.elastic.co/docs/components/navigation/tabs/). Also covers `EuiTabbedContent`, which renders an `EuiTabs` as the first child of the element carrying your `data-test-subj`.
+
+## Usage
+
+```ts
+import { EuiTabsObject } from '@elastic/eui-test-helpers';
+
+const tabs = new EuiTabsObject(page, 'myTabs');
+await tabs.select('Documents');
+expect(await tabs.getSelected()).toBe('Documents');
+```
+
+Set `data-test-subj` on `<EuiTabs>` or `<EuiTabbedContent>`. Tabs are addressed by their exact label.
+
+## API
+
+| Member | Description |
+|---|---|
+| `tabs` | `Locator` for all tabs, in order. |
+| `getTabs()` | The labels of all tabs, in order. |
+| `tab(label)` | `Locator` for the tab with exactly this label. Matches the label span, so `prepend` and `append` content does not interfere. |
+| `select(label)` | Click the tab and wait for it to become selected. |
+| `getSelected()` | The label of the selected tab, or `null`. |
+
+## Deliberately excluded
+
+Tab panels. `EuiTabbedContent` renders one `role="tabpanel"` for the selected tab, and bare `EuiTabs` consumers render content themselves, so assert on that content directly.