hongluan-ui
Version:
Hongluan Component Library for Vue 3
354 lines (353 loc) • 16 kB
TypeScript
import type { ScrollStrategy } from './composables/use-scrollbar';
declare const TableV2: import("vue").DefineComponent<{
readonly cache: import("../../../utils").EpPropFinalized<import("vue").PropType<number>, unknown, unknown, number, boolean>;
readonly estimatedRowHeight: {
readonly type: import("vue").PropType<number>;
readonly required: false;
readonly validator: (val: unknown) => boolean;
__epPropKey: true;
};
readonly rowKey: import("../../../utils").EpPropFinalized<import("vue").PropType<import("./types").KeyType>, unknown, unknown, "id", boolean>;
readonly headerClass: {
readonly type: import("vue").PropType<import("../../../utils").EpPropMergeType<import("vue").PropType<string | import("./table").HeaderClassNameGetter<any>>, unknown, unknown>>;
readonly required: false;
readonly validator: (val: unknown) => boolean;
__epPropKey: true;
};
readonly headerProps: {
readonly type: import("vue").PropType<any>;
readonly required: false;
readonly validator: (val: unknown) => boolean;
__epPropKey: true;
};
readonly headerCellProps: {
readonly type: import("vue").PropType<any>;
readonly required: false;
readonly validator: (val: unknown) => boolean;
__epPropKey: true;
};
readonly headerHeight: import("../../../utils").EpPropFinalized<import("vue").PropType<number | number[]>, unknown, unknown, 50, boolean>;
readonly footerHeight: import("../../../utils").EpPropFinalized<NumberConstructor, unknown, unknown, 0, boolean>;
readonly rowClass: {
readonly type: import("vue").PropType<import("../../../utils").EpPropMergeType<import("vue").PropType<string | import("./table").RowClassNameGetter<any>>, unknown, unknown>>;
readonly required: false;
readonly validator: (val: unknown) => boolean;
__epPropKey: true;
};
readonly rowProps: {
readonly type: import("vue").PropType<any>;
readonly required: false;
readonly validator: (val: unknown) => boolean;
__epPropKey: true;
};
readonly rowHeight: import("../../../utils").EpPropFinalized<NumberConstructor, unknown, unknown, 50, boolean>;
readonly cellProps: {
readonly type: import("vue").PropType<unknown>;
readonly required: false;
readonly validator: (val: unknown) => boolean;
__epPropKey: true;
};
readonly columns: {
readonly type: import("vue").PropType<import("./common").AnyColumn[]>;
readonly required: true;
readonly validator: (val: unknown) => boolean;
__epPropKey: true;
};
readonly data: {
readonly type: import("vue").PropType<any[]>;
readonly required: true;
readonly validator: (val: unknown) => boolean;
__epPropKey: true;
};
readonly dataGetter: {
readonly type: import("vue").PropType<import("./types").DataGetter<any>>;
readonly required: false;
readonly validator: (val: unknown) => boolean;
__epPropKey: true;
};
readonly fixedData: {
readonly type: import("vue").PropType<any[]>;
readonly required: false;
readonly validator: (val: unknown) => boolean;
__epPropKey: true;
};
readonly expandColumnKey: StringConstructor;
readonly expandedRowKeys: import("../../../utils").EpPropFinalized<import("vue").PropType<import("./types").KeyType[]>, unknown, unknown, () => any[], boolean>;
readonly defaultExpandedRowKeys: import("../../../utils").EpPropFinalized<import("vue").PropType<import("./types").KeyType[]>, unknown, unknown, () => any[], boolean>;
readonly class: StringConstructor;
readonly fixed: BooleanConstructor;
readonly style: {
readonly type: import("vue").PropType<any>;
readonly required: false;
readonly validator: (val: unknown) => boolean;
__epPropKey: true;
};
readonly width: {
readonly type: import("vue").PropType<number>;
readonly required: true;
readonly validator: (val: unknown) => boolean;
__epPropKey: true;
};
readonly height: {
readonly type: import("vue").PropType<number>;
readonly required: true;
readonly validator: (val: unknown) => boolean;
__epPropKey: true;
};
readonly maxHeight: NumberConstructor;
readonly useIsScrolling: BooleanConstructor;
readonly indentSize: import("../../../utils").EpPropFinalized<NumberConstructor, unknown, unknown, 12, boolean>;
readonly iconSize: import("../../../utils").EpPropFinalized<NumberConstructor, unknown, unknown, 12, boolean>;
readonly hScrollbarSize: import("../../../utils").EpPropFinalized<NumberConstructor, unknown, unknown, 6, boolean>;
readonly vScrollbarSize: import("../../../utils").EpPropFinalized<NumberConstructor, unknown, unknown, 6, boolean>;
readonly scrollbarAlwaysOn: BooleanConstructor;
readonly sortBy: import("../../../utils").EpPropFinalized<import("vue").PropType<import("./types").SortBy>, unknown, unknown, () => {
key: import("./types").KeyType;
order: import("./constants").SortOrder;
}, boolean>;
readonly sortState: {
readonly type: import("vue").PropType<import("./types").SortState>;
readonly required: false;
readonly validator: (val: unknown) => boolean;
__epPropKey: true;
};
readonly onColumnSort: {
readonly type: import("vue").PropType<import("./table").ColumnSortHandler<any>>;
readonly required: false;
readonly validator: (val: unknown) => boolean;
__epPropKey: true;
};
readonly onExpandedRowsChange: {
readonly type: import("vue").PropType<import("./table").ExpandedRowsChangeHandler>;
readonly required: false;
readonly validator: (val: unknown) => boolean;
__epPropKey: true;
};
readonly onEndReached: {
readonly type: import("vue").PropType<(distance: number) => void>;
readonly required: false;
readonly validator: (val: unknown) => boolean;
__epPropKey: true;
};
readonly onRowExpand: {
readonly type: import("vue").PropType<import("./row").RowExpandHandler>;
readonly required: false;
readonly validator: (val: unknown) => boolean;
__epPropKey: true;
};
readonly onScroll: {
readonly type: import("vue").PropType<(...args: any[]) => void>;
readonly required: false;
readonly validator: (val: unknown) => boolean;
__epPropKey: true;
};
readonly onRowsRendered: {
readonly type: import("vue").PropType<(params: import("./grid").onRowRenderedParams) => void>;
readonly required: false;
readonly validator: (val: unknown) => boolean;
__epPropKey: true;
};
readonly rowEventHandlers: {
readonly type: import("vue").PropType<unknown>;
readonly required: false;
readonly validator: (val: unknown) => boolean;
__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("../../../utils").EpPropFinalized<import("vue").PropType<number>, unknown, unknown, number, boolean>;
readonly estimatedRowHeight: {
readonly type: import("vue").PropType<number>;
readonly required: false;
readonly validator: (val: unknown) => boolean;
__epPropKey: true;
};
readonly rowKey: import("../../../utils").EpPropFinalized<import("vue").PropType<import("./types").KeyType>, unknown, unknown, "id", boolean>;
readonly headerClass: {
readonly type: import("vue").PropType<import("../../../utils").EpPropMergeType<import("vue").PropType<string | import("./table").HeaderClassNameGetter<any>>, unknown, unknown>>;
readonly required: false;
readonly validator: (val: unknown) => boolean;
__epPropKey: true;
};
readonly headerProps: {
readonly type: import("vue").PropType<any>;
readonly required: false;
readonly validator: (val: unknown) => boolean;
__epPropKey: true;
};
readonly headerCellProps: {
readonly type: import("vue").PropType<any>;
readonly required: false;
readonly validator: (val: unknown) => boolean;
__epPropKey: true;
};
readonly headerHeight: import("../../../utils").EpPropFinalized<import("vue").PropType<number | number[]>, unknown, unknown, 50, boolean>;
readonly footerHeight: import("../../../utils").EpPropFinalized<NumberConstructor, unknown, unknown, 0, boolean>;
readonly rowClass: {
readonly type: import("vue").PropType<import("../../../utils").EpPropMergeType<import("vue").PropType<string | import("./table").RowClassNameGetter<any>>, unknown, unknown>>;
readonly required: false;
readonly validator: (val: unknown) => boolean;
__epPropKey: true;
};
readonly rowProps: {
readonly type: import("vue").PropType<any>;
readonly required: false;
readonly validator: (val: unknown) => boolean;
__epPropKey: true;
};
readonly rowHeight: import("../../../utils").EpPropFinalized<NumberConstructor, unknown, unknown, 50, boolean>;
readonly cellProps: {
readonly type: import("vue").PropType<unknown>;
readonly required: false;
readonly validator: (val: unknown) => boolean;
__epPropKey: true;
};
readonly columns: {
readonly type: import("vue").PropType<import("./common").AnyColumn[]>;
readonly required: true;
readonly validator: (val: unknown) => boolean;
__epPropKey: true;
};
readonly data: {
readonly type: import("vue").PropType<any[]>;
readonly required: true;
readonly validator: (val: unknown) => boolean;
__epPropKey: true;
};
readonly dataGetter: {
readonly type: import("vue").PropType<import("./types").DataGetter<any>>;
readonly required: false;
readonly validator: (val: unknown) => boolean;
__epPropKey: true;
};
readonly fixedData: {
readonly type: import("vue").PropType<any[]>;
readonly required: false;
readonly validator: (val: unknown) => boolean;
__epPropKey: true;
};
readonly expandColumnKey: StringConstructor;
readonly expandedRowKeys: import("../../../utils").EpPropFinalized<import("vue").PropType<import("./types").KeyType[]>, unknown, unknown, () => any[], boolean>;
readonly defaultExpandedRowKeys: import("../../../utils").EpPropFinalized<import("vue").PropType<import("./types").KeyType[]>, unknown, unknown, () => any[], boolean>;
readonly class: StringConstructor;
readonly fixed: BooleanConstructor;
readonly style: {
readonly type: import("vue").PropType<any>;
readonly required: false;
readonly validator: (val: unknown) => boolean;
__epPropKey: true;
};
readonly width: {
readonly type: import("vue").PropType<number>;
readonly required: true;
readonly validator: (val: unknown) => boolean;
__epPropKey: true;
};
readonly height: {
readonly type: import("vue").PropType<number>;
readonly required: true;
readonly validator: (val: unknown) => boolean;
__epPropKey: true;
};
readonly maxHeight: NumberConstructor;
readonly useIsScrolling: BooleanConstructor;
readonly indentSize: import("../../../utils").EpPropFinalized<NumberConstructor, unknown, unknown, 12, boolean>;
readonly iconSize: import("../../../utils").EpPropFinalized<NumberConstructor, unknown, unknown, 12, boolean>;
readonly hScrollbarSize: import("../../../utils").EpPropFinalized<NumberConstructor, unknown, unknown, 6, boolean>;
readonly vScrollbarSize: import("../../../utils").EpPropFinalized<NumberConstructor, unknown, unknown, 6, boolean>;
readonly scrollbarAlwaysOn: BooleanConstructor;
readonly sortBy: import("../../../utils").EpPropFinalized<import("vue").PropType<import("./types").SortBy>, unknown, unknown, () => {
key: import("./types").KeyType;
order: import("./constants").SortOrder;
}, boolean>;
readonly sortState: {
readonly type: import("vue").PropType<import("./types").SortState>;
readonly required: false;
readonly validator: (val: unknown) => boolean;
__epPropKey: true;
};
readonly onColumnSort: {
readonly type: import("vue").PropType<import("./table").ColumnSortHandler<any>>;
readonly required: false;
readonly validator: (val: unknown) => boolean;
__epPropKey: true;
};
readonly onExpandedRowsChange: {
readonly type: import("vue").PropType<import("./table").ExpandedRowsChangeHandler>;
readonly required: false;
readonly validator: (val: unknown) => boolean;
__epPropKey: true;
};
readonly onEndReached: {
readonly type: import("vue").PropType<(distance: number) => void>;
readonly required: false;
readonly validator: (val: unknown) => boolean;
__epPropKey: true;
};
readonly onRowExpand: {
readonly type: import("vue").PropType<import("./row").RowExpandHandler>;
readonly required: false;
readonly validator: (val: unknown) => boolean;
__epPropKey: true;
};
readonly onScroll: {
readonly type: import("vue").PropType<(...args: any[]) => void>;
readonly required: false;
readonly validator: (val: unknown) => boolean;
__epPropKey: true;
};
readonly onRowsRendered: {
readonly type: import("vue").PropType<(params: import("./grid").onRowRenderedParams) => void>;
readonly required: false;
readonly validator: (val: unknown) => boolean;
__epPropKey: true;
};
readonly rowEventHandlers: {
readonly type: import("vue").PropType<unknown>;
readonly required: false;
readonly validator: (val: unknown) => boolean;
__epPropKey: true;
};
}>>, {
fixed: boolean;
headerHeight: import("../../../utils").EpPropMergeType<import("vue").PropType<number | number[]>, unknown, unknown>;
useIsScrolling: boolean;
scrollbarAlwaysOn: boolean;
cache: number;
rowHeight: number;
hScrollbarSize: number;
vScrollbarSize: number;
rowKey: import("../../../utils").EpPropMergeType<import("vue").PropType<import("./types").KeyType>, unknown, unknown>;
footerHeight: number;
indentSize: number;
iconSize: number;
sortBy: import("./types").SortBy;
expandedRowKeys: import("./types").KeyType[];
defaultExpandedRowKeys: import("./types").KeyType[];
}>;
export default TableV2;
export declare type TableV2Instance = InstanceType<typeof TableV2> & {
/**
* @description scroll to a given position
* @params params {{ scrollLeft?: number, scrollTop?: number }} where to scroll to.
*/
scrollTo: (param: {
scrollLeft?: number;
scrollTop?: number;
}) => void;
/**
* @description scroll to a given position horizontally
* @params scrollLeft {Number} where to scroll to.
*/
scrollToLeft: (scrollLeft: number) => void;
/**
* @description scroll to a given position vertically
* @params scrollTop { Number } where to scroll to.
*/
scrollToTop: (scrollTop: number) => void;
/**
* @description scroll to a given row
* @params row {Number} which row to scroll to
* @params strategy {ScrollStrategy} use what strategy to scroll to
*/
scrollToRow(row: number, strategy?: ScrollStrategy): void;
};