bootstrap-vue-3/dist/components/BTable/BTable.vue.d.ts

Early (but lovely) implementation of Vue 3, Bootstrap 5 and Typescript

import type { Booleanish, ColorVariant, TableField, TableFieldObject, TableItem, VerticalAlign } from '../../types';
import type { BTableProvider, BTableSortCompare } from '../../types/components';
declare type NoProviderTypes = 'paging' | 'sorting' | 'filtering';
declare const _sfc_main: import("vue").DefineComponent<{
    align: {
        type: null;
        required: false;
    };
    caption: {
        type: StringConstructor;
        required: false;
    };
    captionTop: {
        type: null;
        required: false;
        default: boolean;
    };
    borderless: {
        type: null;
        required: false;
        default: boolean;
    };
    bordered: {
        type: null;
        required: false;
        default: boolean;
    };
    borderVariant: {
        type: null;
        required: false;
    };
    dark: {
        type: null;
        required: false;
        default: boolean;
    };
    fields: {
        type: ArrayConstructor;
        required: false;
        default: () => never[];
    };
    footClone: {
        type: null;
        required: false;
        default: boolean;
    };
    hover: {
        type: null;
        required: false;
        default: boolean;
    };
    items: {
        type: ArrayConstructor;
        required: false;
        default: () => never[];
    };
    provider: {
        type: null;
        required: false;
    };
    sortCompare: {
        type: null;
        required: false;
    };
    noProvider: {
        type: ArrayConstructor;
        required: false;
    };
    noProviderPaging: {
        type: null;
        required: false;
    };
    noProviderSorting: {
        type: null;
        required: false;
    };
    noProviderFiltering: {
        type: null;
        required: false;
    };
    responsive: {
        type: (StringConstructor | BooleanConstructor)[];
        required: false;
        default: boolean;
    };
    small: {
        type: null;
        required: false;
        default: boolean;
    };
    striped: {
        type: null;
        required: false;
        default: boolean;
    };
    variant: {
        type: null;
        required: false;
    };
    sortBy: {
        type: StringConstructor;
        required: false;
    };
    sortDesc: {
        type: null;
        required: false;
        default: boolean;
    };
    sortInternal: {
        type: null;
        required: false;
        default: boolean;
    };
    selectable: {
        type: null;
        required: false;
        default: boolean;
    };
    stickySelect: {
        type: null;
        required: false;
        default: boolean;
    };
    selectHead: {
        type: (StringConstructor | BooleanConstructor)[];
        required: false;
        default: boolean;
    };
    selectMode: {
        type: StringConstructor;
        required: false;
        default: string;
    };
    selectionVariant: {
        type: null;
        required: false;
        default: string;
    };
    stickyHeader: {
        type: null;
        required: false;
        default: boolean;
    };
    busy: {
        type: null;
        required: false;
        default: boolean;
    };
    showEmpty: {
        type: null;
        required: false;
        default: boolean;
    };
    perPage: {
        type: NumberConstructor;
        required: false;
    };
    currentPage: {
        type: NumberConstructor;
        required: false;
        default: number;
    };
    filter: {
        type: StringConstructor;
        required: false;
    };
    filterable: {
        type: ArrayConstructor;
        required: false;
    };
    emptyText: {
        type: StringConstructor;
        required: false;
        default: string;
    };
    emptyFilteredText: {
        type: StringConstructor;
        required: false;
        default: string;
    };
}, {
    props: {
        align?: VerticalAlign | undefined;
        caption?: string | undefined;
        captionTop: Booleanish;
        borderless: Booleanish;
        bordered: Booleanish;
        borderVariant?: ColorVariant | undefined;
        dark: Booleanish;
        fields: Array<TableField>;
        footClone: Booleanish;
        hover: Booleanish;
        items: Array<TableItem>;
        provider?: BTableProvider | undefined;
        sortCompare?: BTableSortCompare | undefined;
        noProvider?: NoProviderTypes[] | undefined;
        noProviderPaging?: Booleanish | undefined;
        noProviderSorting?: Booleanish | undefined;
        noProviderFiltering?: Booleanish | undefined;
        responsive: boolean | 'sm' | 'md' | 'lg' | 'xl' | 'xxl';
        small: Booleanish;
        striped: Booleanish;
        variant?: ColorVariant | undefined;
        sortBy?: string | undefined;
        sortDesc: Booleanish;
        sortInternal: Booleanish;
        selectable: Booleanish;
        stickySelect: Booleanish;
        selectHead: boolean | string;
        selectMode: 'multi' | 'single' | 'range';
        selectionVariant: ColorVariant;
        stickyHeader: Booleanish;
        busy: Booleanish;
        showEmpty: Booleanish;
        perPage?: number | undefined;
        currentPage: number;
        filter?: string | undefined;
        filterable?: string[] | undefined;
        emptyText: string;
        emptyFilteredText: string;
    };
    footCloneBoolean: import("vue").ComputedRef<boolean>;
    sortDescBoolean: import("vue").ComputedRef<boolean>;
    sortInternalBoolean: import("vue").ComputedRef<boolean>;
    selectableBoolean: import("vue").ComputedRef<boolean>;
    stickySelectBoolean: import("vue").ComputedRef<boolean>;
    busyBoolean: import("vue").ComputedRef<boolean>;
    showEmptyBoolean: import("vue").ComputedRef<boolean>;
    noProviderPagingBoolean: import("vue").ComputedRef<boolean>;
    noProviderSortingBoolean: import("vue").ComputedRef<boolean>;
    noProviderFilteringBoolean: import("vue").ComputedRef<boolean>;
    internalBusyFlag: import("vue").Ref<boolean>;
    emit: {
        (e: 'headClicked', key: import("../../types/LiteralUnion").default<string, string>, field: TableField<Record<string, unknown>>, event: MouseEvent, isFooter: boolean): void;
        (e: 'rowClicked', item: TableItem<Record<string, unknown>>, index: number, event: MouseEvent): void;
        (e: 'rowDblClicked', item: TableItem<Record<string, unknown>>, index: number, event: MouseEvent): void;
        (e: 'rowHovered', item: TableItem<Record<string, unknown>>, index: number, event: MouseEvent): void;
        (e: 'rowUnhovered', item: TableItem<Record<string, unknown>>, index: number, event: MouseEvent): void;
        (e: 'rowSelected', value: TableItem): void;
        (e: 'rowUnselected', value: TableItem): void;
        (e: 'selection', value: TableItem[]): void;
        (e: 'update:busy', value: boolean): void;
        (e: 'update:sortBy', value: string): void;
        (e: 'update:sortDesc', value: boolean): void;
        (e: 'sorted', sortBy: string, isDesc: boolean): void;
        (e: 'filtered', value: TableItem[]): void;
    };
    slots: Readonly<{
        [name: string]: import("vue").Slot | undefined;
    }>;
    tableClasses: import("vue").ComputedRef<{
        [x: string]: boolean;
        'b-table-selectable': boolean;
        'b-table-selecting user-select-none': boolean;
        'b-table-busy': boolean;
        'b-table-sortable': boolean;
        'b-table-sort-desc': boolean;
        'b-table-sort-asc': boolean;
    }>;
    containerAttrs: import("vue").ComputedRef<{
        bordered: Booleanish;
        borderless: Booleanish;
        borderVariant: ColorVariant | undefined;
        captionTop: Booleanish;
        dark: Booleanish;
        hover: Booleanish;
        responsive: boolean | "sm" | "lg" | "md" | "xl" | "xxl";
        striped: Booleanish;
        small: Booleanish;
        tableClass: {
            [x: string]: boolean;
            'b-table-selectable': boolean;
            'b-table-selecting user-select-none': boolean;
            'b-table-busy': boolean;
            'b-table-sortable': boolean;
            'b-table-sort-desc': boolean;
            'b-table-sort-asc': boolean;
        };
        tableVariant: ColorVariant | undefined;
        stickyHeader: Booleanish;
    }>;
    itemHelper: {
        normaliseFields: (origFields: TableField<Record<string, unknown>>[], items: TableItem<Record<string, unknown>>[]) => TableFieldObject<Record<string, unknown>>[];
        mapItems: (fields: TableField<Record<string, unknown>>[], items: TableItem<Record<string, unknown>>[], props: any, flags: Record<string, import("vue").Ref<boolean>>) => TableItem<Record<string, unknown>>[];
        internalItems: import("vue").Ref<{
            [x: string]: unknown;
            _rowVariant?: ColorVariant | undefined;
            _cellVariants?: Partial<Record<string, ColorVariant>> | undefined;
            _showDetails?: boolean | undefined;
        }[]>;
        updateInternalItems: (items: TableItem<Record<string, any>>[]) => Promise<TableItem<Record<string, unknown>>[] | undefined>;
        filterEvent: import("vue").Ref<((items: TableItem<Record<string, unknown>>[]) => void) | undefined>;
    };
    computedFields: import("vue").ComputedRef<TableFieldObject<Record<string, unknown>>[]>;
    computedFieldsTotal: import("vue").ComputedRef<number>;
    isFilterableTable: import("vue").ComputedRef<boolean>;
    usesProvider: import("vue").ComputedRef<boolean>;
    requireItemsMapping: import("vue").ComputedRef<boolean>;
    computedItems: import("vue").ComputedRef<TableItem<Record<string, unknown>>[]>;
    getFieldHeadLabel: (field: TableField) => string;
    headerClicked: (field: TableField, event: MouseEvent, isFooter?: boolean) => void;
    onRowClick: (row: TableItem, index: number, e: MouseEvent) => void;
    onRowDblClick: (row: TableItem, index: number, e: MouseEvent) => void;
    onRowMouseEnter: (row: TableItem, index: number, e: MouseEvent) => void;
    onRowMouseLeave: (row: TableItem, index: number, e: MouseEvent) => void;
    addSelectableCell: import("vue").ComputedRef<boolean>;
    isSortable: import("vue").ComputedRef<boolean>;
    handleFieldSorting: (field: TableField) => void;
    selectedItems: import("vue").Ref<Set<TableItem<Record<string, unknown>>>>;
    isSelecting: import("vue").ComputedRef<boolean>;
    notifySelectionEvent: () => void;
    handleRowSelection: (row: TableItem, index: number, shiftClicked?: boolean) => void;
    callItemsProvider: () => Promise<TableItem<Record<string, unknown>>[] | undefined>;
    toggleRowDetails: (tr: TableItem) => void;
    getFieldColumnClasses: (field: TableFieldObject) => (string | string[] | {
        'b-table-sortable-column': boolean | undefined;
        'b-table-sticky-column': boolean | undefined;
    } | undefined)[];
    getFieldRowClasses: (field: TableFieldObject, tr: TableItem) => (string | string[] | {
        'b-table-sticky-column': boolean | undefined;
    } | undefined)[];
    getRowClasses: (item: TableItem) => (string | null)[];
    selectAllRows: () => void;
    clearSelected: () => void;
    selectRow: (index: number) => void;
    unselectRow: (index: number) => void;
    providerPropsWatch: (prop: string, val: any, oldVal: any) => Promise<void>;
    BSpinner: import("vue").DefineComponent<{
        label: {
            type: StringConstructor;
            required: false;
        };
        role: {
            type: StringConstructor;
            required: false;
            default: string;
        };
        small: {
            type: null;
            required: false;
            default: boolean;
        };
        tag: {
            type: StringConstructor;
            required: false;
            default: string;
        };
        type: {
            type: null;
            required: false;
            default: string;
        };
        variant: {
            type: null;
            required: false;
        };
    }, {
        props: {
            label?: string | undefined;
            role: string;
            small: Booleanish;
            tag: string;
            type: import("../../types/SpinnerType").default;
            variant?: ColorVariant | undefined;
        };
        smallBoolean: import("vue").ComputedRef<boolean>;
        classes: import("vue").ComputedRef<{
            [x: string]: boolean;
            'spinner-border': boolean;
            'spinner-border-sm': boolean;
            'spinner-grow': boolean;
            'spinner-grow-sm': boolean;
        }>;
    }, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
        label: {
            type: StringConstructor;
            required: false;
        };
        role: {
            type: StringConstructor;
            required: false;
            default: string;
        };
        small: {
            type: null;
            required: false;
            default: boolean;
        };
        tag: {
            type: StringConstructor;
            required: false;
            default: string;
        };
        type: {
            type: null;
            required: false;
            default: string;
        };
        variant: {
            type: null;
            required: false;
        };
    }>>, {
        small: any;
        type: any;
        tag: string;
        role: string;
    }>;
    BTableSimple: import("vue").DefineComponent<{
        bordered: {
            type: null;
            required: false;
            default: boolean;
        };
        borderless: {
            type: null;
            required: false;
            default: boolean;
        };
        borderVariant: {
            type: null;
            required: false;
        };
        captionTop: {
            type: null;
            required: false;
            default: boolean;
        };
        dark: {
            type: null;
            required: false;
            default: boolean;
        };
        hover: {
            type: null;
            required: false;
            default: boolean;
        };
        responsive: {
            type: (StringConstructor | BooleanConstructor)[];
            required: false;
            default: boolean;
        };
        stacked: {
            type: (StringConstructor | BooleanConstructor)[];
            required: false;
            default: boolean;
        };
        striped: {
            type: null;
            required: false;
            default: boolean;
        };
        small: {
            type: null;
            required: false;
            default: boolean;
        };
        tableClass: {
            type: null;
            required: false;
        };
        tableVariant: {
            type: null;
            required: false;
        };
        stickyHeader: {
            type: null;
            required: false;
            default: boolean;
        };
    }, {
        props: {
            bordered: Booleanish;
            borderless: Booleanish;
            borderVariant?: ColorVariant | undefined;
            captionTop: Booleanish;
            dark: Booleanish;
            hover: Booleanish;
            responsive: boolean | "sm" | "lg" | "md" | "xl" | "xxl";
            stacked: boolean | "sm" | "lg" | "md" | "xl" | "xxl";
            striped: Booleanish;
            small: Booleanish;
            tableClass?: import("../../types/ClassValue").default | undefined;
            tableVariant?: ColorVariant | undefined;
            stickyHeader: Booleanish;
        };
        captionTopBoolean: import("vue").ComputedRef<boolean>;
        borderlessBoolean: import("vue").ComputedRef<boolean>;
        borderedBoolean: import("vue").ComputedRef<boolean>;
        darkBoolean: import("vue").ComputedRef<boolean>;
        hoverBoolean: import("vue").ComputedRef<boolean>;
        smallBoolean: import("vue").ComputedRef<boolean>;
        stripedBoolean: import("vue").ComputedRef<boolean>;
        stickyHeaderBoolean: import("vue").ComputedRef<boolean>;
        classes: import("vue").ComputedRef<(import("../../types/ClassValue").default | undefined)[]>;
        responsiveClasses: import("vue").ComputedRef<{
            [x: string]: boolean;
            'table-responsive': boolean;
            'b-table-sticky-header': boolean;
        }[]>;
    }, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
        bordered: {
            type: null;
            required: false;
            default: boolean;
        };
        borderless: {
            type: null;
            required: false;
            default: boolean;
        };
        borderVariant: {
            type: null;
            required: false;
        };
        captionTop: {
            type: null;
            required: false;
            default: boolean;
        };
        dark: {
            type: null;
            required: false;
            default: boolean;
        };
        hover: {
            type: null;
            required: false;
            default: boolean;
        };
        responsive: {
            type: (StringConstructor | BooleanConstructor)[];
            required: false;
            default: boolean;
        };
        stacked: {
            type: (StringConstructor | BooleanConstructor)[];
            required: false;
            default: boolean;
        };
        striped: {
            type: null;
            required: false;
            default: boolean;
        };
        small: {
            type: null;
            required: false;
            default: boolean;
        };
        tableClass: {
            type: null;
            required: false;
        };
        tableVariant: {
            type: null;
            required: false;
        };
        stickyHeader: {
            type: null;
            required: false;
            default: boolean;
        };
    }>>, {
        small: any;
        dark: any;
        stacked: string | boolean;
        bordered: any;
        borderless: any;
        captionTop: any;
        hover: any;
        responsive: string | boolean;
        striped: any;
        stickyHeader: any;
    }>;
}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, ("headClicked" | "rowClicked" | "rowDblClicked" | "rowHovered" | "rowUnhovered" | "rowSelected" | "rowUnselected" | "selection" | "update:busy" | "update:sortBy" | "update:sortDesc" | "sorted" | "filtered")[], "headClicked" | "rowClicked" | "rowDblClicked" | "rowHovered" | "rowUnhovered" | "rowSelected" | "rowUnselected" | "selection" | "update:busy" | "update:sortBy" | "update:sortDesc" | "sorted" | "filtered", import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
    align: {
        type: null;
        required: false;
    };
    caption: {
        type: StringConstructor;
        required: false;
    };
    captionTop: {
        type: null;
        required: false;
        default: boolean;
    };
    borderless: {
        type: null;
        required: false;
        default: boolean;
    };
    bordered: {
        type: null;
        required: false;
        default: boolean;
    };
    borderVariant: {
        type: null;
        required: false;
    };
    dark: {
        type: null;
        required: false;
        default: boolean;
    };
    fields: {
        type: ArrayConstructor;
        required: false;
        default: () => never[];
    };
    footClone: {
        type: null;
        required: false;
        default: boolean;
    };
    hover: {
        type: null;
        required: false;
        default: boolean;
    };
    items: {
        type: ArrayConstructor;
        required: false;
        default: () => never[];
    };
    provider: {
        type: null;
        required: false;
    };
    sortCompare: {
        type: null;
        required: false;
    };
    noProvider: {
        type: ArrayConstructor;
        required: false;
    };
    noProviderPaging: {
        type: null;
        required: false;
    };
    noProviderSorting: {
        type: null;
        required: false;
    };
    noProviderFiltering: {
        type: null;
        required: false;
    };
    responsive: {
        type: (StringConstructor | BooleanConstructor)[];
        required: false;
        default: boolean;
    };
    small: {
        type: null;
        required: false;
        default: boolean;
    };
    striped: {
        type: null;
        required: false;
        default: boolean;
    };
    variant: {
        type: null;
        required: false;
    };
    sortBy: {
        type: StringConstructor;
        required: false;
    };
    sortDesc: {
        type: null;
        required: false;
        default: boolean;
    };
    sortInternal: {
        type: null;
        required: false;
        default: boolean;
    };
    selectable: {
        type: null;
        required: false;
        default: boolean;
    };
    stickySelect: {
        type: null;
        required: false;
        default: boolean;
    };
    selectHead: {
        type: (StringConstructor | BooleanConstructor)[];
        required: false;
        default: boolean;
    };
    selectMode: {
        type: StringConstructor;
        required: false;
        default: string;
    };
    selectionVariant: {
        type: null;
        required: false;
        default: string;
    };
    stickyHeader: {
        type: null;
        required: false;
        default: boolean;
    };
    busy: {
        type: null;
        required: false;
        default: boolean;
    };
    showEmpty: {
        type: null;
        required: false;
        default: boolean;
    };
    perPage: {
        type: NumberConstructor;
        required: false;
    };
    currentPage: {
        type: NumberConstructor;
        required: false;
        default: number;
    };
    filter: {
        type: StringConstructor;
        required: false;
    };
    filterable: {
        type: ArrayConstructor;
        required: false;
    };
    emptyText: {
        type: StringConstructor;
        required: false;
        default: string;
    };
    emptyFilteredText: {
        type: StringConstructor;
        required: false;
        default: string;
    };
}>> & {
    onHeadClicked?: ((...args: any[]) => any) | undefined;
    onRowClicked?: ((...args: any[]) => any) | undefined;
    onRowDblClicked?: ((...args: any[]) => any) | undefined;
    onRowHovered?: ((...args: any[]) => any) | undefined;
    onRowUnhovered?: ((...args: any[]) => any) | undefined;
    onRowSelected?: ((...args: any[]) => any) | undefined;
    onRowUnselected?: ((...args: any[]) => any) | undefined;
    onSelection?: ((...args: any[]) => any) | undefined;
    "onUpdate:busy"?: ((...args: any[]) => any) | undefined;
    "onUpdate:sortBy"?: ((...args: any[]) => any) | undefined;
    "onUpdate:sortDesc"?: ((...args: any[]) => any) | undefined;
    onSorted?: ((...args: any[]) => any) | undefined;
    onFiltered?: ((...args: any[]) => any) | undefined;
}, {
    small: any;
    dark: any;
    items: unknown[];
    busy: any;
    bordered: any;
    borderless: any;
    captionTop: any;
    hover: any;
    responsive: string | boolean;
    striped: any;
    stickyHeader: any;
    fields: unknown[];
    footClone: any;
    sortDesc: any;
    sortInternal: any;
    selectable: any;
    stickySelect: any;
    selectHead: string | boolean;
    selectMode: string;
    selectionVariant: any;
    showEmpty: any;
    currentPage: number;
    emptyText: string;
    emptyFilteredText: string;
}>;
export default _sfc_main;