@vuu-ui/vuu-playwright-helpers 4.0.0-beta.6 → 4.0.0

package/types/PwTableHeaderCell.d.ts

@@ -1,8 +1,55 @@
 import { type Page } from "@playwright/test";
-import { PlaywrightPageObject } from "./PlaywrightPageObject";
-export declare class PwTableHeaderCell extends PlaywrightPageObject {
-    private readonly cssSelector;
-    constructor(page: Page, cssSelector: string);
+import { PwComponent, type PwComponentTarget } from "./PwComponent";
+import { PwContextMenu } from "./PwContextMenu";
+/**
+ * A Table column header cell. Usually obtained from PwTable.headerCell.
+ *
+ * @example
+ * test("currency header", async ({ page }) => {
+ *   const header = new PwTable(page).headerCell("currency");
+ *   await expect(header.locator).toHaveText("Currency");
+ * });
+ */
+export declare class PwTableHeaderCell extends PwComponent {
+    protected readonly defaultCssSelector = ".vuuTableHeaderCell";
+    /**
+     * @param page the Playwright page
+     * @param target css selector or Locator for the header cell
+     */
+    constructor(page: Page, target: PwComponentTarget);
+    /**
+     * Does the header cell have the selected class. Does not wait or retry,
+     * use assertSelected after an action that selects the column.
+     *
+     * @example
+     * test("no column initially selected", async ({ page }) => {
+     *   const table = new PwTable(page);
+     *   expect(await table.headerCell("currency").isSelected).toBe(false);
+     * });
+     */
     get isSelected(): Promise<boolean>;
+    /**
+     * Assert the header cell is selected, retrying until the expect timeout.
+     *
+     * @example
+     * test("column is selected", async ({ page }) => {
+     *   const table = new PwTable(page);
+     *   // ...select the currency column
+     *   await table.headerCell("currency").assertSelected();
+     * });
+     */
     assertSelected(): Promise<void>;
+    /**
+     * Click the column menu button in the header cell. Resolves with the column
+     * menu once it is visible.
+     *
+     * @example
+     * test("remove column from column menu", async ({ page }) => {
+     *   const table = new PwTable(page);
+     *   const menu = await table.headerCell("exchange").showColumnMenu();
+     *   await menu.menuItem("Remove exchange column").click();
+     *   await table.assertColumns(["bbg", "currency"]);
+     * });
+     */
+    showColumnMenu(): Promise<PwContextMenu>;
 }

package/types/index.d.ts

@@ -1,3 +1,10 @@
 export { PlaywrightPageObject } from "./PlaywrightPageObject";
-export { PwTable } from "./PwTable";
+export { PwChart } from "./PwChart";
+export { type ChartDataPointInfo, PwChartDataPoint } from "./PwChartDataPoint";
+export { PwColumnPicker } from "./PwColumnPicker";
+export { PwComponent, type PwComponentTarget } from "./PwComponent";
+export { PwContextMenu } from "./PwContextMenu";
+export { PwMenuItem } from "./PwMenuItem";
+export { PwTable, type ScrollDistance, type ScrollPosition, type VerticalScrollDistance, } from "./PwTable";
+export { PwTableFooter } from "./PwTableFooter";
 export { PwTableHeaderCell } from "./PwTableHeaderCell";

package/types/selector-utils.d.ts

@@ -0,0 +1,3 @@
+export declare const cssAttributeValue: (value: string) => string;
+export declare const byDataIcon: (iconName: string) => string;
+export declare const byId: (id: string) => string;