UNPKG

element-plus

Version:

A Component Library for Vue 3

606 lines (605 loc) 26.1 kB
import Table from './src/table.vue'; import TableColumn from './src/tableColumn'; export declare const ElTable: import("element-plus/es/utils").SFCWithInstall<import("vue").DefineComponent<{ data: { type: import("vue").PropType<any[]>; default: () => never[]; }; size: StringConstructor; width: (StringConstructor | NumberConstructor)[]; height: (StringConstructor | NumberConstructor)[]; maxHeight: (StringConstructor | NumberConstructor)[]; fit: { type: BooleanConstructor; default: boolean; }; stripe: BooleanConstructor; border: BooleanConstructor; rowKey: import("vue").PropType<string | ((row: any) => string) | undefined>; showHeader: { type: BooleanConstructor; default: boolean; }; showSummary: BooleanConstructor; sumText: StringConstructor; summaryMethod: import("vue").PropType<import("./src/table/defaults").SummaryMethod<any> | undefined>; rowClassName: import("vue").PropType<import("./src/table/defaults").ColumnCls<any> | undefined>; rowStyle: import("vue").PropType<import("./src/table/defaults").ColumnStyle<any> | undefined>; cellClassName: import("vue").PropType<(string | ((data: { row: any; rowIndex: number; column: import("./src/table-column/defaults").TableColumnCtx<any>; columnIndex: number; }) => string)) | undefined>; cellStyle: import("vue").PropType<(import("vue").CSSProperties | ((data: { row: any; rowIndex: number; column: import("./src/table-column/defaults").TableColumnCtx<any>; columnIndex: number; }) => import("vue").CSSProperties)) | undefined>; headerRowClassName: import("vue").PropType<import("./src/table/defaults").ColumnCls<any> | undefined>; headerRowStyle: import("vue").PropType<import("./src/table/defaults").ColumnStyle<any> | undefined>; headerCellClassName: import("vue").PropType<(string | ((data: { row: any; rowIndex: number; column: import("./src/table-column/defaults").TableColumnCtx<any>; columnIndex: number; }) => string)) | undefined>; headerCellStyle: import("vue").PropType<(import("vue").CSSProperties | ((data: { row: any; rowIndex: number; column: import("./src/table-column/defaults").TableColumnCtx<any>; columnIndex: number; }) => import("vue").CSSProperties)) | undefined>; highlightCurrentRow: BooleanConstructor; currentRowKey: (StringConstructor | NumberConstructor)[]; emptyText: StringConstructor; expandRowKeys: import("vue").PropType<any[] | undefined>; defaultExpandAll: BooleanConstructor; defaultSort: import("vue").PropType<import("./src/table/defaults").Sort | undefined>; tooltipEffect: StringConstructor; spanMethod: import("vue").PropType<((data: { row: any; rowIndex: number; column: import("./src/table-column/defaults").TableColumnCtx<any>; columnIndex: number; }) => number[] | { rowspan: number; colspan: number; } | undefined) | undefined>; selectOnIndeterminate: { type: BooleanConstructor; default: boolean; }; indent: { type: NumberConstructor; default: number; }; treeProps: { type: import("vue").PropType<{ hasChildren?: string | undefined; children?: string | undefined; } | undefined>; default: () => { hasChildren: string; children: string; }; }; lazy: BooleanConstructor; load: import("vue").PropType<((row: any, treeNode: import("./src/table/defaults").TreeNode, resolve: (data: any[]) => void) => void) | undefined>; style: { type: import("vue").PropType<import("vue").CSSProperties>; default: () => {}; }; className: { type: StringConstructor; default: string; }; tableLayout: { type: import("vue").PropType<"auto" | "fixed">; default: string; }; scrollbarAlwaysOn: { type: BooleanConstructor; default: boolean; }; flexible: BooleanConstructor; }, { ns: { namespace: import("vue").Ref<string>; b: (blockSuffix?: string) => string; e: (element?: string | undefined) => string; m: (modifier?: string | undefined) => string; be: (blockSuffix?: string | undefined, element?: string | undefined) => string; em: (element?: string | undefined, modifier?: string | undefined) => string; bm: (blockSuffix?: string | undefined, modifier?: string | undefined) => string; bem: (blockSuffix?: string | undefined, element?: string | undefined, modifier?: string | undefined) => string; is: { (name: string, state: boolean | undefined): string; (name: string): string; }; cssVar: (object: Record<string, string>) => Record<string, string>; cssVarName: (name: string) => string; cssVarBlock: (object: Record<string, string>) => Record<string, string>; cssVarBlockName: (name: string) => string; }; layout: import("./src/table-layout").default<any>; store: any; handleHeaderFooterMousewheel: (event: any, data: any) => void; handleMouseLeave: () => void; tableId: string; tableSize: import("vue").ComputedRef<"" | "default" | "small" | "large">; isHidden: import("vue").Ref<boolean>; isEmpty: import("vue").ComputedRef<boolean>; renderExpanded: import("vue").Ref<null>; resizeProxyVisible: import("vue").Ref<boolean>; resizeState: import("vue").Ref<{ width: number | null; height: number | null; headerHeight: number | null; }>; isGroup: import("vue").Ref<boolean>; bodyWidth: import("vue").ComputedRef<string>; tableBodyStyles: import("vue").ComputedRef<{ width: string; }>; emptyBlockStyle: import("vue").ComputedRef<{ width: string; height: string; } | null>; debouncedUpdateLayout: import("lodash").DebouncedFunc<() => void>; handleFixedMousewheel: (event: any, data: any) => void; setCurrentRow: (row: any) => void; getSelectionRows: () => any; toggleRowSelection: (row: any, selected: boolean) => void; clearSelection: () => void; clearFilter: (columnKeys: string[]) => void; toggleAllSelection: () => void; toggleRowExpansion: (row: any, expanded?: boolean | undefined) => void; clearSort: () => void; doLayout: () => void; sort: (prop: string, order: string) => void; t: import("../..").Translator; setDragVisible: (visible: boolean) => void; context: import("./src/table/defaults").Table<any>; computedSumText: import("vue").ComputedRef<string>; computedEmptyText: import("vue").ComputedRef<string>; tableLayout: import("vue").ComputedRef<"auto" | "fixed">; 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>; scrollTo: (options: number | ScrollToOptions, yCoord?: number | undefined) => void; setScrollLeft: (left?: number | undefined) => void; setScrollTop: (top?: number | undefined) => void; }, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, ("select-all" | "expand-change" | "current-change" | "select" | "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" | "header-dragend")[], "select" | "select-all" | "expand-change" | "current-change" | "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" | "header-dragend", import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{ data: { type: import("vue").PropType<any[]>; default: () => never[]; }; size: StringConstructor; width: (StringConstructor | NumberConstructor)[]; height: (StringConstructor | NumberConstructor)[]; maxHeight: (StringConstructor | NumberConstructor)[]; fit: { type: BooleanConstructor; default: boolean; }; stripe: BooleanConstructor; border: BooleanConstructor; rowKey: import("vue").PropType<string | ((row: any) => string) | undefined>; showHeader: { type: BooleanConstructor; default: boolean; }; showSummary: BooleanConstructor; sumText: StringConstructor; summaryMethod: import("vue").PropType<import("./src/table/defaults").SummaryMethod<any> | undefined>; rowClassName: import("vue").PropType<import("./src/table/defaults").ColumnCls<any> | undefined>; rowStyle: import("vue").PropType<import("./src/table/defaults").ColumnStyle<any> | undefined>; cellClassName: import("vue").PropType<(string | ((data: { row: any; rowIndex: number; column: import("./src/table-column/defaults").TableColumnCtx<any>; columnIndex: number; }) => string)) | undefined>; cellStyle: import("vue").PropType<(import("vue").CSSProperties | ((data: { row: any; rowIndex: number; column: import("./src/table-column/defaults").TableColumnCtx<any>; columnIndex: number; }) => import("vue").CSSProperties)) | undefined>; headerRowClassName: import("vue").PropType<import("./src/table/defaults").ColumnCls<any> | undefined>; headerRowStyle: import("vue").PropType<import("./src/table/defaults").ColumnStyle<any> | undefined>; headerCellClassName: import("vue").PropType<(string | ((data: { row: any; rowIndex: number; column: import("./src/table-column/defaults").TableColumnCtx<any>; columnIndex: number; }) => string)) | undefined>; headerCellStyle: import("vue").PropType<(import("vue").CSSProperties | ((data: { row: any; rowIndex: number; column: import("./src/table-column/defaults").TableColumnCtx<any>; columnIndex: number; }) => import("vue").CSSProperties)) | undefined>; highlightCurrentRow: BooleanConstructor; currentRowKey: (StringConstructor | NumberConstructor)[]; emptyText: StringConstructor; expandRowKeys: import("vue").PropType<any[] | undefined>; defaultExpandAll: BooleanConstructor; defaultSort: import("vue").PropType<import("./src/table/defaults").Sort | undefined>; tooltipEffect: StringConstructor; spanMethod: import("vue").PropType<((data: { row: any; rowIndex: number; column: import("./src/table-column/defaults").TableColumnCtx<any>; columnIndex: number; }) => number[] | { rowspan: number; colspan: number; } | undefined) | undefined>; selectOnIndeterminate: { type: BooleanConstructor; default: boolean; }; indent: { type: NumberConstructor; default: number; }; treeProps: { type: import("vue").PropType<{ hasChildren?: string | undefined; children?: string | undefined; } | undefined>; default: () => { hasChildren: string; children: string; }; }; lazy: BooleanConstructor; load: import("vue").PropType<((row: any, treeNode: import("./src/table/defaults").TreeNode, resolve: (data: any[]) => void) => void) | undefined>; style: { type: import("vue").PropType<import("vue").CSSProperties>; default: () => {}; }; className: { type: StringConstructor; default: string; }; tableLayout: { type: import("vue").PropType<"auto" | "fixed">; default: string; }; scrollbarAlwaysOn: { type: BooleanConstructor; default: boolean; }; flexible: BooleanConstructor; }>> & { onSelect?: ((...args: any[]) => any) | undefined; "onExpand-change"?: ((...args: any[]) => any) | undefined; "onCurrent-change"?: ((...args: any[]) => any) | undefined; "onSelect-all"?: ((...args: any[]) => any) | undefined; "onSelection-change"?: ((...args: any[]) => any) | undefined; "onCell-mouse-enter"?: ((...args: any[]) => any) | undefined; "onCell-mouse-leave"?: ((...args: any[]) => any) | undefined; "onCell-contextmenu"?: ((...args: any[]) => any) | undefined; "onCell-click"?: ((...args: any[]) => any) | undefined; "onCell-dblclick"?: ((...args: any[]) => any) | undefined; "onRow-click"?: ((...args: any[]) => any) | undefined; "onRow-contextmenu"?: ((...args: any[]) => any) | undefined; "onRow-dblclick"?: ((...args: any[]) => any) | undefined; "onHeader-click"?: ((...args: any[]) => any) | undefined; "onHeader-contextmenu"?: ((...args: any[]) => any) | undefined; "onSort-change"?: ((...args: any[]) => any) | undefined; "onFilter-change"?: ((...args: any[]) => any) | undefined; "onHeader-dragend"?: ((...args: any[]) => any) | undefined; }, { lazy: boolean; style: import("vue").CSSProperties; className: string; border: boolean; tableLayout: "auto" | "fixed"; data: any[]; fit: boolean; scrollbarAlwaysOn: boolean; stripe: boolean; treeProps: { hasChildren?: string | undefined; children?: string | undefined; } | undefined; showHeader: boolean; showSummary: boolean; highlightCurrentRow: boolean; defaultExpandAll: boolean; selectOnIndeterminate: boolean; indent: number; flexible: boolean; }>> & { TableColumn: import("vue").DefineComponent<{ type: { type: StringConstructor; default: string; }; label: StringConstructor; className: StringConstructor; labelClassName: StringConstructor; property: StringConstructor; prop: StringConstructor; width: { type: (StringConstructor | NumberConstructor)[]; default: string; }; minWidth: { type: (StringConstructor | NumberConstructor)[]; default: string; }; renderHeader: import("vue").PropType<(data: { column: import("./src/table-column/defaults").TableColumnCtx<any>; $index: number; }) => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any; }>>; sortable: { type: (BooleanConstructor | StringConstructor)[]; default: boolean; }; sortMethod: import("vue").PropType<(a: any, b: any) => number>; sortBy: import("vue").PropType<string | string[] | ((row: any, index: number) => string)>; resizable: { type: BooleanConstructor; default: boolean; }; columnKey: StringConstructor; align: StringConstructor; headerAlign: StringConstructor; showTooltipWhenOverflow: BooleanConstructor; showOverflowTooltip: BooleanConstructor; fixed: (BooleanConstructor | StringConstructor)[]; formatter: import("vue").PropType<(row: any, column: import("./src/table-column/defaults").TableColumnCtx<any>, cellValue: any, index: number) => string | import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any; }>>; selectable: import("vue").PropType<(row: any, index: number) => boolean>; reserveSelection: BooleanConstructor; filterMethod: import("vue").PropType<import("./src/table-column/defaults").FilterMethods<any>>; filteredValue: import("vue").PropType<string[]>; filters: import("vue").PropType<import("./src/table-column/defaults").Filters>; filterPlacement: StringConstructor; filterMultiple: { type: BooleanConstructor; default: boolean; }; index: import("vue").PropType<number | ((index: number) => number)>; sortOrders: { type: import("vue").PropType<("ascending" | "descending" | null)[]>; default: () => (string | null)[]; validator: (val: ("ascending" | "descending" | null)[]) => boolean; }; }, void, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{ type: { type: StringConstructor; default: string; }; label: StringConstructor; className: StringConstructor; labelClassName: StringConstructor; property: StringConstructor; prop: StringConstructor; width: { type: (StringConstructor | NumberConstructor)[]; default: string; }; minWidth: { type: (StringConstructor | NumberConstructor)[]; default: string; }; renderHeader: import("vue").PropType<(data: { column: import("./src/table-column/defaults").TableColumnCtx<any>; $index: number; }) => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any; }>>; sortable: { type: (BooleanConstructor | StringConstructor)[]; default: boolean; }; sortMethod: import("vue").PropType<(a: any, b: any) => number>; sortBy: import("vue").PropType<string | string[] | ((row: any, index: number) => string)>; resizable: { type: BooleanConstructor; default: boolean; }; columnKey: StringConstructor; align: StringConstructor; headerAlign: StringConstructor; showTooltipWhenOverflow: BooleanConstructor; showOverflowTooltip: BooleanConstructor; fixed: (BooleanConstructor | StringConstructor)[]; formatter: import("vue").PropType<(row: any, column: import("./src/table-column/defaults").TableColumnCtx<any>, cellValue: any, index: number) => string | import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any; }>>; selectable: import("vue").PropType<(row: any, index: number) => boolean>; reserveSelection: BooleanConstructor; filterMethod: import("vue").PropType<import("./src/table-column/defaults").FilterMethods<any>>; filteredValue: import("vue").PropType<string[]>; filters: import("vue").PropType<import("./src/table-column/defaults").Filters>; filterPlacement: StringConstructor; filterMultiple: { type: BooleanConstructor; default: boolean; }; index: import("vue").PropType<number | ((index: number) => number)>; sortOrders: { type: import("vue").PropType<("ascending" | "descending" | null)[]>; default: () => (string | null)[]; validator: (val: ("ascending" | "descending" | null)[]) => boolean; }; }>>, { type: string; width: string | number; minWidth: string | number; sortOrders: ("ascending" | "descending" | null)[]; sortable: string | boolean; resizable: boolean; showTooltipWhenOverflow: boolean; showOverflowTooltip: boolean; reserveSelection: boolean; filterMultiple: boolean; }>; }; export default ElTable; export declare const ElTableColumn: import("element-plus/es/utils").SFCWithInstall<import("vue").DefineComponent<{ type: { type: StringConstructor; default: string; }; label: StringConstructor; className: StringConstructor; labelClassName: StringConstructor; property: StringConstructor; prop: StringConstructor; width: { type: (StringConstructor | NumberConstructor)[]; default: string; }; minWidth: { type: (StringConstructor | NumberConstructor)[]; default: string; }; renderHeader: import("vue").PropType<(data: { column: import("./src/table-column/defaults").TableColumnCtx<any>; $index: number; }) => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any; }>>; sortable: { type: (BooleanConstructor | StringConstructor)[]; default: boolean; }; sortMethod: import("vue").PropType<(a: any, b: any) => number>; sortBy: import("vue").PropType<string | string[] | ((row: any, index: number) => string)>; resizable: { type: BooleanConstructor; default: boolean; }; columnKey: StringConstructor; align: StringConstructor; headerAlign: StringConstructor; showTooltipWhenOverflow: BooleanConstructor; showOverflowTooltip: BooleanConstructor; fixed: (BooleanConstructor | StringConstructor)[]; formatter: import("vue").PropType<(row: any, column: import("./src/table-column/defaults").TableColumnCtx<any>, cellValue: any, index: number) => string | import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any; }>>; selectable: import("vue").PropType<(row: any, index: number) => boolean>; reserveSelection: BooleanConstructor; filterMethod: import("vue").PropType<import("./src/table-column/defaults").FilterMethods<any>>; filteredValue: import("vue").PropType<string[]>; filters: import("vue").PropType<import("./src/table-column/defaults").Filters>; filterPlacement: StringConstructor; filterMultiple: { type: BooleanConstructor; default: boolean; }; index: import("vue").PropType<number | ((index: number) => number)>; sortOrders: { type: import("vue").PropType<("ascending" | "descending" | null)[]>; default: () => (string | null)[]; validator: (val: ("ascending" | "descending" | null)[]) => boolean; }; }, void, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{ type: { type: StringConstructor; default: string; }; label: StringConstructor; className: StringConstructor; labelClassName: StringConstructor; property: StringConstructor; prop: StringConstructor; width: { type: (StringConstructor | NumberConstructor)[]; default: string; }; minWidth: { type: (StringConstructor | NumberConstructor)[]; default: string; }; renderHeader: import("vue").PropType<(data: { column: import("./src/table-column/defaults").TableColumnCtx<any>; $index: number; }) => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any; }>>; sortable: { type: (BooleanConstructor | StringConstructor)[]; default: boolean; }; sortMethod: import("vue").PropType<(a: any, b: any) => number>; sortBy: import("vue").PropType<string | string[] | ((row: any, index: number) => string)>; resizable: { type: BooleanConstructor; default: boolean; }; columnKey: StringConstructor; align: StringConstructor; headerAlign: StringConstructor; showTooltipWhenOverflow: BooleanConstructor; showOverflowTooltip: BooleanConstructor; fixed: (BooleanConstructor | StringConstructor)[]; formatter: import("vue").PropType<(row: any, column: import("./src/table-column/defaults").TableColumnCtx<any>, cellValue: any, index: number) => string | import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any; }>>; selectable: import("vue").PropType<(row: any, index: number) => boolean>; reserveSelection: BooleanConstructor; filterMethod: import("vue").PropType<import("./src/table-column/defaults").FilterMethods<any>>; filteredValue: import("vue").PropType<string[]>; filters: import("vue").PropType<import("./src/table-column/defaults").Filters>; filterPlacement: StringConstructor; filterMultiple: { type: BooleanConstructor; default: boolean; }; index: import("vue").PropType<number | ((index: number) => number)>; sortOrders: { type: import("vue").PropType<("ascending" | "descending" | null)[]>; default: () => (string | null)[]; validator: (val: ("ascending" | "descending" | null)[]) => boolean; }; }>>, { type: string; width: string | number; minWidth: string | number; sortOrders: ("ascending" | "descending" | null)[]; sortable: string | boolean; resizable: boolean; showTooltipWhenOverflow: boolean; showOverflowTooltip: boolean; reserveSelection: boolean; filterMultiple: boolean; }>>; export declare type TableInstance = InstanceType<typeof Table>; export declare type TableColumnInstance = InstanceType<typeof TableColumn>; export type { SummaryMethod, Table, TableProps, TableRefs, ColumnCls, ColumnStyle, TreeNode, RenderRowData, Sort, Filter, } from './src/table/defaults';