element-plus
Version:
A Component Library for Vue 3
357 lines (356 loc) • 21.9 kB
TypeScript
export { Alignment as TableV2Alignment, FixedDir as TableV2FixedDir, SortOrder as TableV2SortOrder, } from './src/constants';
export { default as TableV2 } from './src/table-v2';
export * from './src/auto-resizer';
export { placeholderSign as TableV2Placeholder } from './src/private';
export declare const ElTableV2: import("element-plus/es/utils").SFCWithInstall<import("vue").DefineComponent<{
readonly cache: import("element-plus/es/utils").EpPropFinalized<NumberConstructor, never, never, 2, false>;
readonly estimatedRowHeight: {
readonly default: undefined;
readonly type: import("vue").PropType<number>;
readonly required: false;
readonly validator: ((val: unknown) => boolean) | undefined;
readonly __epPropKey: true;
};
readonly rowKey: import("element-plus/es/utils").EpPropFinalized<(new (...args: any[]) => import("./src/types").KeyType & {}) | (() => import("./src/types").KeyType) | ((new (...args: any[]) => import("./src/types").KeyType & {}) | (() => import("./src/types").KeyType))[], unknown, unknown, "id", boolean>;
readonly headerClass: {
readonly type: import("vue").PropType<import("element-plus/es/utils").EpPropMergeType<(new (...args: any[]) => (string | import("./src/table").HeaderClassNameGetter<any>) & {}) | (() => string | import("./src/table").HeaderClassNameGetter<any>) | ((new (...args: any[]) => (string | import("./src/table").HeaderClassNameGetter<any>) & {}) | (() => string | import("./src/table").HeaderClassNameGetter<any>))[], unknown, unknown>>;
readonly required: false;
readonly validator: ((val: unknown) => boolean) | undefined;
__epPropKey: true;
};
readonly headerProps: {
readonly type: import("vue").PropType<any>;
readonly required: false;
readonly validator: ((val: unknown) => boolean) | undefined;
__epPropKey: true;
};
readonly headerCellProps: {
readonly type: import("vue").PropType<any>;
readonly required: false;
readonly validator: ((val: unknown) => boolean) | undefined;
__epPropKey: true;
};
readonly headerHeight: import("element-plus/es/utils").EpPropFinalized<(new (...args: any[]) => (number | number[]) & {}) | (() => number | number[]) | ((new (...args: any[]) => (number | number[]) & {}) | (() => number | number[]))[], unknown, unknown, 50, boolean>;
readonly footerHeight: import("element-plus/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, 0, boolean>;
readonly rowClass: {
readonly type: import("vue").PropType<import("element-plus/es/utils").EpPropMergeType<(new (...args: any[]) => (string | import("./src/table").RowClassNameGetter<any>) & {}) | (() => string | import("./src/table").RowClassNameGetter<any>) | ((new (...args: any[]) => (string | import("./src/table").RowClassNameGetter<any>) & {}) | (() => string | import("./src/table").RowClassNameGetter<any>))[], unknown, unknown>>;
readonly required: false;
readonly validator: ((val: unknown) => boolean) | undefined;
__epPropKey: true;
};
readonly rowProps: {
readonly type: import("vue").PropType<any>;
readonly required: false;
readonly validator: ((val: unknown) => boolean) | undefined;
__epPropKey: true;
};
readonly rowHeight: import("element-plus/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, 50, boolean>;
readonly cellProps: {
readonly type: import("vue").PropType<import("element-plus/es/utils").EpPropMergeType<(new (...args: any[]) => Record<string, any> | import("./src/table").ExtraCellPropGetter<any>) | (() => Record<string, any> | import("./src/table").ExtraCellPropGetter<any>) | ((new (...args: any[]) => Record<string, any> | import("./src/table").ExtraCellPropGetter<any>) | (() => Record<string, any> | import("./src/table").ExtraCellPropGetter<any>))[], unknown, unknown>>;
readonly required: false;
readonly validator: ((val: unknown) => boolean) | undefined;
__epPropKey: true;
};
readonly columns: {
readonly type: import("vue").PropType<import("./src/common").AnyColumn[]>;
readonly required: true;
readonly validator: ((val: unknown) => boolean) | undefined;
__epPropKey: true;
};
readonly data: {
readonly type: import("vue").PropType<any[]>;
readonly required: true;
readonly validator: ((val: unknown) => boolean) | undefined;
__epPropKey: true;
};
readonly dataGetter: {
readonly type: import("vue").PropType<import("./src/types").DataGetter<any>>;
readonly required: false;
readonly validator: ((val: unknown) => boolean) | undefined;
__epPropKey: true;
};
readonly fixedData: {
readonly type: import("vue").PropType<any[]>;
readonly required: false;
readonly validator: ((val: unknown) => boolean) | undefined;
__epPropKey: true;
};
readonly expandColumnKey: StringConstructor;
readonly expandedRowKeys: import("element-plus/es/utils").EpPropFinalized<(new (...args: any[]) => import("./src/types").KeyType[]) | (() => import("./src/types").KeyType[]) | ((new (...args: any[]) => import("./src/types").KeyType[]) | (() => import("./src/types").KeyType[]))[], unknown, unknown, () => never[], boolean>;
readonly defaultExpandedRowKeys: import("element-plus/es/utils").EpPropFinalized<(new (...args: any[]) => import("./src/types").KeyType[]) | (() => import("./src/types").KeyType[]) | ((new (...args: any[]) => import("./src/types").KeyType[]) | (() => import("./src/types").KeyType[]))[], unknown, unknown, () => never[], boolean>;
readonly class: StringConstructor;
readonly fixed: BooleanConstructor;
readonly style: {
readonly type: import("vue").PropType<import("vue").CSSProperties>;
readonly required: false;
readonly validator: ((val: unknown) => boolean) | undefined;
__epPropKey: true;
};
readonly width: {
readonly type: import("vue").PropType<number>;
readonly required: true;
readonly validator: ((val: unknown) => boolean) | undefined;
__epPropKey: true;
};
readonly height: {
readonly type: import("vue").PropType<number>;
readonly required: true;
readonly validator: ((val: unknown) => boolean) | undefined;
__epPropKey: true;
};
readonly maxHeight: NumberConstructor;
readonly useIsScrolling: BooleanConstructor;
readonly indentSize: import("element-plus/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, 12, boolean>;
readonly iconSize: import("element-plus/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, 12, boolean>;
readonly hScrollbarSize: import("element-plus/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, 6, boolean>;
readonly vScrollbarSize: import("element-plus/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, 6, boolean>;
readonly scrollbarAlwaysOn: BooleanConstructor;
readonly sortBy: import("element-plus/es/utils").EpPropFinalized<(new (...args: any[]) => import("./src/types").SortBy) | (() => import("./src/types").SortBy) | ((new (...args: any[]) => import("./src/types").SortBy) | (() => import("./src/types").SortBy))[], unknown, unknown, () => {
key: import("./src/types").KeyType;
order: import("./src/constants").SortOrder;
}, boolean>;
readonly sortState: import("element-plus/es/utils").EpPropFinalized<(new (...args: any[]) => import("./src/types").SortState) | (() => import("./src/types").SortState) | ((new (...args: any[]) => import("./src/types").SortState) | (() => import("./src/types").SortState))[], unknown, unknown, undefined, boolean>;
readonly onColumnSort: {
readonly type: import("vue").PropType<import("./src/table").ColumnSortHandler<any>>;
readonly required: false;
readonly validator: ((val: unknown) => boolean) | undefined;
__epPropKey: true;
};
readonly onExpandedRowsChange: {
readonly type: import("vue").PropType<import("./src/table").ExpandedRowsChangeHandler>;
readonly required: false;
readonly validator: ((val: unknown) => boolean) | undefined;
__epPropKey: true;
};
readonly onEndReached: {
readonly type: import("vue").PropType<(distance: number) => void>;
readonly required: false;
readonly validator: ((val: unknown) => boolean) | undefined;
__epPropKey: true;
};
readonly onRowExpand: {
readonly type: import("vue").PropType<import("./src/row").RowExpandHandler>;
readonly required: false;
readonly validator: ((val: unknown) => boolean) | undefined;
__epPropKey: true;
};
readonly onScroll: {
readonly type: import("vue").PropType<(...args: any[]) => void>;
readonly required: false;
readonly validator: ((val: unknown) => boolean) | undefined;
__epPropKey: true;
};
readonly onRowsRendered: {
readonly type: import("vue").PropType<(params: import("./src/grid").onRowRenderedParams) => void>;
readonly required: false;
readonly validator: ((val: unknown) => boolean) | undefined;
__epPropKey: true;
};
readonly rowEventHandlers: {
readonly type: import("vue").PropType<import("./src/row").RowEventHandlers>;
readonly required: false;
readonly validator: ((val: unknown) => boolean) | undefined;
__epPropKey: true;
};
}, () => JSX.Element, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
readonly cache: import("element-plus/es/utils").EpPropFinalized<NumberConstructor, never, never, 2, false>;
readonly estimatedRowHeight: {
readonly default: undefined;
readonly type: import("vue").PropType<number>;
readonly required: false;
readonly validator: ((val: unknown) => boolean) | undefined;
readonly __epPropKey: true;
};
readonly rowKey: import("element-plus/es/utils").EpPropFinalized<(new (...args: any[]) => import("./src/types").KeyType & {}) | (() => import("./src/types").KeyType) | ((new (...args: any[]) => import("./src/types").KeyType & {}) | (() => import("./src/types").KeyType))[], unknown, unknown, "id", boolean>;
readonly headerClass: {
readonly type: import("vue").PropType<import("element-plus/es/utils").EpPropMergeType<(new (...args: any[]) => (string | import("./src/table").HeaderClassNameGetter<any>) & {}) | (() => string | import("./src/table").HeaderClassNameGetter<any>) | ((new (...args: any[]) => (string | import("./src/table").HeaderClassNameGetter<any>) & {}) | (() => string | import("./src/table").HeaderClassNameGetter<any>))[], unknown, unknown>>;
readonly required: false;
readonly validator: ((val: unknown) => boolean) | undefined;
__epPropKey: true;
};
readonly headerProps: {
readonly type: import("vue").PropType<any>;
readonly required: false;
readonly validator: ((val: unknown) => boolean) | undefined;
__epPropKey: true;
};
readonly headerCellProps: {
readonly type: import("vue").PropType<any>;
readonly required: false;
readonly validator: ((val: unknown) => boolean) | undefined;
__epPropKey: true;
};
readonly headerHeight: import("element-plus/es/utils").EpPropFinalized<(new (...args: any[]) => (number | number[]) & {}) | (() => number | number[]) | ((new (...args: any[]) => (number | number[]) & {}) | (() => number | number[]))[], unknown, unknown, 50, boolean>;
readonly footerHeight: import("element-plus/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, 0, boolean>;
readonly rowClass: {
readonly type: import("vue").PropType<import("element-plus/es/utils").EpPropMergeType<(new (...args: any[]) => (string | import("./src/table").RowClassNameGetter<any>) & {}) | (() => string | import("./src/table").RowClassNameGetter<any>) | ((new (...args: any[]) => (string | import("./src/table").RowClassNameGetter<any>) & {}) | (() => string | import("./src/table").RowClassNameGetter<any>))[], unknown, unknown>>;
readonly required: false;
readonly validator: ((val: unknown) => boolean) | undefined;
__epPropKey: true;
};
readonly rowProps: {
readonly type: import("vue").PropType<any>;
readonly required: false;
readonly validator: ((val: unknown) => boolean) | undefined;
__epPropKey: true;
};
readonly rowHeight: import("element-plus/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, 50, boolean>;
readonly cellProps: {
readonly type: import("vue").PropType<import("element-plus/es/utils").EpPropMergeType<(new (...args: any[]) => Record<string, any> | import("./src/table").ExtraCellPropGetter<any>) | (() => Record<string, any> | import("./src/table").ExtraCellPropGetter<any>) | ((new (...args: any[]) => Record<string, any> | import("./src/table").ExtraCellPropGetter<any>) | (() => Record<string, any> | import("./src/table").ExtraCellPropGetter<any>))[], unknown, unknown>>;
readonly required: false;
readonly validator: ((val: unknown) => boolean) | undefined;
__epPropKey: true;
};
readonly columns: {
readonly type: import("vue").PropType<import("./src/common").AnyColumn[]>;
readonly required: true;
readonly validator: ((val: unknown) => boolean) | undefined;
__epPropKey: true;
};
readonly data: {
readonly type: import("vue").PropType<any[]>;
readonly required: true;
readonly validator: ((val: unknown) => boolean) | undefined;
__epPropKey: true;
};
readonly dataGetter: {
readonly type: import("vue").PropType<import("./src/types").DataGetter<any>>;
readonly required: false;
readonly validator: ((val: unknown) => boolean) | undefined;
__epPropKey: true;
};
readonly fixedData: {
readonly type: import("vue").PropType<any[]>;
readonly required: false;
readonly validator: ((val: unknown) => boolean) | undefined;
__epPropKey: true;
};
readonly expandColumnKey: StringConstructor;
readonly expandedRowKeys: import("element-plus/es/utils").EpPropFinalized<(new (...args: any[]) => import("./src/types").KeyType[]) | (() => import("./src/types").KeyType[]) | ((new (...args: any[]) => import("./src/types").KeyType[]) | (() => import("./src/types").KeyType[]))[], unknown, unknown, () => never[], boolean>;
readonly defaultExpandedRowKeys: import("element-plus/es/utils").EpPropFinalized<(new (...args: any[]) => import("./src/types").KeyType[]) | (() => import("./src/types").KeyType[]) | ((new (...args: any[]) => import("./src/types").KeyType[]) | (() => import("./src/types").KeyType[]))[], unknown, unknown, () => never[], boolean>;
readonly class: StringConstructor;
readonly fixed: BooleanConstructor;
readonly style: {
readonly type: import("vue").PropType<import("vue").CSSProperties>;
readonly required: false;
readonly validator: ((val: unknown) => boolean) | undefined;
__epPropKey: true;
};
readonly width: {
readonly type: import("vue").PropType<number>;
readonly required: true;
readonly validator: ((val: unknown) => boolean) | undefined;
__epPropKey: true;
};
readonly height: {
readonly type: import("vue").PropType<number>;
readonly required: true;
readonly validator: ((val: unknown) => boolean) | undefined;
__epPropKey: true;
};
readonly maxHeight: NumberConstructor;
readonly useIsScrolling: BooleanConstructor;
readonly indentSize: import("element-plus/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, 12, boolean>;
readonly iconSize: import("element-plus/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, 12, boolean>;
readonly hScrollbarSize: import("element-plus/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, 6, boolean>;
readonly vScrollbarSize: import("element-plus/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, 6, boolean>;
readonly scrollbarAlwaysOn: BooleanConstructor;
readonly sortBy: import("element-plus/es/utils").EpPropFinalized<(new (...args: any[]) => import("./src/types").SortBy) | (() => import("./src/types").SortBy) | ((new (...args: any[]) => import("./src/types").SortBy) | (() => import("./src/types").SortBy))[], unknown, unknown, () => {
key: import("./src/types").KeyType;
order: import("./src/constants").SortOrder;
}, boolean>;
readonly sortState: import("element-plus/es/utils").EpPropFinalized<(new (...args: any[]) => import("./src/types").SortState) | (() => import("./src/types").SortState) | ((new (...args: any[]) => import("./src/types").SortState) | (() => import("./src/types").SortState))[], unknown, unknown, undefined, boolean>;
readonly onColumnSort: {
readonly type: import("vue").PropType<import("./src/table").ColumnSortHandler<any>>;
readonly required: false;
readonly validator: ((val: unknown) => boolean) | undefined;
__epPropKey: true;
};
readonly onExpandedRowsChange: {
readonly type: import("vue").PropType<import("./src/table").ExpandedRowsChangeHandler>;
readonly required: false;
readonly validator: ((val: unknown) => boolean) | undefined;
__epPropKey: true;
};
readonly onEndReached: {
readonly type: import("vue").PropType<(distance: number) => void>;
readonly required: false;
readonly validator: ((val: unknown) => boolean) | undefined;
__epPropKey: true;
};
readonly onRowExpand: {
readonly type: import("vue").PropType<import("./src/row").RowExpandHandler>;
readonly required: false;
readonly validator: ((val: unknown) => boolean) | undefined;
__epPropKey: true;
};
readonly onScroll: {
readonly type: import("vue").PropType<(...args: any[]) => void>;
readonly required: false;
readonly validator: ((val: unknown) => boolean) | undefined;
__epPropKey: true;
};
readonly onRowsRendered: {
readonly type: import("vue").PropType<(params: import("./src/grid").onRowRenderedParams) => void>;
readonly required: false;
readonly validator: ((val: unknown) => boolean) | undefined;
__epPropKey: true;
};
readonly rowEventHandlers: {
readonly type: import("vue").PropType<import("./src/row").RowEventHandlers>;
readonly required: false;
readonly validator: ((val: unknown) => boolean) | undefined;
__epPropKey: true;
};
}>>, {
readonly fixed: boolean;
readonly scrollbarAlwaysOn: boolean;
readonly rowKey: import("element-plus/es/utils").EpPropMergeType<(new (...args: any[]) => import("./src/types").KeyType & {}) | (() => import("./src/types").KeyType) | ((new (...args: any[]) => import("./src/types").KeyType & {}) | (() => import("./src/types").KeyType))[], unknown, unknown>;
readonly headerHeight: import("element-plus/es/utils").EpPropMergeType<(new (...args: any[]) => (number | number[]) & {}) | (() => number | number[]) | ((new (...args: any[]) => (number | number[]) & {}) | (() => number | number[]))[], unknown, unknown>;
readonly sortBy: import("./src/types").SortBy;
readonly estimatedRowHeight: number;
readonly useIsScrolling: boolean;
readonly rowHeight: number;
readonly hScrollbarSize: number;
readonly vScrollbarSize: number;
readonly cache: number;
readonly footerHeight: number;
readonly indentSize: number;
readonly iconSize: number;
readonly sortState: import("./src/types").SortState;
readonly expandedRowKeys: import("./src/types").KeyType[];
readonly defaultExpandedRowKeys: import("./src/types").KeyType[];
}>> & Record<string, any>;
export declare const ElAutoResizer: import("element-plus/es/utils").SFCWithInstall<import("vue").DefineComponent<{
readonly disableWidth: BooleanConstructor;
readonly disableHeight: BooleanConstructor;
readonly onResize: {
readonly type: import("vue").PropType<(event: {
height: number;
width: number;
}) => void>;
readonly required: false;
readonly validator: ((val: unknown) => boolean) | undefined;
__epPropKey: true;
};
}, () => JSX.Element, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
readonly disableWidth: BooleanConstructor;
readonly disableHeight: BooleanConstructor;
readonly onResize: {
readonly type: import("vue").PropType<(event: {
height: number;
width: number;
}) => void>;
readonly required: false;
readonly validator: ((val: unknown) => boolean) | undefined;
__epPropKey: true;
};
}>>, {
readonly disableWidth: boolean;
readonly disableHeight: boolean;
}>> & Record<string, any>;
export type { Column, Columns, SortBy, SortState, TableV2CustomizedHeaderSlotParam, } from './src/types';
export type { TableV2Instance } from './src/table-v2';
export * from './src/table';
export * from './src/row';
export type { HeaderCellSlotProps } from './src/renderers/header-cell';