@vunk/plus 1.8.0 → 1.8.2

package/components/tables-v1/src/el-ctx.d.ts

@@ -0,0 +1,262 @@
+import type { TableProps } from 'element-plus';
+import type { CSSProperties, PropType } from 'vue';
+export declare const componentSizes: readonly ["", "default", "small", "large"];
+export type ComponentSize = typeof componentSizes[number];
+export type DefaultRow = any;
+type Layout = 'fixed' | 'auto';
+export interface Sort {
+    prop: string;
+    order: 'ascending' | 'descending';
+    init?: any;
+    silent?: any;
+}
+export interface TreeNode {
+    expanded?: boolean;
+    loading?: boolean;
+    noLazyChildren?: boolean;
+    indent?: number;
+    level?: number;
+    display?: boolean;
+}
+export declare const tableProps: {
+    /**
+     * @description table data
+     */
+    data: {
+        type: PropType<DefaultRow[]>;
+        default: () => never[];
+    };
+    /**
+     * @description size of Table
+     */
+    size: {
+        readonly type: PropType<"" | "small" | "default" | "large">;
+        readonly required: false;
+        readonly validator: ((val: unknown) => boolean) | undefined;
+        __epPropKey: true;
+    };
+    width: (StringConstructor | NumberConstructor)[];
+    /**
+     * @description table's height. By default it has an `auto` height. If its value is a number, the height is measured in pixels; if its value is a string, the value will be assigned to element's style.height, the height is affected by external styles
+     */
+    height: (StringConstructor | NumberConstructor)[];
+    /**
+     * @description table's max-height. The legal value is a number or the height in px
+     */
+    maxHeight: (StringConstructor | NumberConstructor)[];
+    /**
+     * @description whether width of column automatically fits its container
+     */
+    fit: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * @description whether Table is striped
+     */
+    stripe: BooleanConstructor;
+    /**
+     * @description whether Table has vertical border
+     */
+    border: BooleanConstructor;
+    /**
+     * @description key of row data, used for optimizing rendering. Required if `reserve-selection` is on or display tree data. When its type is String, multi-level access is supported, e.g. `user.info.id`, but `user.info[0].id` is not supported, in which case `Function` should be used
+     */
+    rowKey: PropType<TableProps<DefaultRow>["rowKey"]>;
+    /**
+     * @description whether Table header is visible
+     */
+    showHeader: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * @description whether to display a summary row
+     */
+    showSummary: BooleanConstructor;
+    /**
+     * @description displayed text for the first column of summary row
+     */
+    sumText: StringConstructor;
+    /**
+     * @description custom summary method
+     */
+    summaryMethod: PropType<TableProps<DefaultRow>["summaryMethod"]>;
+    /**
+     * @description function that returns custom class names for a row, or a string assigning class names for every row
+     */
+    rowClassName: PropType<TableProps<DefaultRow>["rowClassName"]>;
+    /**
+     * @description function that returns custom style for a row, or an object assigning custom style for every row
+     */
+    rowStyle: PropType<TableProps<DefaultRow>["rowStyle"]>;
+    /**
+     * @description function that returns custom class names for a cell, or a string assigning class names for every cell
+     */
+    cellClassName: PropType<TableProps<DefaultRow>["cellClassName"]>;
+    /**
+     * @description function that returns custom style for a cell, or an object assigning custom style for every cell
+     */
+    cellStyle: PropType<TableProps<DefaultRow>["cellStyle"]>;
+    /**
+     * @description function that returns custom class names for a row in table header, or a string assigning class names for every row in table header
+     */
+    headerRowClassName: PropType<TableProps<DefaultRow>["headerRowClassName"]>;
+    /**
+     * @description function that returns custom style for a row in table header, or an object assigning custom style for every row in table header
+     */
+    headerRowStyle: PropType<TableProps<DefaultRow>["headerRowStyle"]>;
+    /**
+     * @description function that returns custom class names for a cell in table header, or a string assigning class names for every cell in table header
+     */
+    headerCellClassName: PropType<TableProps<DefaultRow>["headerCellClassName"]>;
+    /**
+     * @description function that returns custom style for a cell in table header, or an object assigning custom style for every cell in table header
+     */
+    headerCellStyle: PropType<TableProps<DefaultRow>["headerCellStyle"]>;
+    /**
+     * @description whether current row is highlighted
+     */
+    highlightCurrentRow: BooleanConstructor;
+    /**
+     * @description key of current row, a set only prop
+     */
+    currentRowKey: (StringConstructor | NumberConstructor)[];
+    /**
+     * @description displayed text when data is empty. You can customize this area with `#empty`
+     */
+    emptyText: StringConstructor;
+    /**
+     * @description set expanded rows by this prop, prop's value is the keys of expand rows, you should set row-key before using this prop
+     */
+    expandRowKeys: PropType<TableProps<DefaultRow>["expandRowKeys"]>;
+    /**
+     * @description whether expand all rows by default, works when the table has a column type="expand" or contains tree structure data
+     */
+    defaultExpandAll: BooleanConstructor;
+    /**
+     * @description set the default sort column and order. property `prop` is used to set default sort column, property `order` is used to set default sort order
+     */
+    defaultSort: PropType<TableProps<DefaultRow>["defaultSort"]>;
+    /**
+     * @description the `effect` of the overflow tooltip
+     */
+    tooltipEffect: StringConstructor;
+    /**
+     * @description the options for the overflow tooltip, [see the following tooltip component](tooltip.html#attributes)
+     */
+    tooltipOptions: PropType<TableProps<DefaultRow>["tooltipOptions"]>;
+    /**
+     * @description method that returns rowspan and colspan
+     */
+    spanMethod: PropType<TableProps<DefaultRow>["spanMethod"]>;
+    /**
+     * @description controls the behavior of master checkbox in multi-select tables when only some rows are selected (but not all). If true, all rows will be selected, else deselected
+     */
+    selectOnIndeterminate: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * @description horizontal indentation of tree data
+     */
+    indent: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /**
+     * @description configuration for rendering nested data
+     */
+    treeProps: {
+        type: PropType<any>;
+        default: () => {
+            hasChildren: string;
+            children: string;
+            checkStrictly: boolean;
+        };
+    };
+    /**
+     * @description whether to lazy loading data
+     */
+    lazy: BooleanConstructor;
+    /**
+     * @description method for loading child row data, only works when `lazy` is true
+     */
+    load: PropType<TableProps<DefaultRow>["load"]>;
+    style: {
+        type: PropType<CSSProperties>;
+        default: () => {};
+    };
+    className: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * @description sets the algorithm used to lay out table cells, rows, and columns
+     */
+    tableLayout: {
+        type: PropType<Layout>;
+        default: string;
+    };
+    /**
+     * @description always show scrollbar
+     */
+    scrollbarAlwaysOn: BooleanConstructor;
+    /**
+     * @description ensure main axis minimum-size doesn't follow the content
+     */
+    flexible: BooleanConstructor;
+    /**
+     * @description whether to hide extra content and show them in a tooltip when hovering on the cell.It will affect all the table columns
+     */
+    showOverflowTooltip: PropType<TableProps<DefaultRow>["showOverflowTooltip"]>;
+    appendFilterPanelTo: StringConstructor;
+    scrollbarTabindex: {
+        type: (StringConstructor | NumberConstructor)[];
+        default: undefined;
+    };
+};
+export declare const createElTableBindProps: <T2 extends import("@vunk/core").NormalObject, EX extends (Extract<"data", keyof T2> | Extract<"size", keyof T2> | Extract<"load", keyof T2> | Extract<"style", keyof T2> | Extract<"maxHeight", keyof T2> | Extract<"fit", keyof T2> | Extract<"className", keyof T2> | Extract<"height", keyof T2> | Extract<"width", keyof T2> | Extract<"border", keyof T2> | Extract<"showOverflowTooltip", keyof T2> | Extract<"rowKey", keyof T2> | Extract<"summaryMethod", keyof T2> | Extract<"rowClassName", keyof T2> | Extract<"rowStyle", keyof T2> | Extract<"cellClassName", keyof T2> | Extract<"cellStyle", keyof T2> | Extract<"headerRowClassName", keyof T2> | Extract<"headerRowStyle", keyof T2> | Extract<"headerCellClassName", keyof T2> | Extract<"headerCellStyle", keyof T2> | Extract<"expandRowKeys", keyof T2> | Extract<"defaultSort", keyof T2> | Extract<"tooltipOptions", keyof T2> | Extract<"spanMethod", keyof T2> | Extract<"stripe", keyof T2> | Extract<"showHeader", keyof T2> | Extract<"showSummary", keyof T2> | Extract<"sumText", keyof T2> | Extract<"highlightCurrentRow", keyof T2> | Extract<"currentRowKey", keyof T2> | Extract<"emptyText", keyof T2> | Extract<"defaultExpandAll", keyof T2> | Extract<"tooltipEffect", keyof T2> | Extract<"selectOnIndeterminate", keyof T2> | Extract<"indent", keyof T2> | Extract<"treeProps", keyof T2> | Extract<"lazy", keyof T2> | Extract<"tableLayout", keyof T2> | Extract<"scrollbarAlwaysOn", keyof T2> | Extract<"flexible", keyof T2> | Extract<"appendFilterPanelTo", keyof T2> | Extract<"scrollbarTabindex", keyof T2>)[]>(propsArg: T2, excludes?: EX | undefined) => import("vue").ComputedRef<{ [P in EX extends (infer KE)[] ? Exclude<Extract<"data", keyof T2>, KE> | Exclude<Extract<"size", keyof T2>, KE> | Exclude<Extract<"load", keyof T2>, KE> | Exclude<Extract<"style", keyof T2>, KE> | Exclude<Extract<"maxHeight", keyof T2>, KE> | Exclude<Extract<"fit", keyof T2>, KE> | Exclude<Extract<"className", keyof T2>, KE> | Exclude<Extract<"height", keyof T2>, KE> | Exclude<Extract<"width", keyof T2>, KE> | Exclude<Extract<"border", keyof T2>, KE> | Exclude<Extract<"showOverflowTooltip", keyof T2>, KE> | Exclude<Extract<"rowKey", keyof T2>, KE> | Exclude<Extract<"summaryMethod", keyof T2>, KE> | Exclude<Extract<"rowClassName", keyof T2>, KE> | Exclude<Extract<"rowStyle", keyof T2>, KE> | Exclude<Extract<"cellClassName", keyof T2>, KE> | Exclude<Extract<"cellStyle", keyof T2>, KE> | Exclude<Extract<"headerRowClassName", keyof T2>, KE> | Exclude<Extract<"headerRowStyle", keyof T2>, KE> | Exclude<Extract<"headerCellClassName", keyof T2>, KE> | Exclude<Extract<"headerCellStyle", keyof T2>, KE> | Exclude<Extract<"expandRowKeys", keyof T2>, KE> | Exclude<Extract<"defaultSort", keyof T2>, KE> | Exclude<Extract<"tooltipOptions", keyof T2>, KE> | Exclude<Extract<"spanMethod", keyof T2>, KE> | Exclude<Extract<"stripe", keyof T2>, KE> | Exclude<Extract<"showHeader", keyof T2>, KE> | Exclude<Extract<"showSummary", keyof T2>, KE> | Exclude<Extract<"sumText", keyof T2>, KE> | Exclude<Extract<"highlightCurrentRow", keyof T2>, KE> | Exclude<Extract<"currentRowKey", keyof T2>, KE> | Exclude<Extract<"emptyText", keyof T2>, KE> | Exclude<Extract<"defaultExpandAll", keyof T2>, KE> | Exclude<Extract<"tooltipEffect", keyof T2>, KE> | Exclude<Extract<"selectOnIndeterminate", keyof T2>, KE> | Exclude<Extract<"indent", keyof T2>, KE> | Exclude<Extract<"treeProps", keyof T2>, KE> | Exclude<Extract<"lazy", keyof T2>, KE> | Exclude<Extract<"tableLayout", keyof T2>, KE> | Exclude<Extract<"scrollbarAlwaysOn", keyof T2>, KE> | Exclude<Extract<"flexible", keyof T2>, KE> | Exclude<Extract<"appendFilterPanelTo", keyof T2>, KE> | Exclude<Extract<"scrollbarTabindex", keyof T2>, KE> : Extract<"data", keyof T2> | Extract<"size", keyof T2> | Extract<"load", keyof T2> | Extract<"style", keyof T2> | Extract<"maxHeight", keyof T2> | Extract<"fit", keyof T2> | Extract<"className", keyof T2> | Extract<"height", keyof T2> | Extract<"width", keyof T2> | Extract<"border", keyof T2> | Extract<"showOverflowTooltip", keyof T2> | Extract<"rowKey", keyof T2> | Extract<"summaryMethod", keyof T2> | Extract<"rowClassName", keyof T2> | Extract<"rowStyle", keyof T2> | Extract<"cellClassName", keyof T2> | Extract<"cellStyle", keyof T2> | Extract<"headerRowClassName", keyof T2> | Extract<"headerRowStyle", keyof T2> | Extract<"headerCellClassName", keyof T2> | Extract<"headerCellStyle", keyof T2> | Extract<"expandRowKeys", keyof T2> | Extract<"defaultSort", keyof T2> | Extract<"tooltipOptions", keyof T2> | Extract<"spanMethod", keyof T2> | Extract<"stripe", keyof T2> | Extract<"showHeader", keyof T2> | Extract<"showSummary", keyof T2> | Extract<"sumText", keyof T2> | Extract<"highlightCurrentRow", keyof T2> | Extract<"currentRowKey", keyof T2> | Extract<"emptyText", keyof T2> | Extract<"defaultExpandAll", keyof T2> | Extract<"tooltipEffect", keyof T2> | Extract<"selectOnIndeterminate", keyof T2> | Extract<"indent", keyof T2> | Extract<"treeProps", keyof T2> | Extract<"lazy", keyof T2> | Extract<"tableLayout", keyof T2> | Extract<"scrollbarAlwaysOn", keyof T2> | Extract<"flexible", keyof T2> | Extract<"appendFilterPanelTo", keyof T2> | Extract<"scrollbarTabindex", keyof T2>]: { [k in Extract<"data", keyof T2> | Extract<"size", keyof T2> | Extract<"load", keyof T2> | Extract<"style", keyof T2> | Extract<"maxHeight", keyof T2> | Extract<"fit", keyof T2> | Extract<"className", keyof T2> | Extract<"height", keyof T2> | Extract<"width", keyof T2> | Extract<"border", keyof T2> | Extract<"showOverflowTooltip", keyof T2> | Extract<"rowKey", keyof T2> | Extract<"summaryMethod", keyof T2> | Extract<"rowClassName", keyof T2> | Extract<"rowStyle", keyof T2> | Extract<"cellClassName", keyof T2> | Extract<"cellStyle", keyof T2> | Extract<"headerRowClassName", keyof T2> | Extract<"headerRowStyle", keyof T2> | Extract<"headerCellClassName", keyof T2> | Extract<"headerCellStyle", keyof T2> | Extract<"expandRowKeys", keyof T2> | Extract<"defaultSort", keyof T2> | Extract<"tooltipOptions", keyof T2> | Extract<"spanMethod", keyof T2> | Extract<"stripe", keyof T2> | Extract<"showHeader", keyof T2> | Extract<"showSummary", keyof T2> | Extract<"sumText", keyof T2> | Extract<"highlightCurrentRow", keyof T2> | Extract<"currentRowKey", keyof T2> | Extract<"emptyText", keyof T2> | Extract<"defaultExpandAll", keyof T2> | Extract<"tooltipEffect", keyof T2> | Extract<"selectOnIndeterminate", keyof T2> | Extract<"indent", keyof T2> | Extract<"treeProps", keyof T2> | Extract<"lazy", keyof T2> | Extract<"tableLayout", keyof T2> | Extract<"scrollbarAlwaysOn", keyof T2> | Extract<"flexible", keyof T2> | Extract<"appendFilterPanelTo", keyof T2> | Extract<"scrollbarTabindex", keyof T2>]: T2[k]; }[P]; }>;
+export declare const tableEmits: {
+    select: null;
+    'select-all': null;
+    'selection-change': null;
+    'cell-mouse-enter': null;
+    'cell-mouse-leave': null;
+    'cell-contextmenu': null;
+    'cell-click': null;
+    'cell-dblclick': null;
+    'row-click': null;
+    'row-contextmenu': null;
+    'row-dblclick': null;
+    'header-click': null;
+    'header-contextmenu': null;
+    'sort-change': null;
+    'filter-change': null;
+    'current-change': null;
+    'header-dragend': null;
+    'expand-change': null;
+    scroll: null;
+};
+export declare const createElTableOnEmits: <T2 extends import("@vunk/core").AnyFunc, EX extends ("select" | "scroll" | "select-all" | "selection-change" | "cell-mouse-enter" | "cell-mouse-leave" | "cell-contextmenu" | "cell-click" | "cell-dblclick" | "row-click" | "row-contextmenu" | "row-dblclick" | "header-click" | "header-contextmenu" | "sort-change" | "filter-change" | "current-change" | "header-dragend" | "expand-change")[]>(emit: T2, excludes?: EX | undefined) => { [P in EX extends (infer KE)[] ? Exclude<"select", KE> | Exclude<"scroll", KE> | Exclude<"select-all", KE> | Exclude<"selection-change", KE> | Exclude<"cell-mouse-enter", KE> | Exclude<"cell-mouse-leave", KE> | Exclude<"cell-contextmenu", KE> | Exclude<"cell-click", KE> | Exclude<"cell-dblclick", KE> | Exclude<"row-click", KE> | Exclude<"row-contextmenu", KE> | Exclude<"row-dblclick", KE> | Exclude<"header-click", KE> | Exclude<"header-contextmenu", KE> | Exclude<"sort-change", KE> | Exclude<"filter-change", KE> | Exclude<"current-change", KE> | Exclude<"header-dragend", KE> | Exclude<"expand-change", KE> : "select" | "scroll" | "select-all" | "selection-change" | "cell-mouse-enter" | "cell-mouse-leave" | "cell-contextmenu" | "cell-click" | "cell-dblclick" | "row-click" | "row-contextmenu" | "row-dblclick" | "header-click" | "header-contextmenu" | "sort-change" | "filter-change" | "current-change" | "header-dragend" | "expand-change"]: {
+    select: (...e: import("@vunk/core").RestParameters<T2>) => void;
+    'select-all': (...e: import("@vunk/core").RestParameters<T2>) => void;
+    'selection-change': (...e: import("@vunk/core").RestParameters<T2>) => void;
+    'cell-mouse-enter': (...e: import("@vunk/core").RestParameters<T2>) => void;
+    'cell-mouse-leave': (...e: import("@vunk/core").RestParameters<T2>) => void;
+    'cell-contextmenu': (...e: import("@vunk/core").RestParameters<T2>) => void;
+    'cell-click': (...e: import("@vunk/core").RestParameters<T2>) => void;
+    'cell-dblclick': (...e: import("@vunk/core").RestParameters<T2>) => void;
+    'row-click': (...e: import("@vunk/core").RestParameters<T2>) => void;
+    'row-contextmenu': (...e: import("@vunk/core").RestParameters<T2>) => void;
+    'row-dblclick': (...e: import("@vunk/core").RestParameters<T2>) => void;
+    'header-click': (...e: import("@vunk/core").RestParameters<T2>) => void;
+    'header-contextmenu': (...e: import("@vunk/core").RestParameters<T2>) => void;
+    'sort-change': (...e: import("@vunk/core").RestParameters<T2>) => void;
+    'filter-change': (...e: import("@vunk/core").RestParameters<T2>) => void;
+    'current-change': (...e: import("@vunk/core").RestParameters<T2>) => void;
+    'header-dragend': (...e: import("@vunk/core").RestParameters<T2>) => void;
+    'expand-change': (...e: import("@vunk/core").RestParameters<T2>) => void;
+    scroll: (...e: import("@vunk/core").RestParameters<T2>) => void;
+}[P]; };
+export {};