hongluan-ui/lib/components/table/src/table.vue.d.ts

Hongluan Component Library for Vue 3

import TableLayout from './table-layout';
import type { Table } from './table/defaults';
declare const _default: import("vue").DefineComponent<{
    data: {
        type: import("vue").PropType<any[]>;
        default: () => any[];
    };
    size: StringConstructor;
    width: (StringConstructor | NumberConstructor)[];
    height: (StringConstructor | NumberConstructor)[];
    maxHeight: (StringConstructor | NumberConstructor)[];
    fit: {
        /**
         * @description used in multiple selection Table, toggle select all and deselect all
         */
        type: BooleanConstructor;
        default: boolean;
    };
    list: {
        type: BooleanConstructor;
        default: boolean;
    };
    stripe: (BooleanConstructor | StringConstructor)[];
    border: BooleanConstructor;
    rowKey: import("vue").PropType<string | ((row: any) => string)>;
    showHeader: {
        type: BooleanConstructor;
        default: boolean;
    };
    showSummary: BooleanConstructor;
    sumText: StringConstructor;
    summaryMethod: import("vue").PropType<import("./table/defaults").SummaryMethod<any>>;
    rowClassName: import("vue").PropType<import("./table/defaults").ColumnCls<any>>;
    rowStyle: import("vue").PropType<import("./table/defaults").ColumnStyle<any>>;
    cellClassName: import("vue").PropType<import("./table/defaults").CellCls<any>>;
    cellStyle: import("vue").PropType<import("./table/defaults").CellStyle<any>>;
    headerRowClassName: import("vue").PropType<import("./table/defaults").ColumnCls<any>>;
    headerRowStyle: import("vue").PropType<import("./table/defaults").ColumnStyle<any>>;
    headerCellClassName: import("vue").PropType<import("./table/defaults").CellCls<any>>;
    headerCellStyle: import("vue").PropType<import("./table/defaults").CellStyle<any>>;
    highlightCurrentRow: BooleanConstructor;
    currentRowKey: (StringConstructor | NumberConstructor)[];
    emptyText: StringConstructor;
    expandRowKeys: import("vue").PropType<string[]>;
    defaultExpandAll: BooleanConstructor;
    defaultSort: import("vue").PropType<import("./table/defaults").Sort>;
    tooltipEffect: StringConstructor;
    tooltipOptions: import("vue").PropType<Partial<Pick<import("../..").TooltipProps, "offset" | "placement" | "transition" | "effect" | "showAfter" | "hideAfter" | "popperOptions" | "enterable" | "popperClass" | "appendTo" | "showArrow">>>;
    spanMethod: import("vue").PropType<(data: {
        row: any;
        rowIndex: number;
        column: import("./table-column/defaults").TableColumnCtx<any>;
        columnIndex: number;
    }) => number[] | {
        rowspan: number;
        colspan: number;
    }>;
    selectOnIndeterminate: {
        type: BooleanConstructor;
        default: boolean;
    };
    indent: {
        type: NumberConstructor;
        default: number;
    };
    treeProps: {
        type: import("vue").PropType<import("./table/defaults").TreeProps>;
        default: () => {
            hasChildren: string;
            children: string;
            checkStrictly: boolean;
        };
    };
    lazy: BooleanConstructor;
    load: import("vue").PropType<(row: any, treeNode: import("./table/defaults").TreeNode, resolve: (data: any[]) => void) => void>;
    style: {
        type: import("vue").PropType<import("vue").CSSProperties>;
        default: () => {};
    };
    className: {
        type: StringConstructor;
        default: string;
    };
    tableLayout: {
        type: import("vue").PropType<"fixed" | "auto">;
        default: string;
    };
    scrollbarAlwaysOn: BooleanConstructor;
    flexible: BooleanConstructor;
    showOverflowTooltip: import("vue").PropType<boolean | Partial<Pick<import("../..").TooltipProps, "offset" | "placement" | "transition" | "effect" | "showAfter" | "hideAfter" | "popperOptions" | "enterable" | "popperClass" | "appendTo" | "showArrow">>>;
}, {
    namespace: import("vue").ComputedRef<string>;
    defaultNamespace: string;
    layout: TableLayout<any>;
    store: any;
    columns: import("vue").ComputedRef<import("./table-column/defaults").TableColumnCtx<unknown>>;
    handleHeaderFooterMousewheel: (event: any, data: any) => void;
    handleMouseLeave: () => void;
    tableId: string;
    tableSize: import("vue").ComputedRef<"xxxs" | "xxs" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl" | "xxxl">;
    isHidden: import("vue").Ref<boolean>;
    isEmpty: import("vue").ComputedRef<boolean>;
    renderExpanded: any;
    resizeProxyVisible: import("vue").Ref<boolean>;
    resizeState: import("vue").Ref<{
        width: number;
        height: number;
        headerHeight: number;
    }>;
    isGroup: import("vue").Ref<boolean>;
    bodyWidth: import("vue").ComputedRef<string>;
    tableBodyStyles: import("vue").ComputedRef<{
        width: string;
    }>;
    emptyBlockStyle: import("vue").ComputedRef<{
        width: string;
        height: string;
    }>;
    debouncedUpdateLayout: import("lodash").DebouncedFunc<() => void>;
    handleFixedMousewheel: (event: any, data: any) => void;
    /**
     * @description used in single selection Table, set a certain row selected. If called without any parameter, it will clear selection
     */
    setCurrentRow: (row: any) => void;
    /**
     * @description returns the currently selected rows
     */
    getSelectionRows: () => any;
    /**
     * @description used in multiple selection Table, toggle if a certain row is selected. With the second parameter, you can directly set if this row is selected
     */
    toggleRowSelection: (row: any, selected?: boolean) => void;
    /**
     * @description used in multiple selection Table, clear user selection
     */
    clearSelection: () => void;
    /**
     * @description clear filters of the columns whose `columnKey` are passed in. If no params, clear all filters
     */
    clearFilter: (columnKeys?: string[]) => void;
    /**
     * @description used in multiple selection Table, toggle select all and deselect all
     */
    toggleAllSelection: () => void;
    /**
     * @description used in expandable Table or tree Table, toggle if a certain row is expanded. With the second parameter, you can directly set if this row is expanded or collapsed
     */
    toggleRowExpansion: (row: any, expanded?: boolean) => void;
    /**
     * @description clear sorting, restore data to the original order
     */
    clearSort: () => void;
    /**
     * @description refresh the layout of Table. When the visibility of Table changes, you may need to call this method to get a correct layout
     */
    doLayout: () => void;
    /**
     * @description sort Table manually. Property `prop` is used to set sort column, property `order` is used to set sort order
     */
    sort: (prop: string, order: string) => void;
    t: import("hongluan-ui/es/hooks").Translator;
    setDragVisible: (visible: boolean) => void;
    context: Table<any>;
    computedSumText: import("vue").ComputedRef<string>;
    computedEmptyText: import("vue").ComputedRef<string>;
    tableLayout: import("vue").ComputedRef<"fixed" | "auto">;
    scrollbarViewStyle: {
        display: string;
        verticalAlign: string;
    };
    tableInnerStyle: import("vue").ComputedRef<{
        height: string | number;
        maxHeight?: undefined;
    } | {
        maxHeight: string | number;
        height?: undefined;
    } | {
        height?: undefined;
        maxHeight?: undefined;
    }>;
    scrollbarStyle: import("vue").ComputedRef<{
        height: string;
        maxHeight?: undefined;
    } | {
        maxHeight: string;
        height?: undefined;
    } | {
        height?: undefined;
        maxHeight?: undefined;
    }>;
    scrollBarRef: import("vue").Ref<any>;
    /**
     * @description scrolls to a particular set of coordinates
     */
    scrollTo: (options: number | ScrollToOptions, yCoord?: number) => void;
    /**
     * @description set horizontal scroll position
     */
    setScrollLeft: (left?: number) => void;
    /**
     * @description set vertical scroll position
     */
    setScrollTop: (top?: number) => void;
}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, ("select" | "select-all" | "expand-change" | "current-change" | "cell-click" | "row-click" | "sort-change" | "selection-change" | "cell-mouse-enter" | "cell-mouse-leave" | "cell-contextmenu" | "cell-dblclick" | "row-contextmenu" | "row-dblclick" | "header-click" | "header-contextmenu" | "filter-change" | "header-dragend")[], "select" | "select-all" | "expand-change" | "current-change" | "cell-click" | "row-click" | "sort-change" | "selection-change" | "cell-mouse-enter" | "cell-mouse-leave" | "cell-contextmenu" | "cell-dblclick" | "row-contextmenu" | "row-dblclick" | "header-click" | "header-contextmenu" | "filter-change" | "header-dragend", import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
    data: {
        type: import("vue").PropType<any[]>;
        default: () => any[];
    };
    size: StringConstructor;
    width: (StringConstructor | NumberConstructor)[];
    height: (StringConstructor | NumberConstructor)[];
    maxHeight: (StringConstructor | NumberConstructor)[];
    fit: {
        /**
         * @description used in multiple selection Table, toggle select all and deselect all
         */
        type: BooleanConstructor;
        default: boolean;
    };
    list: {
        type: BooleanConstructor;
        default: boolean;
    };
    stripe: (BooleanConstructor | StringConstructor)[];
    border: BooleanConstructor;
    rowKey: import("vue").PropType<string | ((row: any) => string)>;
    showHeader: {
        type: BooleanConstructor;
        default: boolean;
    };
    showSummary: BooleanConstructor;
    sumText: StringConstructor;
    summaryMethod: import("vue").PropType<import("./table/defaults").SummaryMethod<any>>;
    rowClassName: import("vue").PropType<import("./table/defaults").ColumnCls<any>>;
    rowStyle: import("vue").PropType<import("./table/defaults").ColumnStyle<any>>;
    cellClassName: import("vue").PropType<import("./table/defaults").CellCls<any>>;
    cellStyle: import("vue").PropType<import("./table/defaults").CellStyle<any>>;
    headerRowClassName: import("vue").PropType<import("./table/defaults").ColumnCls<any>>;
    headerRowStyle: import("vue").PropType<import("./table/defaults").ColumnStyle<any>>;
    headerCellClassName: import("vue").PropType<import("./table/defaults").CellCls<any>>;
    headerCellStyle: import("vue").PropType<import("./table/defaults").CellStyle<any>>;
    highlightCurrentRow: BooleanConstructor;
    currentRowKey: (StringConstructor | NumberConstructor)[];
    emptyText: StringConstructor;
    expandRowKeys: import("vue").PropType<string[]>;
    defaultExpandAll: BooleanConstructor;
    defaultSort: import("vue").PropType<import("./table/defaults").Sort>;
    tooltipEffect: StringConstructor;
    tooltipOptions: import("vue").PropType<Partial<Pick<import("../..").TooltipProps, "offset" | "placement" | "transition" | "effect" | "showAfter" | "hideAfter" | "popperOptions" | "enterable" | "popperClass" | "appendTo" | "showArrow">>>;
    spanMethod: import("vue").PropType<(data: {
        row: any;
        rowIndex: number;
        column: import("./table-column/defaults").TableColumnCtx<any>;
        columnIndex: number;
    }) => number[] | {
        rowspan: number;
        colspan: number;
    }>;
    selectOnIndeterminate: {
        type: BooleanConstructor;
        default: boolean;
    };
    indent: {
        type: NumberConstructor;
        default: number;
    };
    treeProps: {
        type: import("vue").PropType<import("./table/defaults").TreeProps>;
        default: () => {
            hasChildren: string;
            children: string;
            checkStrictly: boolean;
        };
    };
    lazy: BooleanConstructor;
    load: import("vue").PropType<(row: any, treeNode: import("./table/defaults").TreeNode, resolve: (data: any[]) => void) => void>;
    style: {
        type: import("vue").PropType<import("vue").CSSProperties>;
        default: () => {};
    };
    className: {
        type: StringConstructor;
        default: string;
    };
    tableLayout: {
        type: import("vue").PropType<"fixed" | "auto">;
        default: string;
    };
    scrollbarAlwaysOn: BooleanConstructor;
    flexible: BooleanConstructor;
    showOverflowTooltip: import("vue").PropType<boolean | Partial<Pick<import("../..").TooltipProps, "offset" | "placement" | "transition" | "effect" | "showAfter" | "hideAfter" | "popperOptions" | "enterable" | "popperClass" | "appendTo" | "showArrow">>>;
}>> & {
    onSelect?: (...args: any[]) => any;
    "onExpand-change"?: (...args: any[]) => any;
    "onCurrent-change"?: (...args: any[]) => any;
    "onCell-click"?: (...args: any[]) => any;
    "onRow-click"?: (...args: any[]) => any;
    "onSort-change"?: (...args: any[]) => any;
    "onSelect-all"?: (...args: any[]) => any;
    "onSelection-change"?: (...args: any[]) => any;
    "onCell-mouse-enter"?: (...args: any[]) => any;
    "onCell-mouse-leave"?: (...args: any[]) => any;
    "onCell-contextmenu"?: (...args: any[]) => any;
    "onCell-dblclick"?: (...args: any[]) => any;
    "onRow-contextmenu"?: (...args: any[]) => any;
    "onRow-dblclick"?: (...args: any[]) => any;
    "onHeader-click"?: (...args: any[]) => any;
    "onHeader-contextmenu"?: (...args: any[]) => any;
    "onFilter-change"?: (...args: any[]) => any;
    "onHeader-dragend"?: (...args: any[]) => any;
}, {
    indent: number;
    lazy: boolean;
    data: any[];
    border: boolean;
    style: {};
    className: string;
    tableLayout: "fixed" | "auto";
    list: boolean;
    showHeader: boolean;
    defaultExpandAll: boolean;
    highlightCurrentRow: boolean;
    treeProps: {
        hasChildren: string;
        children: string;
        checkStrictly: boolean;
    };
    fit: boolean;
    showSummary: boolean;
    selectOnIndeterminate: boolean;
    scrollbarAlwaysOn: boolean;
    flexible: boolean;
}>;
export default _default;