bitboss-ui 0.1.80 → 0.1.82

package/dist/components/BbTable/BbTable.vue.d.ts

@@ -1,304 +1,267 @@
+import type { MappedCell, TableColumn, BbTableEvents } from "./types";
 import type { Classes } from '../../types/Classes';
-import { CommonProps, GenericModelValue, OptionItems } from '../../types/CommonProps';
-/**
- * We allow table data classes to be a function so it can depend on the item
- */
-type ColumnClasses = Classes | (<T>(content: any, key: string, item: T) => Classes);
-/**
- * Column as defined from outside
- */
-export interface TableColumn {
-    /**
-     * Text alignment of the column.
-     */
-    align?: "left" | "right" | "center";
-    /**
-     * When set to false the formatter will not run on nullish values.
-     * By default is true so you can create virtual columns with keys that do not
-     * reference a prop in the `item` and still extract data from the other
-     * arguments in the formatting function.
-     */
-    formatOnNull?: boolean;
-    /**
-     * Formatting function used to generate enhanced content.
-     * @param content The content generated by the extraction of `Item[key]`
-     * @param key Key of the column taken from the column definition.
-     * @param item Item of the row.
-     */
-    formatter?: <T>(content: any, key: string, item: T) => any;
-    /**
-     * Key identifying the column.
-     */
-    key: string;
-    /**
-     * Text used in the header for this column.
-     */
-    label: string;
-    /**
-     * Placeholder used when the pipeline returns null content.
-     */
-    placeholder?: string;
-    /**
-     * List of classes to add to the `<td>` cell.
-     */
-    tdClass?: ColumnClasses;
-    /**
-     * List of classes to add to the `<th>` cell.
-     */
-    thClass?: Classes;
-}
-/**
- * Projection that represents a cell of data.
- */
-type MappedCell = {
-    align: string;
-    classes: Classes[];
-    content: string;
-    key: string;
-    label: string;
-    slotName: string;
-};
-export type BbTableProps = Pick<CommonProps, 'compact' | 'dependencies' | 'depsDebounceTime' | 'disabled' | 'itemValue' | 'legend' | 'loading' | 'loadingText' | 'matchStrategy' | 'multiple' | 'name' | 'noDataText' | 'readonly'> & OptionItems & GenericModelValue & {
-    /**
-     * Function that accepts the columns and the current item as
-     * arguments and returns a label to be used for accessibility purposes.
-     */
-    accessibleLabel?: (columns: MappedCell[], item: any) => string;
-    /**
-     * Displays the actions column.
-     */
-    actions?: boolean;
-    /**
-     * Label used in the header of the actions column.
-     */
-    actionsText?: string;
-    /**
-     * Text alignment of the columns.
-     */
-    align?: "left" | "center" | "right";
-    /**
-     * Boolean that defines whether to display a "Select all" checkbox.
-     */
-    allowSelectAll?: boolean;
-    /**
-     * Caption that describes the content of the table. Used for accessibility purposes.
-     */
-    caption?: string;
-    /**
-     * Array of definitions of how the columns should be rendered.
-     */
-    columns: TableColumn[];
-    /**
-     * Boolean that defines whether to display or hide the caption.
-     * By default is true and the caption is hidden.
-     */
-    displayCaption?: boolean;
-    /**
-     * Defines the table layout as fixed
-     * making each column take up the same amount of space.
-     */
-    fixed?: boolean;
-    /**
-     * Boolean that sets the headers as sticky top the top of the table.
-     */
-    fixedHeader?: boolean;
-    /**
-     * Definition for which column should be fixed.
-     * It can be an array of index of the column to fix on the left side of the table or
-     * an array of objects indicating the index and the position `left` or `right` where to affix the columns.
-     */
+declare const _default: <T extends object>(__VLS_props: {
+    name?: string | undefined;
+    readonly?: (boolean | "true" | "false") | undefined;
+    caption?: string | undefined;
+    legend?: string | undefined;
+    disabled?: boolean | undefined;
+    compact?: boolean | undefined;
+    dependencies?: any[] | undefined;
+    depsDebounceTime?: number | undefined;
+    itemValue?: string | ((item: any) => any) | undefined;
+    loading?: boolean | undefined;
+    loadingText?: string | undefined;
+    matchStrategy?: "string" | "equality" | undefined;
+    multiple?: boolean | undefined;
+    noDataText?: string | undefined;
+    fixed?: boolean | undefined;
+    modelValue?: any;
+    "onUpdate:modelValue"?: ((value: any) => any) | undefined;
+    items: T[] | ((prefill: boolean, modelValue?: any[] | undefined) => Promise<T[]>) | ((prefill: boolean, modelValue?: any[] | undefined) => T[]);
+    selectable?: boolean | ((item: T) => boolean) | undefined;
+    actions?: boolean | undefined;
+    tdClass?: import("./types").ColumnClasses | undefined;
+    thClass?: Classes | undefined;
+    accessibleLabel?: ((columns: MappedCell[], item: T) => string) | undefined;
+    actionsText?: string | undefined;
+    align?: "left" | "center" | "right" | undefined;
+    allowSelectAll?: boolean | undefined;
+    columns: TableColumn<T>[];
+    displayCaption?: boolean | undefined;
+    fixedHeader?: boolean | undefined;
     fixedColumns?: (number | {
         index: number;
         position: "left" | "right";
-    })[];
-    /**
-     * Defines whther the table is selectable.
-     * Can be a global boolean that affects all rows or a function
-     * that accepts an otem and returns a boolean that only affects that item.
-     */
-    selectable?: boolean | ((item: any) => boolean);
-    /**
-     * Used by v-model:selectAll. Indicates whether the "Select all" checkbox is checked or not.
-     */
-    selectAll?: boolean;
-    /**
-     * Text of the label used by the "Select all" boolean.
-     */
-    selectAllText?: string;
-    /**
-     * Text of the header used for the radio inputs when the table is not `multiple`.
-     */
-    selectText?: string;
-    /**
-     * Defines the classes to be passed to the `<td>` elements. Can also be a function for dynamic values.
-     */
-    tdClass?: Classes | ColumnClasses;
-    /**
-     * Defines the classes to be passed to the `<th>`.
-     */
-    thClass?: Classes;
-};
-export type BbTableEvents = {
-    (e: "click:row", event: MouseEvent, item: any, selected: boolean): void;
-    (e: "contextmenu:row", event: MouseEvent, item: any, selected: boolean): void;
-    (e: "dblclick:row", event: MouseEvent, item: any, selected: boolean): void;
-    (e: "update:modelValue", value: any): void;
-    (e: "update:selectAll", value: Boolean): void;
-};
-export type BbTableSlots = {
-    thead?: (props: {}) => any;
-    tbody?: (props: {}) => any;
-    tfoot?: (props: {}) => any;
-    header_select?: (props: {
-        multiple: boolean;
-        selectAll: boolean;
-    }) => any;
-    header_actions?: (props: {
-        text: string;
-    }) => any;
-    loading?: (props: {
-        items: any[];
-    }) => any;
-    "no-data"?: (props: {}) => any;
-    actions?: (props: {
-        item: any;
-        value: any;
-    }) => any;
-    select?: (props: {
-        item: any;
-        value: any;
-        checked: boolean;
-        disabled: boolean;
-        inputName: string;
-        readonly: boolean;
-    }) => any;
-} & {
-    [key: string]: (props: {
-        classes?: Classes[];
-        content?: any;
-        items?: any[];
-        item?: any;
-        label?: string;
-        value?: any;
-    }) => any;
-};
-declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<BbTableProps>, {
-    align: string;
-    accessibleLabel: (columns: MappedCell[]) => string;
-    actionsText: string;
-    allowSelectAll: boolean;
-    columns: () => never[];
-    dependencies: () => never[];
-    depsDebounceTime: number;
-    fixedColumns: () => never[];
-    items: () => never[];
-    loadingText: string;
-    matchStrategy: string;
-    multiple: boolean;
-    noDataText: string;
-    selectAllText: string;
-    selectText: string;
-}>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
-    "click:row": (event: MouseEvent, item: any, selected: boolean) => void;
-    "contextmenu:row": (event: MouseEvent, item: any, selected: boolean) => void;
-    "dblclick:row": (event: MouseEvent, item: any, selected: boolean) => void;
-    "update:modelValue": (value: any) => void;
-    "update:selectAll": (value: Boolean) => void;
-}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<BbTableProps>, {
-    align: string;
-    accessibleLabel: (columns: MappedCell[]) => string;
-    actionsText: string;
-    allowSelectAll: boolean;
-    columns: () => never[];
-    dependencies: () => never[];
-    depsDebounceTime: number;
-    fixedColumns: () => never[];
-    items: () => never[];
-    loadingText: string;
-    matchStrategy: string;
-    multiple: boolean;
-    noDataText: string;
-    selectAllText: string;
-    selectText: string;
-}>>> & {
-    "onUpdate:modelValue"?: ((value: any) => any) | undefined;
+    })[] | undefined;
+    selectAll?: boolean | undefined;
+    selectAllText?: string | undefined;
+    selectText?: string | undefined;
     "onClick:row"?: ((event: MouseEvent, item: any, selected: boolean) => any) | undefined;
     "onContextmenu:row"?: ((event: MouseEvent, item: any, selected: boolean) => any) | undefined;
     "onDblclick:row"?: ((event: MouseEvent, item: any, selected: boolean) => any) | undefined;
     "onUpdate:selectAll"?: ((value: Boolean) => any) | undefined;
