@fkui/vue 6.9.0 → 6.11.0

package/dist/types/cypress.d.ts

@@ -398,11 +398,14 @@ export declare class FFormModalPageObject extends FModalPageObject implements Ba
  */
 export declare class FInteractiveTablePageObject implements BasePageObject {
     selector: string;
-    el: () => DefaultCypressChainable;
     /**
-     * @param selector - table selector.
+     * @param selector - root element selector for `FInteractiveTable`, usually `.table`.
      */
-    constructor(selector: string);
+    constructor(selector?: string);
+    /**
+     * Get root element.
+     */
+    el(): DefaultCypressChainable;
     /**
      * Get table cell (typically `<td>` but can be `<th>` if row headers are
      * present).
@@ -427,19 +430,85 @@ export declare class FInteractiveTablePageObject implements BasePageObject {
         row: number;
         col: number;
     }): Cypress.Chainable<JQuery<HTMLTableCellElement>>;
+    /**
+     * Get `<caption>` element.
+     */
     caption(): DefaultCypressChainable;
-    bodyRow(): DefaultCypressChainable;
-    row(index: number): DefaultCypressChainable;
+    /**
+     * Get table header cell (`<th>` in `<thead>`).
+     *
+     * Neither the marker for expandable rows or the checkbox for selectable
+     * rows are included in the column count, i.e. `1` always refers to the
+     * first column with content.
+     *
+     * @public
+     * @param col - column number of header (1-indexed).
+     * @returns The header cell element.
+     */
+    header(col: number): Cypress.Chainable<JQuery<HTMLTableCellElement>>;
+    /**
+     * Get all table headers (`<th>` in `<thead>`).
+     *
+     * Includes the headers for checkboxes in selectable rows and markers in expandable rows.
+     */
     headersRow(): DefaultCypressChainable;
     /**
-     * Hämta page object för specifikt Table row item.
+     * Get row (`<tr>` in `<tbody>`) of given index.
+     *
+     * Includes expandable rows even if not expanded.
+     *
+     * @param index - Row number (0-indexed).
      */
-    columnItem(index: number): FTableColumnPageObject;
+    row(index: number): DefaultCypressChainable;
     /**
-     * Hämta page object för specifikt Header row item.
+     * Get all table body rows (`<tr>` in `<tbody>`).
+     *
+     * Includes expandable rows even if not expanded.
+     */
+    bodyRow(): DefaultCypressChainable;
+    /**
+     * Get page object with selector for the checkbox in given row.
+     *
+     * For expandable rows the row count depend on whenever a row is expanded or
+     * not. If the first row is collapsed the second row refers to the next
+     * parent row while if the first row is expanded the second row refers to
+     * the first expanded row under the first row.
+     *
+     * Requires a `selectable` table.
+     *
+     * @public
+     * @param row - Row number (1-indexed).
+     * @returns Page object for `FCheckboxField`.
+     */
+    checkbox(row: number): FCheckboxFieldPageObject;
+    /**
+     * Get sort order icon in given column.
+     *
+     * Index includes the columns for checkboxes in selectable rows and markers in expandable rows.
+     *
+     * @param index - Column index (0-indexed).
+     * @param order - Column sort order.
+     * @returns icon of given sort order.
      */
-    headerRowItem(): FTableColumnPageObject;
     getColumnSortedByIcon(index: number, order: "ascending" | "descending" | "unsorted"): DefaultCypressChainable;
+    /**
+     * Get page object for `FTableColumn` with selector targeting the header row.
+     *
+     * @deprecated Use `header()` instead. Deprecated since v6.11.0.
+     * @returns Page object for `FTableColumn`.
+     */
+    headerRowItem(): FTableColumnPageObject;
+    /**
+     * Get page object for `FTableColumn` with selector targeting the given row number.
+     *
+     * Index includes the header row (index 0 selects the header row while 1 selects first row in table body).
+     * Index ignores expandable rows.
+     *
+     * @deprecated Use `cell()` for body content and `header()` for header content instead. Deprecated since v6.11.0.
+     * @param index - Row number (0-indexed).
+     * @returns Page object for `FTableColumn`.
+     */
+    columnItem(index: number): FTableColumnPageObject;
 }
 
 /**
@@ -832,14 +901,24 @@ export declare class FStaticFieldPageObject implements BasePageObject {
 
 /**
  * @public
+ * @deprecated Use methods on `FInteractiveTable` instead. Deprecated since v6.11.0.
  */
 export declare class FTableColumnPageObject implements BasePageObject {
     selector: string;
     el: () => DefaultCypressChainable;
     index: number;
     constructor(selector: string, index: number);
+    /**
+     * @deprecated Use ´FInteractiveTablePageObject.cell()´ instead. Deprecated since v6.11.0.
+     */
     tableRowBodyContent(position: number): DefaultCypressChainable;
+    /**
+     * @deprecated Use ´FInteractiveTablePageObject.header()´ instead. Deprecated since v6.11.0.
+     */
     tableRowHeaderContent(): DefaultCypressChainable;
+    /**
+     * @deprecated Use ´FInteractiveTablePageObject.checkbox()´ instead. Deprecated since v6.11.0.
+     */
     checkbox(): FCheckboxFieldPageObject;
 }