@atomic-testing/component-driver-mui-x-v8 0.58.0

package/src/components/datagrid/DataGridRowDriverBase.ts

@@ -0,0 +1,72 @@
+import { HTMLElementDriver } from '@atomic-testing/component-driver-html';
+import { byAttribute, ComponentDriver, listHelper, locatorUtil, PartLocator } from '@atomic-testing/core';
+
+// In MUI7, there is an extra div preceding the actual data cells. We need to skip it.
+const columnStartingIndex = 1;
+
+/**
+ * Base class for data grid row
+ */
+export abstract class DataGridRowDriverBase extends ComponentDriver {
+  protected async getCellCount(): Promise<number> {
+    let count = 0;
+    for await (const _ of listHelper.getListItemIterator(
+      this,
+      this.getCellLocator(),
+      HTMLElementDriver,
+      columnStartingIndex
+    )) {
+      count++;
+    }
+    return count;
+  }
+
+  /**
+   * Get the text of each visible cell in the row.
+   * Caveat: Because of virtualization, the text of the cell may not be available until the cell is visible.
+   * @returns A promise array of text of each visible cell in the row
+   */
+  async getRowText(): Promise<string[]> {
+    const textList: string[] = [];
+    for await (const cell of listHelper.getListItemIterator(
+      this,
+      this.getCellLocator(),
+      HTMLElementDriver,
+      columnStartingIndex
+    )) {
+      const text = await cell.getText();
+      textList.push(text!.trim());
+    }
+    return textList;
+  }
+
+  /**
+   * Get the cell driver at the specified index or data field.
+   * Caveat: Because of virtualization, the cell may not be available until the cell is visible.
+   * @param cellIndexOrField number: column index, string: column field
+   * @param driverClass The driver class of the cell. Default is HTMLElementDriver
+   * @returns A promise of the cell driver, or null if the cell is not found
+   */
+  async getCell<DriverT extends ComponentDriver>(
+    cellIndexOrField: number | string, // number: column index, string: column field
+    // @ts-ignore
+    driverClass: typeof ComponentDriver = HTMLElementDriver
+  ): Promise<DriverT | null> {
+    let cellLocator: PartLocator;
+    if (typeof cellIndexOrField === 'number') {
+      cellLocator = byAttribute('data-colindex', cellIndexOrField.toString());
+    } else {
+      cellLocator = byAttribute('data-field', cellIndexOrField);
+    }
+    const locator = locatorUtil.append(this.locator, cellLocator);
+    const cellExists = await this.interactor.exists(locator);
+    if (cellExists) {
+      // @ts-ignore
+      return new driverClass(locator, this.interactor, this.commutableOption);
+    }
+
+    return null;
+  }
+
+  protected abstract getCellLocator(): PartLocator;
+}

package/src/components/datagrid/index.ts

@@ -0,0 +1,4 @@
+export * from './DataGridCellQuery';
+export { DataGridDataRowDriver } from './DataGridDataRowDriver';
+export { DataGridHeaderRowDriver } from './DataGridHeaderRowDriver';
+export { DataGridProDriver } from './DataGridProDriver';

package/src/index.ts

@@ -0,0 +1 @@
+export * from './components/datagrid';