-}, {
-    dependencies: any[];
-    depsDebounceTime: number;
-    loadingText: string;
-    matchStrategy: "string" | "equality";
-    multiple: boolean;
-    noDataText: string;
-    items: any[] | ((prefill: boolean, modelValue?: any[] | undefined) => Promise<any[]>) | ((prefill: boolean, modelValue?: any[] | undefined) => any[]);
-    accessibleLabel: (columns: MappedCell[], item: any) => string;
-    actionsText: string;
-    align: "left" | "center" | "right";
-    allowSelectAll: boolean;
-    columns: TableColumn[];
-    fixedColumns: (number | {
-        index: number;
-        position: "left" | "right";
-    })[];
-    selectAllText: string;
-    selectText: string;
-}, {}>, Readonly<{
-    thead?: ((props: {}) => any) | undefined;
-    tbody?: ((props: {}) => any) | undefined;
-    tfoot?: ((props: {}) => any) | undefined;
-    header_select?: ((props: {
-        multiple: boolean;
-        selectAll: boolean;
-    }) => any) | undefined;
-    header_actions?: ((props: {
-        text: string;
-    }) => any) | undefined;
-    loading?: ((props: {
-        items: any[];
-    }) => any) | undefined;
-    "no-data"?: ((props: {}) => any) | undefined;
-    actions?: ((props: {
-        item: any;
-        value: any;
-    }) => any) | undefined;
-    select?: ((props: {
-        item: any;
-        value: any;
-        checked: boolean;
-        disabled: boolean;
-        inputName: string;
-        readonly: boolean;
-    }) => any) | undefined;
-} & {
-    [key: string]: (props: {
-        classes?: Classes[] | undefined;
-        content?: any;
-        items?: any[] | undefined;
-        item?: any;
-        label?: string | undefined;
-        value?: any;
-    }) => any;
-}>>;
-export default _default;
-type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
-type __VLS_TypePropsToRuntimeProps<T> = {
-    [K in keyof T]-?: {} extends Pick<T, K> ? {
-        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
-    } : {
-        type: import('vue').PropType<T[K]>;
-        required: true;
-    };
-};
-type __VLS_WithDefaults<P, D> = {
-    [K in keyof Pick<P, keyof P>]: K extends keyof D ? __VLS_Prettify<P[K] & {
-        default: D[K];
-    }> : P[K];
-};
-type __VLS_WithTemplateSlots<T, S> = T & {
-    new (): {
-        $slots: S;
-    };
+} & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, __VLS_ctx?: {
+    attrs: any;
+    slots: Readonly<{
+        thead?: ((props: {}) => any) | undefined;
+        tbody?: ((props: {}) => any) | undefined;
+        tfoot?: ((props: {}) => any) | undefined;
+        header_select?: ((props: {
+            multiple: boolean;
+            selectAll: boolean;
+        }) => any) | undefined;
+        header_actions?: ((props: {
+            text: string;
+        }) => any) | undefined;
+        loading?: ((props: {
+            items: T[];
+        }) => any) | undefined;
+        "no-data"?: ((props: {}) => any) | undefined;
+        actions?: ((props: {
+            item: T;
+            value: any;
+        }) => any) | undefined;
+        select?: ((props: {
+            item: T;
+            value: any;
+            checked: boolean;
+            disabled: boolean;
+            inputName: string;
+            readonly: boolean;
+        }) => any) | undefined;
+    } & {
+        [key: string]: (props: {
+            classes?: Classes[] | undefined;
+            content?: any;
+            items?: T[] | undefined;
+            item: T;
+            label?: string | undefined;
+            value?: any; /**
+             * Item is selectable only if the table allows or item
+             * passes iteratee and the selection is not disabled
+             */
+        }) => any;
+    }>;
+    emit: BbTableEvents;
+} | undefined, __VLS_expose?: ((exposed: import('vue').ShallowUnwrapRef<{}>) => void) | undefined, __VLS_setup?: Promise<{
+    props: {
+        name?: string | undefined;
+        readonly?: (boolean | "true" | "false") | undefined;
+        caption?: string | undefined;
+        legend?: string | undefined;
+        disabled?: boolean | undefined;
+        compact?: boolean | undefined;
+        dependencies?: any[] | undefined;
+        depsDebounceTime?: number | undefined;
+        itemValue?: string | ((item: any) => any) | undefined;
+        loading?: boolean | undefined;
+        loadingText?: string | undefined;
+        matchStrategy?: "string" | "equality" | undefined;
+        multiple?: boolean | undefined;
+        noDataText?: string | undefined;
+        fixed?: boolean | undefined;
+        modelValue?: any;
+        "onUpdate:modelValue"?: ((value: any) => any) | undefined;
+        items: T[] | ((prefill: boolean, modelValue?: any[] | undefined) => Promise<T[]>) | ((prefill: boolean, modelValue?: any[] | undefined) => T[]);
+        selectable?: boolean | ((item: T) => boolean) | undefined;
+        actions?: boolean | undefined;
+        tdClass?: import("./types").ColumnClasses | undefined;
+        thClass?: Classes | undefined;
+        accessibleLabel?: ((columns: MappedCell[], item: T) => string) | undefined;
+        actionsText?: string | undefined;
+        align?: "left" | "center" | "right" | undefined;
+        allowSelectAll?: boolean | undefined;
+        columns: TableColumn<T>[];
+        displayCaption?: boolean | undefined;
+        fixedHeader?: boolean | undefined;
+        fixedColumns?: (number | {
+            index: number;
+            position: "left" | "right";
+        })[] | undefined;
+        selectAll?: boolean | undefined;
+        selectAllText?: string | undefined;
+        selectText?: string | undefined;
+        "onClick:row"?: ((event: MouseEvent, item: any, selected: boolean) => any) | undefined;
+        "onContextmenu:row"?: ((event: MouseEvent, item: any, selected: boolean) => any) | undefined;
+        "onDblclick:row"?: ((event: MouseEvent, item: any, selected: boolean) => any) | undefined;
+        "onUpdate:selectAll"?: ((value: Boolean) => any) | undefined;
+    } & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps;
+    expose(exposed: import('vue').ShallowUnwrapRef<{}>): void;
+    attrs: any;
+    slots: Readonly<{
+        thead?: ((props: {}) => any) | undefined;
+        tbody?: ((props: {}) => any) | undefined;
+        tfoot?: ((props: {}) => any) | undefined;
+        header_select?: ((props: {
+            multiple: boolean;
+            selectAll: boolean;
+        }) => any) | undefined;
+        header_actions?: ((props: {
+            text: string;
+        }) => any) | undefined;
+        loading?: ((props: {
+            items: T[];
+        }) => any) | undefined;
+        "no-data"?: ((props: {}) => any) | undefined;
+        actions?: ((props: {
+            item: T;
+            value: any;
+        }) => any) | undefined;
+        select?: ((props: {
+            item: T;
+            value: any;
+            checked: boolean;
+            disabled: boolean;
+            inputName: string;
+            readonly: boolean;
+        }) => any) | undefined;
+    } & {
+        [key: string]: (props: {
+            classes?: Classes[] | undefined;
+            content?: any;
+            items?: T[] | undefined;
+            item: T;
+            label?: string | undefined;
+            value?: any; /**
+             * Item is selectable only if the table allows or item
+             * passes iteratee and the selection is not disabled
+             */
+        }) => any;
+    }>;
+    emit: BbTableEvents;
+}>) => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
+    [key: string]: any;
+}> & {
+    __ctx?: {
+        props: {
+            name?: string | undefined;
+            readonly?: (boolean | "true" | "false") | undefined;
+            caption?: string | undefined;
+            legend?: string | undefined;
+            disabled?: boolean | undefined;
+            compact?: boolean | undefined;
+            dependencies?: any[] | undefined;
+            depsDebounceTime?: number | undefined;
+            itemValue?: string | ((item: any) => any) | undefined;
+            loading?: boolean | undefined;
+            loadingText?: string | undefined;
+            matchStrategy?: "string" | "equality" | undefined;
+            multiple?: boolean | undefined;
+            noDataText?: string | undefined;
+            fixed?: boolean | undefined;
+            modelValue?: any;
+            "onUpdate:modelValue"?: ((value: any) => any) | undefined;
+            items: T[] | ((prefill: boolean, modelValue?: any[] | undefined) => Promise<T[]>) | ((prefill: boolean, modelValue?: any[] | undefined) => T[]);
+            selectable?: boolean | ((item: T) => boolean) | undefined;
+            actions?: boolean | undefined;
+            tdClass?: import("./types").ColumnClasses | undefined;
+            thClass?: Classes | undefined;
+            accessibleLabel?: ((columns: MappedCell[], item: T) => string) | undefined;
+            actionsText?: string | undefined;
+            align?: "left" | "center" | "right" | undefined;
+            allowSelectAll?: boolean | undefined;
+            columns: TableColumn<T>[];
+            displayCaption?: boolean | undefined;
+            fixedHeader?: boolean | undefined;
+            fixedColumns?: (number | {
+                index: number;
+                position: "left" | "right";
+            })[] | undefined;
+            selectAll?: boolean | undefined;
+            selectAllText?: string | undefined;
+            selectText?: string | undefined;
+            "onClick:row"?: ((event: MouseEvent, item: any, selected: boolean) => any) | undefined;
+            "onContextmenu:row"?: ((event: MouseEvent, item: any, selected: boolean) => any) | undefined;
+            "onDblclick:row"?: ((event: MouseEvent, item: any, selected: boolean) => any) | undefined;
+            "onUpdate:selectAll"?: ((value: Boolean) => any) | undefined;
+        } & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps;
+        expose(exposed: import('vue').ShallowUnwrapRef<{}>): void;
+        attrs: any;
+        slots: Readonly<{
+            thead?: ((props: {}) => any) | undefined;
+            tbody?: ((props: {}) => any) | undefined;
+            tfoot?: ((props: {}) => any) | undefined;
+            header_select?: ((props: {
+                multiple: boolean;
+                selectAll: boolean;
+            }) => any) | undefined;
+            header_actions?: ((props: {
+                text: string;
+            }) => any) | undefined;
+            loading?: ((props: {
+                items: T[];
+            }) => any) | undefined;
+            "no-data"?: ((props: {}) => any) | undefined;
+            actions?: ((props: {
+                item: T;
+                value: any;
+            }) => any) | undefined;
+            select?: ((props: {
+                item: T;
+                value: any;
+                checked: boolean;
+                disabled: boolean;
+                inputName: string;
+                readonly: boolean;
+            }) => any) | undefined;
+        } & {
+            [key: string]: (props: {
+                classes?: Classes[] | undefined;
+                content?: any;
+                items?: T[] | undefined;
+                item: T;
+                label?: string | undefined;
+                value?: any; /**
+                 * Item is selectable only if the table allows or item
+                 * passes iteratee and the selection is not disabled
+                 */
+            }) => any;
+        }>;
+        emit: BbTableEvents;
+    } | undefined;
 };
+export default _default;
+type __VLS_Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};