@fkui/vue-labs 6.43.1 → 6.44.0

package/dist/types/cypress.d.ts

@@ -11,166 +11,6 @@ declare interface BasePageObject {
 
 declare type DefaultCypressChainable = Cypress.Chainable<JQuery>;
 
-/**
- * @public
- * @since v6.24.0
- */
-export declare class FTablePageObject implements BasePageObject {
-    selector: string;
-    private readonly selectHeader;
-    private readonly columnTitle;
-    private readonly columnDescription;
-    private readonly expandCell;
-    private readonly selectCell;
-    /**
-     * @param selector - root element selector for `FTable`, usually `.table-ng`.
-     */
-    constructor(selector?: string);
-    /**
-     * Get root element.
-     *
-     * @public
-     */
-    el(): DefaultCypressChainable;
-    /**
-     * Get table header cell (`<th>` in `<thead>`).
-     *
-     * The headers for expandable buttons and selectable checkboxes are included.
-     *
-     * @public
-     * @param col - Column number of header (1-indexed).
-     * @returns The header cell element (`<th>`).
-     */
-    header(col: number): Cypress.Chainable<JQuery<HTMLTableCellElement>>;
-    /**
-     * Get column title from table header.
-     *
-     * The headers for expandable buttons and selectable checkboxes are included.
-     *
-     * @public
-     * @param col - Column number of header (1-indexed).
-     * @returns Column description in header.
-     */
-    headerTitle(col: number): DefaultCypressChainable;
-    /**
-     * Get column description from table header.
-     *
-     * The headers for expandable buttons and selectable checkboxes are included.
-     *
-     * @public
-     * @param col - Column number of header (1-indexed).
-     * @returns Column description in header.
-     */
-    headerDescription(col: number): DefaultCypressChainable;
-    /**
-     * Get table cell (typically `<td>` but can be `<th>` if row headers are
-     * present).
-     *
-     * Both row and column are 1-indexed, i.e. 1:1 selects the first cell in the
-     * first row.
-     *
-     * The columns for expandable buttons and selectable checkboxes are included in column count.
-     *
-     * 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.
-     *
-     * @public
-     * @param descriptor - Row and column number of cell (1-indexed).
-     * @returns The cell element.
-     */
-    cell(descriptor: {
-        row: number;
-        col: number;
-    }): Cypress.Chainable<JQuery<HTMLTableCellElement>>;
-    /**
-     * Get expand button of given row.
-     *
-     * Only applicable if using an expandable table.
-     *
-     * @public
-     * @param row - Row number for the expand button (1-indexed).
-     * @returns Expand button of given row.
-     */
-    expandButton(row: number): Cypress.Chainable<JQuery<HTMLButtonElement>>;
-    /**
-     * Get checkbox in the table header for selectable column.
-     *
-     * Only applicable if using a multiselect table.
-     *
-     * @public
-     * @returns Checkbox in selectable column header.
-     */
-    selectHeaderInput(): Cypress.Chainable<JQuery<HTMLInputElement>>;
-    /**
-     * Get select input of given row.
-     *
-     * Only applicable if using a selectable table.
-     * Input is a checkbox if using a multiselect table and radio if single.
-     *
-     * @param row - Row number for the select input (1-indexed).
-     * @returns Select input of given row.
-     */
-    selectInput(row: number): Cypress.Chainable<JQuery<HTMLInputElement>>;
-    /* Excluded from this release type: contextmenu */
-    /**
-     * Get the menu items of the currently open context menu.
-     *
-     * The context menu must have been opened for this to return an element.
-     *
-     * @public
-     * @returns The context menu items.
-     */
-    contextmenuItems(): Cypress.Chainable<JQuery<HTMLButtonElement>>;
-    /* Excluded from this release type: selectDropdown */
-    /**
-     * Get an option in a select cell dropdown.
-     *
-     * Only applicable if using a select cell.
-     *
-     * Element is teleported and does not use given selector. Method may
-     * not work properly if there are several dropdowns open simultaneously.
-     *
-     * @public
-     * @param option - option number (1-indexed).
-     * @returns Option of given number from a select cell dropdown.
-     */
-    selectDropdownOption(option: number): DefaultCypressChainable;
-    /**
-     * Get table caption.
-     *
-     * Only applicable if caption slot is used.
-     *
-     * @public
-     * @returns The table caption.
-     */
-    caption(): Cypress.Chainable<JQuery<HTMLTableSectionElement>>;
-    /**
-     * Get table footer.
-     *
-     * Only applicable if footer slot is used.
-     *
-     * @public
-     * @returns The table footer.
-     */
-    footer(): Cypress.Chainable<JQuery<HTMLTableSectionElement>>;
-    /* Excluded from this release type: tabbableElement */
-    /**
-     * Get all visible rows (`<tr>` in `<tbody>`).
-     *
-     * Includes expanded rows if table is expandable.
-     *
-     * @public
-     * @returns All visible rows in the table.
-     */
-    rows(): Cypress.Chainable<JQuery<HTMLTableRowElement>>;
-    /* Excluded from this release type: bodyRow */
-    /* Excluded from this release type: thead */
-    /* Excluded from this release type: tbody */
-    /* Excluded from this release type: tfoot */
-}
-
 /**
  * @public
  */

package/dist/types/index.d.ts

@@ -1,84 +1,27 @@
-import { Component } from 'vue';
 import { ComponentOptions } from 'vue';
 import { ComponentOptionsMixin } from 'vue';
 import { ComponentProvideOptions } from 'vue';
-import { Dataset } from '@fkui/vue';
-import { DatasetNestedKeyOf } from '@fkui/vue';
 import { DefineComponent } from 'vue';
 import { ExtractPropTypes } from 'vue';
 import { FormatFunction } from '@fkui/vue';
-import { HTMLAttributes } from 'vue';
 import { IPopupErrorData } from '@fkui/vue';
-import { MaybeRef } from 'vue';
 import { ParseFunction } from '@fkui/vue';
 import { PropType } from 'vue';
 import { PublicProps } from 'vue';
 import { Ref } from 'vue';
-import { ShallowRef } from 'vue';
-import { ShallowUnwrapRef } from 'vue';
 import { UnwrapRefSimple } from '@vue/reactivity';
 import { ValidatorConfig } from '@fkui/logic';
-import { ValidatorConfigs } from '@fkui/logic';
 import { ValidityEvent } from '@fkui/logic';
 import { VNode } from 'vue';
 
 declare const __VLS_base: DefineComponent<    {}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
 
-declare const __VLS_export: <T extends object, KeyAttribute extends keyof T = keyof T>(__VLS_props: NonNullable<Awaited<typeof __VLS_setup>>["props"], __VLS_ctx?: __VLS_PrettifyLocal<Pick<NonNullable<Awaited<typeof __VLS_setup>>, "attrs" | "emit" | "slots">>, __VLS_exposed?: NonNullable<Awaited<typeof __VLS_setup>>["expose"], __VLS_setup?: Promise<{
-    props: PublicProps & __VLS_PrettifyLocal<({
-        columns: Array<TableColumn<T, KeyAttribute>>;
-        rows: Dataset<T>;
-        keyAttribute?: KeyAttribute;
-        /**
-         * Optional callback for setting classes on table rows (`<tr>` element).
-         */
-        rowClass?: (row: T) => HTMLAttributes["class"];
-        striped?: boolean;
-        disableDividers?: boolean;
-        selectable?: "single" | "multi";
-    } & {
-        selectedRows?: T[];
-    }) & {
-        "onUpdate:selectedRows"?: ((value: T[]) => any) | undefined;
-    }> & (typeof globalThis extends {
-        __VLS_PROPS_FALLBACK: infer P;
-    } ? P : {});
-    expose: (exposed: ShallowUnwrapRef<FTableApi>) => void;
-    attrs: any;
-    slots: {
-        /**
-         * Slot for table caption
-         */
-        caption?(): void;
-        /**
-         * Slot for content when table is empty
-         */
-        empty?(): void;
-        /**
-         * Slot for table footer
-         */
-        footer?(): void;
-        /**
-         * Slot for rendering custom expandable content
-         */
-        expandable?(bindings: {
-            /**
-             * The expanded row (from the dataset nested attribute of the parent row)
-             */
-            row: Required<T>[DatasetNestedKeyOf<T>] extends unknown[] ? Required<T>[DatasetNestedKeyOf<T>][number] : never;
-        }): void;
-    };
-    emit: (event: "update:selectedRows", value: T[]) => void;
-}>) => VNode & {
-    __ctx?: Awaited<typeof __VLS_setup>;
-};
+declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
 
-declare const __VLS_export_2: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
+declare const __VLS_export_2: DefineComponent<__VLS_Props, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
 
-declare const __VLS_export_3: DefineComponent<__VLS_Props, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
-
-declare const __VLS_export_4: <T>(__VLS_props: NonNullable<Awaited<typeof __VLS_setup>>["props"], __VLS_ctx?: __VLS_PrettifyLocal_2<Pick<NonNullable<Awaited<typeof __VLS_setup>>, "attrs" | "emit" | "slots">>, __VLS_exposed?: NonNullable<Awaited<typeof __VLS_setup>>["expose"], __VLS_setup?: Promise<{
-    props: PublicProps & __VLS_PrettifyLocal_2<{
+declare const __VLS_export_3: <T>(__VLS_props: NonNullable<Awaited<typeof __VLS_setup>>["props"], __VLS_ctx?: __VLS_PrettifyLocal<Pick<NonNullable<Awaited<typeof __VLS_setup>>, "attrs" | "emit" | "slots">>, __VLS_exposed?: NonNullable<Awaited<typeof __VLS_setup>>["expose"], __VLS_setup?: Promise<{
+    props: PublicProps & __VLS_PrettifyLocal<{
         data: T[];
         sort?(data: T[]): T[];
         filter?(data: T[]): T[];
@@ -101,7 +44,7 @@ declare const __VLS_export_4: <T>(__VLS_props: NonNullable<Awaited<typeof __VLS_
     __ctx?: Awaited<typeof __VLS_setup>;
 };
 
-declare const __VLS_export_5: DefineComponent<ExtractPropTypes<    {
+declare const __VLS_export_4: DefineComponent<ExtractPropTypes<    {
 formatter: {
 type: PropType<FormatFunction<HoursMinutesString>>;
 required: false;
@@ -221,7 +164,7 @@ resolveNewModelValue(viewValue: string): unknown;
 syncViewValueAfterModelUpdate(newModelValue: unknown): void | never;
 triggerComponentValidityEvent(validityEvent: ValidityEvent): void;
 setViewValueToFormattedValueOrFallbackToValue(): void;
-}, ComponentOptionsMixin, ComponentOptionsMixin, ("blur" | "change" | "update:modelValue")[], "blur" | "change" | "update:modelValue", PublicProps, Readonly<ExtractPropTypes<    {
+}, ComponentOptionsMixin, ComponentOptionsMixin, ("change" | "update:modelValue" | "blur")[], "change" | "update:modelValue" | "blur", PublicProps, Readonly<ExtractPropTypes<    {
 id: {
 type: StringConstructor;
 required: false;
@@ -282,8 +225,8 @@ modelValue: string | number | null;
 inline: boolean;
 options: string[] | undefined;
 labelWidth: string;
-formatter: FormatFunction<any>;
 parser: ParseFunction<any>;
+formatter: FormatFunction<any>;
 inputWidth: string;
 }, {}, {
 FLabel: DefineComponent<ExtractPropTypes<    {
@@ -591,12 +534,6 @@ declare type __VLS_PrettifyLocal<T> = (T extends any ? {
     [K in keyof T as K]: T[K];
 }) & {};
 
-declare type __VLS_PrettifyLocal_2<T> = (T extends any ? {
-    [K in keyof T]: T[K];
-} : {
-    [K in keyof T as K]: T[K];
-}) & {};
-
 declare type __VLS_Props = {
     /**
      * Unix timestamp in milliseconds.
@@ -620,16 +557,6 @@ declare type __VLS_WithSlots<T, S> = T & {
     };
 };
 
-/**
- * @public
- */
-export declare const baseTypes: readonly ["anchor", "button", "checkbox", "render", "rowheader", "select"];
-
-/**
- * @public
- */
-export declare function defineTableColumns<T, K extends keyof T = keyof T>(columns: Array<TableColumn<T, K>>): Array<TableColumn<T, K>>;
-
 /**
  * @public
  */
@@ -640,47 +567,6 @@ export declare function forgivingParseTimeToNumber(value?: string | null): numbe
  */
 export declare function formatNumberToTime(value?: number): HoursMinutesString | undefined;
 
-export declare const FTable: typeof __VLS_export;
-
-/**
- * {@link FTable} public api. Exposed in template reference.
- *
- * ```
- * const tableRef = useTemplateRef("table");
- * ```
- *
- * @public
- */
-export declare interface FTableApi {
-    /**
-     * Alters tabstop behaviour during action.
-     * Typically used during single row removal to put focus on cell nearby.
-     * Default behaviour is to reset tabstop on removal (focus on first cell).
-     */
-    withTabstopBehaviour(behaviour: "default" | "row-removal", action: () => void | Promise<void>): Promise<void>;
-}
-
-/**
- * {@link FTable} optional cell api. Expose in cell component.
- *
- * @public
- */
-export declare interface FTableCellApi {
-    /**
-     * Preferred tabstop element when other than default (`td`).
-     */
-    tabstopEl: Readonly<ShallowRef<HTMLElement | null>>;
-}
-
-/**
- * Get sortable attributes for use with `FSortFilterDataset`.
- *
- * @public
- * @since v6.41.0
- * @param columns - Table columns to get sortable attributes from.
- */
-export declare function getTableSortableAttributes(columns: MaybeSortableTableColumn[]): Record<PropertyKey, string | Readonly<Ref<string>>>;
-
 /**
  * @public
  */
@@ -711,41 +597,11 @@ export declare class HoursMinutesValidatorUtils {
     static getParserFromConfig(config?: ValidatorConfig): (viewValue: string | null | undefined) => number | undefined;
 }
 
-/**
- * @public
- */
-export declare type InputType = InputTypeBase | InputTypeNumber | InputTypeText;
-
-/**
- * @public
- */
-export declare type InputTypeBase = (typeof baseTypes)[number];
-
-/**
- * @public
- */
-export declare type InputTypeNumber = (typeof numberTypes)[number];
-
-/**
- * @public
- */
-export declare type InputTypeText = (typeof textTypes)[number];
-
 /**
  * @public
  */
 export declare function matchPropertyValue<T, K extends keyof T = keyof T>(property: K): (item: T, value: T[K] | null) => boolean;
 
-/**
- * @public
- * @since v6.41.0
- */
-export declare interface MaybeSortableTableColumn {
-    key?: PropertyKey;
-    header: string | Readonly<Ref<string>>;
-    sort?: boolean;
-}
-
 /**
  * Helper for converting AgeTimeTextField values into hours. For convienence,
  * it is possible to provide multiple values and get their sum. The actual
@@ -792,208 +648,27 @@ export declare function minutesToObject(...values: Array<number | undefined>): {
  */
 export declare function minutesToUserFriendlyString(value: number): string;
 
-/**
- * @public
- */
-export declare const numberTypes: readonly ["text:currency", "text:number", "text:percent"];
-
 /**
  * @public
  */
 export declare function parseTimeToNumber(value?: string | null): number | undefined;
 
-/**
- * Removes given row from the array.
- * If `expandableAttribute` is set it can removes rows from nested rows.
- *
- * @public
- * @since v6.34.1
- * @param rows - The row array
- * @param row - The row to remove (expected to exist in the row array)
- * @param expandableAttribute - If set, this function will search for and remove expandable rows the given row.
- * @returns A new array with row removed.
- */
-export declare function removeRow<T>(rows: T[], row: T, expandableAttribute?: keyof T): T[];
-
 /**
  * @public
  */
 export declare function splitHoursMinutes(valueString: string, extraForgiving?: boolean): string[];
 
-/**
- * @public
- */
-export declare type TableColumn<T, K extends keyof T = keyof T> = TableColumnSimple<T, K> | TableColumnCheckbox<T, K> | TableColumnRowHeader<T, K> | TableColumnText<T, K> | TableColumnNumber<T, K> | TableColumnAnchor<T, K> | TableColumnButton<T, K> | TableColumnRender<T, K> | TableColumnSelect<T, K> | TableColumnMenu<T>;
-
-/**
- * @public
- */
-export declare interface TableColumnAnchor<T, K extends keyof T> extends TableColumnBase {
-    type: "anchor";
-    key?: K;
-    text(this: void, row: T): string | null;
-    href: string;
-}
-
-/**
- * Base properties shared by all table column types.
- *
- * @public
- */
-export declare interface TableColumnBase {
-    header: string | Readonly<Ref<string>>;
-    description?: string | Readonly<Ref<string | null>>;
-    size?: TableColumnSize | Readonly<Ref<TableColumnSize | null>>;
-    sort?: boolean;
-    enabled?: MaybeRef<boolean>;
-}
-
-/**
- * @public
- */
-export declare interface TableColumnButton<T, K extends keyof T> extends TableColumnBase {
-    type: "button";
-    key?: K;
-    text(this: void, row: T): string | null;
-    onClick?(this: void, row: T): void;
-    icon?: string;
-    /**
-     * The icon library to use when rendering an icon. If not set, the default icon library will be used.
-     */
-    iconLibrary?: string;
-}
-
-/**
- * @public
- */
-export declare interface TableColumnCheckbox<T, K extends keyof T> extends TableColumnBase {
-    type: "checkbox";
-    key?: K;
-    label?(this: void, row: T): string;
-    checked?(this: void, row: T): boolean;
-    update?(this: void, row: T, newValue: boolean, oldValue: boolean): void;
-}
-
-/**
- * @public
- */
-export declare interface TableColumnMenu<T> extends TableColumnBase {
-    type: "menu";
-    text(this: void, row: T): string | null;
-    actions?: Array<{
-        label: string;
-        icon?: string;
-        onClick?(this: void, row: T): void;
-    }>;
-}
-
-/**
- * @public
- */
-export declare interface TableColumnNumber<T, K extends keyof T> extends TableColumnBase {
-    type: InputTypeNumber;
-    decimals?: number;
-    key?: K;
-    label?(this: void, row: T): string;
-    tnum?: boolean;
-    align?: "left" | "right";
-    attributes?: Record<string, string | number | boolean | undefined> | ((this: void, row: T) => Record<string, string | number | boolean | undefined>);
-    value?(this: void, row: T): string | number;
-    update?(this: void, row: T, newValue: number | string, oldValue: number | string): void;
-    editable?: boolean | ((this: void, row: T) => boolean);
-    validation?: ValidatorConfigs;
-    parser?(this: void, value: string): number | string | undefined;
-    formatter?(this: void, value: number | string): string | undefined;
-}
-
-/**
- * @public
- */
-export declare interface TableColumnRender<T, K extends keyof T = keyof T> extends TableColumnBase {
-    key?: K;
-    render(this: void, row: T): VNode | Component;
-}
-
-/**
- * @public
- */
-export declare interface TableColumnRowHeader<T, K extends keyof T> extends TableColumnBase {
-    type: "rowheader";
-    key?: K;
-    text?(this: void, row: T): string;
-}
-
-/**
- * @public
- */
-export declare interface TableColumnSelect<T, K extends keyof T> extends TableColumnBase {
-    type: "select";
-    key?: K;
-    label?(this: void, row: T): string;
-    selected?(this: void, row: T): string;
-    update?(this: void, row: T, newValue: string, oldValue: string): void;
-    editable?: boolean | ((this: void, row: T) => boolean);
-    options: string[];
-}
-
-/**
- * @public
- */
-export declare interface TableColumnSimple<T, K extends keyof T> extends TableColumnBase {
-    type?: undefined;
-    key?: K;
-    label?(this: void, row: T): string;
-    value?(this: void, row: T): string;
-}
-
-/**
- * @public
- */
-export declare type TableColumnSize = "grow" | "shrink";
-
-/**
- * @public
- */
-export declare interface TableColumnText<T, K extends keyof T> extends TableColumnBase {
-    type: InputTypeText;
-    key?: K;
-    label?(this: void, row: T): string;
-    tnum?: boolean;
-    align?: "left" | "right";
-    attributes?: Record<string, string | number | boolean | undefined> | ((this: void, row: T) => Record<string, string | number | boolean | undefined>);
-    value?(this: void, row: T): string;
-    update?(this: void, row: T, newValue: string, oldValue: string): void;
-    editable?: boolean | ((this: void, row: T) => boolean);
-    validation?: ValidatorConfigs;
-    parser?(this: void, value: string): string | undefined;
-    formatter?(this: void, value: string): string | undefined;
-}
-
-/* Excluded from this release type: TableColumnType */
-
-/**
- * @public
- */
-export declare const textTypes: readonly ["text:bankAccountNumber", "text:bankgiro", "text:clearingNumber", "text:date", "text:email", "text:organisationsnummer", "text:personnummer", "text:phoneNumber", "text:plusgiro", "text:postalCode", "text"];
-
 /**
  * @public
  */
 export declare function uniqueValues<T, K extends keyof T = keyof T>(items: T[], property: K): Array<T[K]>;
 
-export declare const XFileDragdrop: typeof __VLS_export_2;
+export declare const XFileDragdrop: typeof __VLS_export;
 
-export declare const XRelativeTime: typeof __VLS_export_3;
+export declare const XRelativeTime: typeof __VLS_export_2;
 
-export declare const XSortFilterDatasetNg: typeof __VLS_export_4;
+export declare const XSortFilterDatasetNg: typeof __VLS_export_3;
 
-export declare const XTimeTextField: typeof __VLS_export_5;
+export declare const XTimeTextField: typeof __VLS_export_4;
 
 export { }
-
-
-declare global {
-    interface HTMLElement {
-        [tableCellApiSymbol]?: FTableCellApi;
-    }
-}

package/dist/types/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.58.5"
+      "packageVersion": "7.58.7"
     }
   ]
 }