x-next 0.0.0-alpha.70 → 0.0.0-alpha.71
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +74 -70
- package/dist/_hooks/_types.d.ts +3 -0
- package/dist/_hooks/use-scrollbar.d.ts +1 -1
- package/dist/_utils/array.d.ts +2 -0
- package/dist/components/_components/auto-tooltip/auto-tooltip.d.ts +10 -0
- package/dist/components/_components/auto-tooltip/style/index.d.ts +0 -0
- package/dist/components/form-select/index.d.ts +40 -39
- package/dist/components/index.d.ts +2 -0
- package/dist/components/menu/Menu.d.ts +2 -2
- package/dist/components/pagination/Pagination.d.ts +351 -0
- package/dist/components/pagination/index.d.ts +297 -0
- package/dist/components/pagination/interface.d.ts +26 -0
- package/dist/components/pagination/page-item-ellipsis.vue.d.ts +91 -0
- package/dist/components/pagination/page-item-step.vue.d.ts +160 -0
- package/dist/components/pagination/page-item.vue.d.ts +53 -0
- package/dist/components/pagination/page-jumper.vue.d.ts +346 -0
- package/dist/components/pagination/page-options.vue.d.ts +2032 -0
- package/dist/components/pagination/utils.d.ts +4 -0
- package/dist/components/scrollbar-v2/index.d.ts +15 -14
- package/dist/components/table/Table.d.ts +931 -0
- package/dist/components/table/TableColumn.d.ts +292 -0
- package/dist/components/table/context.d.ts +29 -0
- package/dist/components/table/hooks/use-column-filter.d.ts +18 -0
- package/dist/components/table/hooks/use-column-resize.d.ts +10 -0
- package/dist/components/table/hooks/use-column-sorter.d.ts +14 -0
- package/dist/components/table/hooks/use-drag.d.ts +18 -0
- package/dist/components/table/hooks/use-expand.d.ts +20 -0
- package/dist/components/table/hooks/use-filter.d.ts +11 -0
- package/dist/components/table/hooks/use-pagination.d.ts +7 -0
- package/dist/components/table/hooks/use-row-selection.d.ts +26 -0
- package/dist/components/table/hooks/use-sorter.d.ts +17 -0
- package/dist/components/table/hooks/use-span.d.ts +18 -0
- package/dist/components/table/index.d.ts +952 -0
- package/dist/components/table/interface.d.ts +467 -0
- package/dist/components/table/table-col-group.vue.d.ts +38 -0
- package/dist/components/table/table-operation-td.d.ts +573 -0
- package/dist/components/table/table-operation-th.d.ts +41 -0
- package/dist/components/table/table-tbody.d.ts +4 -0
- package/dist/components/table/table-td.d.ts +124 -0
- package/dist/components/table/table-th.d.ts +39 -0
- package/dist/components/table/table-thead.d.ts +4 -0
- package/dist/components/table/table-tr.d.ts +41 -0
- package/dist/components/table/utils.d.ts +38 -0
- package/dist/components/trigger/index.d.ts +1 -0
- package/dist/components/trigger-v2/index.d.ts +1 -0
- package/dist/components/virtual-list-v2/interface.d.ts +1 -1
- package/dist/icons/index.d.ts +2 -2
- package/dist/index.es.js +11590 -7940
- package/dist/index.umd.js +2 -2
- package/dist/style.css +1 -1
- package/dist/types.d.ts +3 -0
- package/package.json +1 -1
- package/volar.d.ts +75 -72
- package/dist/icons/default/left.d.ts +0 -50
- package/dist/icons/default/right.d.ts +0 -50
@@ -0,0 +1,931 @@
|
|
1
|
+
import { PropType } from 'vue';
|
2
|
+
import { Size } from '../../_utils/constant';
|
3
|
+
import { TableBorder, TableChangeExtra, TableColumnData, TableComponents, TableData, TableDraggable, TableExpandable, TableOperationColumn, TablePagePosition, TableRowSelection } from './interface';
|
4
|
+
import { PaginationProps } from '../pagination';
|
5
|
+
import { VirtualListProps } from '../virtual-list-v2/interface';
|
6
|
+
import { ScrollbarProps } from '../scrollbar-v2';
|
7
|
+
import { BaseType } from '../../_hooks/_types';
|
8
|
+
declare const _default: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
|
9
|
+
/**
|
10
|
+
* @zh 表格的列描述信息
|
11
|
+
* @en Column info of the table
|
12
|
+
*/
|
13
|
+
columns: {
|
14
|
+
type: PropType<TableColumnData[]>;
|
15
|
+
default: () => never[];
|
16
|
+
};
|
17
|
+
/**
|
18
|
+
* @zh 表格的数据
|
19
|
+
* @en Table data
|
20
|
+
*/
|
21
|
+
data: {
|
22
|
+
type: PropType<TableData[]>;
|
23
|
+
default: () => never[];
|
24
|
+
};
|
25
|
+
/**
|
26
|
+
* @zh 是否显示边框
|
27
|
+
* @en Whether to show the border
|
28
|
+
*/
|
29
|
+
bordered: {
|
30
|
+
type: PropType<boolean | TableBorder>;
|
31
|
+
default: boolean;
|
32
|
+
};
|
33
|
+
/**
|
34
|
+
* @zh 是否显示选中效果
|
35
|
+
* @en Whether to show the hover effect
|
36
|
+
*/
|
37
|
+
hoverable: {
|
38
|
+
type: BooleanConstructor;
|
39
|
+
default: boolean;
|
40
|
+
};
|
41
|
+
/**
|
42
|
+
* @zh 是否开启斑马纹效果
|
43
|
+
* @en Whether to enable the stripe effect
|
44
|
+
*/
|
45
|
+
stripe: {
|
46
|
+
type: BooleanConstructor;
|
47
|
+
default: boolean;
|
48
|
+
};
|
49
|
+
/**
|
50
|
+
* @zh 表格的大小
|
51
|
+
* @en The size of the table
|
52
|
+
* @values 'mini','small','medium','large'
|
53
|
+
* @defaultValue 'large'
|
54
|
+
*/
|
55
|
+
size: {
|
56
|
+
type: PropType<Size>;
|
57
|
+
default: string;
|
58
|
+
};
|
59
|
+
/**
|
60
|
+
* @zh 表格的 table-layout 属性设置为 fixed,设置为 fixed 后,表格的宽度不会被内容撑开超出 100%。
|
61
|
+
* @en The table-layout property of the table is set to fixed. After it is set to fixed, the width of the table will not be stretched beyond 100% by the content.
|
62
|
+
*/
|
63
|
+
tableLayoutFixed: {
|
64
|
+
type: BooleanConstructor;
|
65
|
+
default: boolean;
|
66
|
+
};
|
67
|
+
/**
|
68
|
+
* @zh 是否为加载中状态
|
69
|
+
* @en Whether it is loading state
|
70
|
+
*/
|
71
|
+
loading: {
|
72
|
+
type: (BooleanConstructor | ObjectConstructor)[];
|
73
|
+
default: boolean;
|
74
|
+
};
|
75
|
+
/**
|
76
|
+
* @zh 表格的行选择器配置
|
77
|
+
* @en Table row selector configuration
|
78
|
+
*/
|
79
|
+
rowSelection: {
|
80
|
+
type: PropType<TableRowSelection>;
|
81
|
+
};
|
82
|
+
/**
|
83
|
+
* @zh 表格的展开行配置
|
84
|
+
* @en Expand row configuration of the table
|
85
|
+
*/
|
86
|
+
expandable: {
|
87
|
+
type: PropType<TableExpandable>;
|
88
|
+
};
|
89
|
+
/**
|
90
|
+
* @zh 表格的滚动属性配置。`2.13.0` 版本增加字符型值的支持。`2.20.0` 版本增加 `minWidth`,`maxHeight` 的支持。
|
91
|
+
* @en Scrolling attribute configuration of the table. The `2.13.0` version adds support for character values. `2.20.0` version adds support for `minWidth`, `maxHeight`.
|
92
|
+
*/
|
93
|
+
scroll: {
|
94
|
+
type: PropType<{
|
95
|
+
x?: number | string;
|
96
|
+
y?: number | string;
|
97
|
+
minWidth?: number | string;
|
98
|
+
maxHeight?: number | string;
|
99
|
+
}>;
|
100
|
+
};
|
101
|
+
/**
|
102
|
+
* @zh 分页的属性配置
|
103
|
+
* @en Pagination properties configuration
|
104
|
+
*/
|
105
|
+
pagination: {
|
106
|
+
type: PropType<boolean | PaginationProps>;
|
107
|
+
default: boolean;
|
108
|
+
};
|
109
|
+
/**
|
110
|
+
* @zh 分页选择器的位置
|
111
|
+
* @en The position of the page selector
|
112
|
+
* @values 'tl','top',tr','bl','bottom','br'
|
113
|
+
*/
|
114
|
+
pagePosition: {
|
115
|
+
type: PropType<TablePagePosition>;
|
116
|
+
default: string;
|
117
|
+
};
|
118
|
+
/**
|
119
|
+
* @zh 树形表格的缩进距离
|
120
|
+
* @en The indentation distance of the tree table
|
121
|
+
*/
|
122
|
+
indentSize: {
|
123
|
+
type: NumberConstructor;
|
124
|
+
default: number;
|
125
|
+
};
|
126
|
+
/**
|
127
|
+
* @zh 表格行 `key` 的取值字段
|
128
|
+
* @en Value field of table row `key`
|
129
|
+
*/
|
130
|
+
rowKey: {
|
131
|
+
type: StringConstructor;
|
132
|
+
default: string;
|
133
|
+
};
|
134
|
+
/**
|
135
|
+
* @zh 是否显示表头
|
136
|
+
* @en Whether to show the header
|
137
|
+
*/
|
138
|
+
showHeader: {
|
139
|
+
type: BooleanConstructor;
|
140
|
+
default: boolean;
|
141
|
+
};
|
142
|
+
/**
|
143
|
+
* @zh 传递虚拟列表属性,传入此参数以开启虚拟滚动 [VirtualListProps](#VirtualListProps)
|
144
|
+
* @en Pass the virtual list attribute, pass in this parameter to turn on virtual scrolling [VirtualListProps](#VirtualListProps)
|
145
|
+
* @type VirtualListProps
|
146
|
+
*/
|
147
|
+
virtualListProps: {
|
148
|
+
type: PropType<VirtualListProps>;
|
149
|
+
};
|
150
|
+
/**
|
151
|
+
* @zh 单元格合并方法(索引从数据项开始计数)
|
152
|
+
* @en Cell merge method (The index starts counting from the data item)
|
153
|
+
* @version 2.10.0
|
154
|
+
*/
|
155
|
+
spanMethod: {
|
156
|
+
type: PropType<(data: {
|
157
|
+
record: TableData;
|
158
|
+
column: TableColumnData | TableOperationColumn;
|
159
|
+
rowIndex: number;
|
160
|
+
columnIndex: number;
|
161
|
+
}) => {
|
162
|
+
rowspan?: number;
|
163
|
+
colspan?: number;
|
164
|
+
} | void>;
|
165
|
+
};
|
166
|
+
/**
|
167
|
+
* @zh 是否让合并方法的索引包含所有
|
168
|
+
* @en Whether to make the index of the span method contain all
|
169
|
+
* @version 2.18.0
|
170
|
+
*/
|
171
|
+
spanAll: {
|
172
|
+
type: BooleanConstructor;
|
173
|
+
default: boolean;
|
174
|
+
};
|
175
|
+
components: {
|
176
|
+
type: PropType<TableComponents>;
|
177
|
+
};
|
178
|
+
/**
|
179
|
+
* @zh 数据懒加载函数,传入时开启懒加载功能
|
180
|
+
* @en Data lazy loading function, open the lazy loading function when it is passed in
|
181
|
+
* @version 2.13.0
|
182
|
+
*/
|
183
|
+
loadMore: {
|
184
|
+
type: PropType<(record: TableData, done: (children?: TableData[]) => void) => void>;
|
185
|
+
};
|
186
|
+
/**
|
187
|
+
* @zh 筛选图标是否左对齐
|
188
|
+
* @en Whether the filter icon is aligned to the left
|
189
|
+
* @version 2.13.0
|
190
|
+
*/
|
191
|
+
filterIconAlignLeft: {
|
192
|
+
type: BooleanConstructor;
|
193
|
+
default: boolean;
|
194
|
+
};
|
195
|
+
/**
|
196
|
+
* @zh 是否在子树为空时隐藏展开按钮
|
197
|
+
* @en Whether to hide expand button when subtree is empty
|
198
|
+
* @version 2.14.0
|
199
|
+
*/
|
200
|
+
hideExpandButtonOnEmpty: {
|
201
|
+
type: BooleanConstructor;
|
202
|
+
default: boolean;
|
203
|
+
};
|
204
|
+
/**
|
205
|
+
* @zh 表格行元素的类名。`2.34.0` 版本增加函数值支持
|
206
|
+
* @en The class name of the table row element. The `2.34.0` version adds support for function values.
|
207
|
+
* @version 2.16.0
|
208
|
+
*/
|
209
|
+
rowClass: {
|
210
|
+
type: PropType<string | any[] | Record<string, any> | ((record: TableData, rowIndex: number) => any)>;
|
211
|
+
};
|
212
|
+
/**
|
213
|
+
* @zh 表格拖拽排序的配置
|
214
|
+
* @en Table drag and drop sorting configuration
|
215
|
+
* @version 2.16.0
|
216
|
+
*/
|
217
|
+
draggable: {
|
218
|
+
type: PropType<TableDraggable>;
|
219
|
+
};
|
220
|
+
rowNumber: {
|
221
|
+
type: (BooleanConstructor | ObjectConstructor)[];
|
222
|
+
};
|
223
|
+
/**
|
224
|
+
* @zh 是否允许调整列宽
|
225
|
+
* @en Whether to allow the column width to be adjusted
|
226
|
+
* @version 2.16.0
|
227
|
+
*/
|
228
|
+
columnResizable: {
|
229
|
+
type: BooleanConstructor;
|
230
|
+
};
|
231
|
+
/**
|
232
|
+
* @zh 显示表尾总结行
|
233
|
+
* @en Show footer summary row
|
234
|
+
* @version 2.21.0
|
235
|
+
*/
|
236
|
+
summary: {
|
237
|
+
type: PropType<boolean | ((params: {
|
238
|
+
columns: TableColumnData[];
|
239
|
+
data: TableData[];
|
240
|
+
}) => TableData[])>;
|
241
|
+
};
|
242
|
+
/**
|
243
|
+
* @zh 总结行的首列文字
|
244
|
+
* @en The first column of text in the summary line
|
245
|
+
* @version 2.21.0
|
246
|
+
*/
|
247
|
+
summaryText: {
|
248
|
+
type: StringConstructor;
|
249
|
+
default: string;
|
250
|
+
};
|
251
|
+
/**
|
252
|
+
* @zh 总结行的单元格合并方法
|
253
|
+
* @en Cell Merge Method for Summarizing Rows
|
254
|
+
* @version 2.21.0
|
255
|
+
*/
|
256
|
+
summarySpanMethod: {
|
257
|
+
type: PropType<(data: {
|
258
|
+
record: TableData;
|
259
|
+
column: TableColumnData | TableOperationColumn;
|
260
|
+
rowIndex: number;
|
261
|
+
columnIndex: number;
|
262
|
+
}) => {
|
263
|
+
rowspan?: number;
|
264
|
+
colspan?: number;
|
265
|
+
} | void>;
|
266
|
+
};
|
267
|
+
/**
|
268
|
+
* @zh 已选择的行(受控模式)优先于 `rowSelection`
|
269
|
+
* @en Selected row (controlled mode) takes precedence over `rowSelection`
|
270
|
+
* @version 2.25.0
|
271
|
+
*/
|
272
|
+
selectedKeys: {
|
273
|
+
type: PropType<(string | number)[]>;
|
274
|
+
};
|
275
|
+
/**
|
276
|
+
* @zh 默认已选择的行(非受控模式)优先于 `rowSelection`
|
277
|
+
* @en The selected row by default (uncontrolled mode) takes precedence over `rowSelection`
|
278
|
+
* @version 2.25.0
|
279
|
+
*/
|
280
|
+
defaultSelectedKeys: {
|
281
|
+
type: PropType<(string | number)[]>;
|
282
|
+
};
|
283
|
+
/**
|
284
|
+
* @zh 显示的展开行、子树(受控模式)优先于 `expandable`
|
285
|
+
* @en Displayed Expanded Row, Subtree (Controlled Mode) takes precedence over `expandable`
|
286
|
+
* @version 2.25.0
|
287
|
+
*/
|
288
|
+
expandedKeys: {
|
289
|
+
type: PropType<(string | number)[]>;
|
290
|
+
};
|
291
|
+
/**
|
292
|
+
* @zh 默认显示的展开行、子树(非受控模式)优先于 `expandable`
|
293
|
+
* @en Expand row, Subtree displayed by default (Uncontrolled mode) takes precedence over `expandable`
|
294
|
+
* @version 2.25.0
|
295
|
+
*/
|
296
|
+
defaultExpandedKeys: {
|
297
|
+
type: PropType<(string | number)[]>;
|
298
|
+
};
|
299
|
+
/**
|
300
|
+
* @zh 是否默认展开所有的行
|
301
|
+
* @en Whether to expand all rows by default
|
302
|
+
* @version 2.25.0
|
303
|
+
*/
|
304
|
+
defaultExpandAllRows: {
|
305
|
+
type: BooleanConstructor;
|
306
|
+
default: boolean;
|
307
|
+
};
|
308
|
+
/**
|
309
|
+
* @zh 是否开启表头吸顶
|
310
|
+
* @en Whether to open the sticky header
|
311
|
+
* @version 2.30.0
|
312
|
+
*/
|
313
|
+
stickyHeader: {
|
314
|
+
type: (BooleanConstructor | NumberConstructor)[];
|
315
|
+
default: boolean;
|
316
|
+
};
|
317
|
+
/**
|
318
|
+
* @zh 是否开启虚拟滚动条
|
319
|
+
* @en Whether to enable virtual scroll bar
|
320
|
+
* @version 2.38.0
|
321
|
+
*/
|
322
|
+
scrollbar: {
|
323
|
+
type: PropType<boolean | ScrollbarProps>;
|
324
|
+
default: boolean;
|
325
|
+
};
|
326
|
+
/**
|
327
|
+
* @zh 是否展示空子树
|
328
|
+
* @en Whether to display empty subtrees
|
329
|
+
* @version 2.51.0
|
330
|
+
*/
|
331
|
+
showEmptyTree: {
|
332
|
+
type: BooleanConstructor;
|
333
|
+
default: boolean;
|
334
|
+
};
|
335
|
+
}>, {
|
336
|
+
render: () => VNode;
|
337
|
+
selfExpand: (rowKey: BaseType | BaseType[], expanded?: boolean) => void;
|
338
|
+
selfExpandAll: (expanded?: boolean) => void;
|
339
|
+
selfSelect: (rowKey: BaseType | BaseType[], checked?: boolean) => void;
|
340
|
+
selfSelectAll: (checked?: boolean) => void;
|
341
|
+
selfResetFilters: (dataIndex?: string | string[]) => void;
|
342
|
+
selfClearFilters: (dataIndex?: string | string[]) => void;
|
343
|
+
selfResetSorters: () => void;
|
344
|
+
selfClearSorters: () => void;
|
345
|
+
}, {}, {}, {
|
346
|
+
/**
|
347
|
+
* @zh 设置全选状态
|
348
|
+
* @en Set select all state
|
349
|
+
* @param { boolean } checked
|
350
|
+
* @public
|
351
|
+
* @version 2.22.0
|
352
|
+
*/
|
353
|
+
selectAll(checked?: boolean): void;
|
354
|
+
/**
|
355
|
+
* @zh 设置行选择器状态
|
356
|
+
* @en Set row selector state
|
357
|
+
* @param { string | number | (string | number)[] } rowKey
|
358
|
+
* @param { boolean } checked
|
359
|
+
* @public
|
360
|
+
* @version 2.31.0
|
361
|
+
*/
|
362
|
+
select(rowKey: string | number | (string | number)[], checked?: boolean): void;
|
363
|
+
/**
|
364
|
+
* @zh 设置全部展开状态
|
365
|
+
* @en Set all expanded state
|
366
|
+
* @param { boolean } checked
|
367
|
+
* @public
|
368
|
+
* @version 2.31.0
|
369
|
+
*/
|
370
|
+
expandAll(checked?: boolean): void;
|
371
|
+
/**
|
372
|
+
* @zh 设置展开状态
|
373
|
+
* @en Set select all state
|
374
|
+
* @param { string | number | (string | number)[] } rowKey
|
375
|
+
* @param { boolean } checked
|
376
|
+
* @public
|
377
|
+
* @version 2.31.0
|
378
|
+
*/
|
379
|
+
expand(rowKey: string | number | (string | number)[], checked?: boolean): void;
|
380
|
+
/**
|
381
|
+
* @zh 重置列的筛选器
|
382
|
+
* @en Reset the filter for columns
|
383
|
+
* @param { string | string[] } dataIndex
|
384
|
+
* @public
|
385
|
+
* @version 2.31.0
|
386
|
+
*/
|
387
|
+
resetFilters(dataIndex?: string | string[]): void;
|
388
|
+
/**
|
389
|
+
* @zh 清空列的筛选器
|
390
|
+
* @en Clear the filter for columns
|
391
|
+
* @param { string | string[] } dataIndex
|
392
|
+
* @public
|
393
|
+
* @version 2.31.0
|
394
|
+
*/
|
395
|
+
clearFilters(dataIndex?: string | string[]): void;
|
396
|
+
/**
|
397
|
+
* @zh 重置列的排序
|
398
|
+
* @en Reset the order of columns
|
399
|
+
* @public
|
400
|
+
* @version 2.31.0
|
401
|
+
*/
|
402
|
+
resetSorters(): void;
|
403
|
+
/**
|
404
|
+
* @zh 清空列的排序
|
405
|
+
* @en Clear the order of columns
|
406
|
+
* @public
|
407
|
+
* @version 2.31.0
|
408
|
+
*/
|
409
|
+
clearSorters(): void;
|
410
|
+
}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
|
411
|
+
'update:selectedKeys': (rowKeys: (string | number)[]) => true;
|
412
|
+
'update:expandedKeys': (rowKeys: (string | number)[]) => true;
|
413
|
+
/**
|
414
|
+
* @zh 点击展开行时触发
|
415
|
+
* @en Triggered when a row is clicked to expand
|
416
|
+
* @param {string | number} rowKey
|
417
|
+
* @param {TableData} record
|
418
|
+
*/
|
419
|
+
expand: (rowKey: string | number, record: TableData) => true;
|
420
|
+
/**
|
421
|
+
* @zh 已展开的数据行发生改变时触发
|
422
|
+
* @en Triggered when the expanded data row changes
|
423
|
+
* @param {(string | number)[]} rowKeys
|
424
|
+
*/
|
425
|
+
expandedChange: (rowKeys: (string | number)[]) => true;
|
426
|
+
/**
|
427
|
+
* @zh 点击行选择器时触发
|
428
|
+
* @en Triggered when the row selector is clicked
|
429
|
+
* @param {string | number[]} rowKeys
|
430
|
+
* @param {string | number} rowKey
|
431
|
+
* @param {TableData} record
|
432
|
+
*/
|
433
|
+
select: (rowKeys: (string | number)[], rowKey: string | number, record: TableData) => true;
|
434
|
+
/**
|
435
|
+
* @zh 点击全选选择器时触发
|
436
|
+
* @en Triggered when the select all selector is clicked
|
437
|
+
* @param {boolean} checked
|
438
|
+
*/
|
439
|
+
selectAll: (checked: boolean) => true;
|
440
|
+
/**
|
441
|
+
* @zh 已选择的数据行发生改变时触发
|
442
|
+
* @en Triggered when the selected data row changes
|
443
|
+
* @param {(string | number)[]} rowKeys
|
444
|
+
*/
|
445
|
+
selectionChange: (rowKeys: (string | number)[]) => true;
|
446
|
+
/**
|
447
|
+
* @zh 排序规则发生改变时触发
|
448
|
+
* @en Triggered when the collation changes
|
449
|
+
* @param {string} dataIndex
|
450
|
+
* @param {string} direction
|
451
|
+
*/
|
452
|
+
sorterChange: (dataIndex: string, direction: string) => true;
|
453
|
+
/**
|
454
|
+
* @zh 过滤选项发生改变时触发
|
455
|
+
* @en Triggered when the filter options are changed
|
456
|
+
* @param {string} dataIndex
|
457
|
+
* @param {string[]} filteredValues
|
458
|
+
*/
|
459
|
+
filterChange: (dataIndex: string, filteredValues: string[]) => true;
|
460
|
+
/**
|
461
|
+
* @zh 表格分页发生改变时触发
|
462
|
+
* @en Triggered when the table pagination changes
|
463
|
+
* @param {number} page
|
464
|
+
*/
|
465
|
+
pageChange: (page: number) => true;
|
466
|
+
/**
|
467
|
+
* @zh 表格每页数据数量发生改变时触发
|
468
|
+
* @en Triggered when the number of data per page of the table changes
|
469
|
+
* @param {number} pageSize
|
470
|
+
*/
|
471
|
+
pageSizeChange: (pageSize: number) => true;
|
472
|
+
/**
|
473
|
+
* @zh 表格数据发生变化时触发
|
474
|
+
* @en Triggered when table data changes
|
475
|
+
* @param {TableData[]} data
|
476
|
+
* @param {TableChangeExtra} extra
|
477
|
+
* @param {TableData[]} currentData
|
478
|
+
* @version 2.40.0 增加 currentData
|
479
|
+
*/
|
480
|
+
change: (data: TableData[], extra: TableChangeExtra, currentData: TableData[]) => true;
|
481
|
+
/**
|
482
|
+
* @zh 单元格 hover 进入时触发
|
483
|
+
* @en Triggered when hovering into a cell
|
484
|
+
* @param {TableData} record
|
485
|
+
* @param {TableColumnData} column
|
486
|
+
* @param {Event} ev
|
487
|
+
*/
|
488
|
+
cellMouseEnter: (record: TableData, column: TableColumnData, ev: Event) => true;
|
489
|
+
/**
|
490
|
+
* @zh 单元格 hover 退出时触发
|
491
|
+
* @en Triggered when hovering out of a cell
|
492
|
+
* @param {TableData} record
|
493
|
+
* @param {TableColumnData} column
|
494
|
+
* @param {Event} ev
|
495
|
+
*/
|
496
|
+
cellMouseLeave: (record: TableData, column: TableColumnData, ev: Event) => true;
|
497
|
+
/**
|
498
|
+
* @zh 点击单元格时触发
|
499
|
+
* @en Triggered when a cell is clicked
|
500
|
+
* @param {TableData} record
|
501
|
+
* @param {TableColumnData} column
|
502
|
+
* @param {Event} ev
|
503
|
+
*/
|
504
|
+
cellClick: (record: TableData, column: TableColumnData, ev: Event) => true;
|
505
|
+
/**
|
506
|
+
* @zh 点击行数据时触发
|
507
|
+
* @en Triggered when row data is clicked
|
508
|
+
* @param {TableData} record
|
509
|
+
* @param {Event} ev
|
510
|
+
*/
|
511
|
+
rowClick: (record: TableData, ev: Event) => true;
|
512
|
+
/**
|
513
|
+
* @zh 点击表头数据时触发
|
514
|
+
* @en Triggered when the header data is clicked
|
515
|
+
* @param {TableColumnData} column
|
516
|
+
* @param {Event} ev
|
517
|
+
*/
|
518
|
+
headerClick: (column: TableColumnData, ev: Event) => true;
|
519
|
+
/**
|
520
|
+
* @zh 调整列宽时触发
|
521
|
+
* @en Triggered when column width is adjusted
|
522
|
+
* @param {string} dataIndex
|
523
|
+
* @param {number} width
|
524
|
+
* @version 2.28.0
|
525
|
+
*/
|
526
|
+
columnResize: (dataIndex: string, width: number) => true;
|
527
|
+
/**
|
528
|
+
* @zh 双击行数据时触发
|
529
|
+
* @en Triggered when row data is double clicked
|
530
|
+
* @param {TableData} record
|
531
|
+
* @param {Event} ev
|
532
|
+
*/
|
533
|
+
rowDblclick: (record: TableData, ev: Event) => true;
|
534
|
+
/**
|
535
|
+
* @zh 双击单元格时触发
|
536
|
+
* @en Triggered when a cell is double clicked
|
537
|
+
* @param {TableData} record
|
538
|
+
* @param {TableColumnData} column
|
539
|
+
* @param {Event} ev
|
540
|
+
*/
|
541
|
+
cellDblclick: (record: TableData, column: TableColumnData, ev: Event) => true;
|
542
|
+
/**
|
543
|
+
* @zh 右击行数据时触发
|
544
|
+
* @en Triggered when row data is right clicked
|
545
|
+
* @param {TableData} record
|
546
|
+
* @param {Event} ev
|
547
|
+
*/
|
548
|
+
rowContextmenu: (record: TableData, ev: Event) => true;
|
549
|
+
/**
|
550
|
+
* @zh 右击单元格时触发
|
551
|
+
* @en Triggered when a cell is right clicked
|
552
|
+
* @param {TableData} record
|
553
|
+
* @param {TableColumnData} column
|
554
|
+
* @param {Event} ev
|
555
|
+
*/
|
556
|
+
cellContextmenu: (record: TableData, column: TableColumnData, ev: Event) => true;
|
557
|
+
}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
|
558
|
+
/**
|
559
|
+
* @zh 表格的列描述信息
|
560
|
+
* @en Column info of the table
|
561
|
+
*/
|
562
|
+
columns: {
|
563
|
+
type: PropType<TableColumnData[]>;
|
564
|
+
default: () => never[];
|
565
|
+
};
|
566
|
+
/**
|
567
|
+
* @zh 表格的数据
|
568
|
+
* @en Table data
|
569
|
+
*/
|
570
|
+
data: {
|
571
|
+
type: PropType<TableData[]>;
|
572
|
+
default: () => never[];
|
573
|
+
};
|
574
|
+
/**
|
575
|
+
* @zh 是否显示边框
|
576
|
+
* @en Whether to show the border
|
577
|
+
*/
|
578
|
+
bordered: {
|
579
|
+
type: PropType<boolean | TableBorder>;
|
580
|
+
default: boolean;
|
581
|
+
};
|
582
|
+
/**
|
583
|
+
* @zh 是否显示选中效果
|
584
|
+
* @en Whether to show the hover effect
|
585
|
+
*/
|
586
|
+
hoverable: {
|
587
|
+
type: BooleanConstructor;
|
588
|
+
default: boolean;
|
589
|
+
};
|
590
|
+
/**
|
591
|
+
* @zh 是否开启斑马纹效果
|
592
|
+
* @en Whether to enable the stripe effect
|
593
|
+
*/
|
594
|
+
stripe: {
|
595
|
+
type: BooleanConstructor;
|
596
|
+
default: boolean;
|
597
|
+
};
|
598
|
+
/**
|
599
|
+
* @zh 表格的大小
|
600
|
+
* @en The size of the table
|
601
|
+
* @values 'mini','small','medium','large'
|
602
|
+
* @defaultValue 'large'
|
603
|
+
*/
|
604
|
+
size: {
|
605
|
+
type: PropType<Size>;
|
606
|
+
default: string;
|
607
|
+
};
|
608
|
+
/**
|
609
|
+
* @zh 表格的 table-layout 属性设置为 fixed,设置为 fixed 后,表格的宽度不会被内容撑开超出 100%。
|
610
|
+
* @en The table-layout property of the table is set to fixed. After it is set to fixed, the width of the table will not be stretched beyond 100% by the content.
|
611
|
+
*/
|
612
|
+
tableLayoutFixed: {
|
613
|
+
type: BooleanConstructor;
|
614
|
+
default: boolean;
|
615
|
+
};
|
616
|
+
/**
|
617
|
+
* @zh 是否为加载中状态
|
618
|
+
* @en Whether it is loading state
|
619
|
+
*/
|
620
|
+
loading: {
|
621
|
+
type: (BooleanConstructor | ObjectConstructor)[];
|
622
|
+
default: boolean;
|
623
|
+
};
|
624
|
+
/**
|
625
|
+
* @zh 表格的行选择器配置
|
626
|
+
* @en Table row selector configuration
|
627
|
+
*/
|
628
|
+
rowSelection: {
|
629
|
+
type: PropType<TableRowSelection>;
|
630
|
+
};
|
631
|
+
/**
|
632
|
+
* @zh 表格的展开行配置
|
633
|
+
* @en Expand row configuration of the table
|
634
|
+
*/
|
635
|
+
expandable: {
|
636
|
+
type: PropType<TableExpandable>;
|
637
|
+
};
|
638
|
+
/**
|
639
|
+
* @zh 表格的滚动属性配置。`2.13.0` 版本增加字符型值的支持。`2.20.0` 版本增加 `minWidth`,`maxHeight` 的支持。
|
640
|
+
* @en Scrolling attribute configuration of the table. The `2.13.0` version adds support for character values. `2.20.0` version adds support for `minWidth`, `maxHeight`.
|
641
|
+
*/
|
642
|
+
scroll: {
|
643
|
+
type: PropType<{
|
644
|
+
x?: number | string;
|
645
|
+
y?: number | string;
|
646
|
+
minWidth?: number | string;
|
647
|
+
maxHeight?: number | string;
|
648
|
+
}>;
|
649
|
+
};
|
650
|
+
/**
|
651
|
+
* @zh 分页的属性配置
|
652
|
+
* @en Pagination properties configuration
|
653
|
+
*/
|
654
|
+
pagination: {
|
655
|
+
type: PropType<boolean | PaginationProps>;
|
656
|
+
default: boolean;
|
657
|
+
};
|
658
|
+
/**
|
659
|
+
* @zh 分页选择器的位置
|
660
|
+
* @en The position of the page selector
|
661
|
+
* @values 'tl','top',tr','bl','bottom','br'
|
662
|
+
*/
|
663
|
+
pagePosition: {
|
664
|
+
type: PropType<TablePagePosition>;
|
665
|
+
default: string;
|
666
|
+
};
|
667
|
+
/**
|
668
|
+
* @zh 树形表格的缩进距离
|
669
|
+
* @en The indentation distance of the tree table
|
670
|
+
*/
|
671
|
+
indentSize: {
|
672
|
+
type: NumberConstructor;
|
673
|
+
default: number;
|
674
|
+
};
|
675
|
+
/**
|
676
|
+
* @zh 表格行 `key` 的取值字段
|
677
|
+
* @en Value field of table row `key`
|
678
|
+
*/
|
679
|
+
rowKey: {
|
680
|
+
type: StringConstructor;
|
681
|
+
default: string;
|
682
|
+
};
|
683
|
+
/**
|
684
|
+
* @zh 是否显示表头
|
685
|
+
* @en Whether to show the header
|
686
|
+
*/
|
687
|
+
showHeader: {
|
688
|
+
type: BooleanConstructor;
|
689
|
+
default: boolean;
|
690
|
+
};
|
691
|
+
/**
|
692
|
+
* @zh 传递虚拟列表属性,传入此参数以开启虚拟滚动 [VirtualListProps](#VirtualListProps)
|
693
|
+
* @en Pass the virtual list attribute, pass in this parameter to turn on virtual scrolling [VirtualListProps](#VirtualListProps)
|
694
|
+
* @type VirtualListProps
|
695
|
+
*/
|
696
|
+
virtualListProps: {
|
697
|
+
type: PropType<VirtualListProps>;
|
698
|
+
};
|
699
|
+
/**
|
700
|
+
* @zh 单元格合并方法(索引从数据项开始计数)
|
701
|
+
* @en Cell merge method (The index starts counting from the data item)
|
702
|
+
* @version 2.10.0
|
703
|
+
*/
|
704
|
+
spanMethod: {
|
705
|
+
type: PropType<(data: {
|
706
|
+
record: TableData;
|
707
|
+
column: TableColumnData | TableOperationColumn;
|
708
|
+
rowIndex: number;
|
709
|
+
columnIndex: number;
|
710
|
+
}) => {
|
711
|
+
rowspan?: number;
|
712
|
+
colspan?: number;
|
713
|
+
} | void>;
|
714
|
+
};
|
715
|
+
/**
|
716
|
+
* @zh 是否让合并方法的索引包含所有
|
717
|
+
* @en Whether to make the index of the span method contain all
|
718
|
+
* @version 2.18.0
|
719
|
+
*/
|
720
|
+
spanAll: {
|
721
|
+
type: BooleanConstructor;
|
722
|
+
default: boolean;
|
723
|
+
};
|
724
|
+
components: {
|
725
|
+
type: PropType<TableComponents>;
|
726
|
+
};
|
727
|
+
/**
|
728
|
+
* @zh 数据懒加载函数,传入时开启懒加载功能
|
729
|
+
* @en Data lazy loading function, open the lazy loading function when it is passed in
|
730
|
+
* @version 2.13.0
|
731
|
+
*/
|
732
|
+
loadMore: {
|
733
|
+
type: PropType<(record: TableData, done: (children?: TableData[]) => void) => void>;
|
734
|
+
};
|
735
|
+
/**
|
736
|
+
* @zh 筛选图标是否左对齐
|
737
|
+
* @en Whether the filter icon is aligned to the left
|
738
|
+
* @version 2.13.0
|
739
|
+
*/
|
740
|
+
filterIconAlignLeft: {
|
741
|
+
type: BooleanConstructor;
|
742
|
+
default: boolean;
|
743
|
+
};
|
744
|
+
/**
|
745
|
+
* @zh 是否在子树为空时隐藏展开按钮
|
746
|
+
* @en Whether to hide expand button when subtree is empty
|
747
|
+
* @version 2.14.0
|
748
|
+
*/
|
749
|
+
hideExpandButtonOnEmpty: {
|
750
|
+
type: BooleanConstructor;
|
751
|
+
default: boolean;
|
752
|
+
};
|
753
|
+
/**
|
754
|
+
* @zh 表格行元素的类名。`2.34.0` 版本增加函数值支持
|
755
|
+
* @en The class name of the table row element. The `2.34.0` version adds support for function values.
|
756
|
+
* @version 2.16.0
|
757
|
+
*/
|
758
|
+
rowClass: {
|
759
|
+
type: PropType<string | any[] | Record<string, any> | ((record: TableData, rowIndex: number) => any)>;
|
760
|
+
};
|
761
|
+
/**
|
762
|
+
* @zh 表格拖拽排序的配置
|
763
|
+
* @en Table drag and drop sorting configuration
|
764
|
+
* @version 2.16.0
|
765
|
+
*/
|
766
|
+
draggable: {
|
767
|
+
type: PropType<TableDraggable>;
|
768
|
+
};
|
769
|
+
rowNumber: {
|
770
|
+
type: (BooleanConstructor | ObjectConstructor)[];
|
771
|
+
};
|
772
|
+
/**
|
773
|
+
* @zh 是否允许调整列宽
|
774
|
+
* @en Whether to allow the column width to be adjusted
|
775
|
+
* @version 2.16.0
|
776
|
+
*/
|
777
|
+
columnResizable: {
|
778
|
+
type: BooleanConstructor;
|
779
|
+
};
|
780
|
+
/**
|
781
|
+
* @zh 显示表尾总结行
|
782
|
+
* @en Show footer summary row
|
783
|
+
* @version 2.21.0
|
784
|
+
*/
|
785
|
+
summary: {
|
786
|
+
type: PropType<boolean | ((params: {
|
787
|
+
columns: TableColumnData[];
|
788
|
+
data: TableData[];
|
789
|
+
}) => TableData[])>;
|
790
|
+
};
|
791
|
+
/**
|
792
|
+
* @zh 总结行的首列文字
|
793
|
+
* @en The first column of text in the summary line
|
794
|
+
* @version 2.21.0
|
795
|
+
*/
|
796
|
+
summaryText: {
|
797
|
+
type: StringConstructor;
|
798
|
+
default: string;
|
799
|
+
};
|
800
|
+
/**
|
801
|
+
* @zh 总结行的单元格合并方法
|
802
|
+
* @en Cell Merge Method for Summarizing Rows
|
803
|
+
* @version 2.21.0
|
804
|
+
*/
|
805
|
+
summarySpanMethod: {
|
806
|
+
type: PropType<(data: {
|
807
|
+
record: TableData;
|
808
|
+
column: TableColumnData | TableOperationColumn;
|
809
|
+
rowIndex: number;
|
810
|
+
columnIndex: number;
|
811
|
+
}) => {
|
812
|
+
rowspan?: number;
|
813
|
+
colspan?: number;
|
814
|
+
} | void>;
|
815
|
+
};
|
816
|
+
/**
|
817
|
+
* @zh 已选择的行(受控模式)优先于 `rowSelection`
|
818
|
+
* @en Selected row (controlled mode) takes precedence over `rowSelection`
|
819
|
+
* @version 2.25.0
|
820
|
+
*/
|
821
|
+
selectedKeys: {
|
822
|
+
type: PropType<(string | number)[]>;
|
823
|
+
};
|
824
|
+
/**
|
825
|
+
* @zh 默认已选择的行(非受控模式)优先于 `rowSelection`
|
826
|
+
* @en The selected row by default (uncontrolled mode) takes precedence over `rowSelection`
|
827
|
+
* @version 2.25.0
|
828
|
+
*/
|
829
|
+
defaultSelectedKeys: {
|
830
|
+
type: PropType<(string | number)[]>;
|
831
|
+
};
|
832
|
+
/**
|
833
|
+
* @zh 显示的展开行、子树(受控模式)优先于 `expandable`
|
834
|
+
* @en Displayed Expanded Row, Subtree (Controlled Mode) takes precedence over `expandable`
|
835
|
+
* @version 2.25.0
|
836
|
+
*/
|
837
|
+
expandedKeys: {
|
838
|
+
type: PropType<(string | number)[]>;
|
839
|
+
};
|
840
|
+
/**
|
841
|
+
* @zh 默认显示的展开行、子树(非受控模式)优先于 `expandable`
|
842
|
+
* @en Expand row, Subtree displayed by default (Uncontrolled mode) takes precedence over `expandable`
|
843
|
+
* @version 2.25.0
|
844
|
+
*/
|
845
|
+
defaultExpandedKeys: {
|
846
|
+
type: PropType<(string | number)[]>;
|
847
|
+
};
|
848
|
+
/**
|
849
|
+
* @zh 是否默认展开所有的行
|
850
|
+
* @en Whether to expand all rows by default
|
851
|
+
* @version 2.25.0
|
852
|
+
*/
|
853
|
+
defaultExpandAllRows: {
|
854
|
+
type: BooleanConstructor;
|
855
|
+
default: boolean;
|
856
|
+
};
|
857
|
+
/**
|
858
|
+
* @zh 是否开启表头吸顶
|
859
|
+
* @en Whether to open the sticky header
|
860
|
+
* @version 2.30.0
|
861
|
+
*/
|
862
|
+
stickyHeader: {
|
863
|
+
type: (BooleanConstructor | NumberConstructor)[];
|
864
|
+
default: boolean;
|
865
|
+
};
|
866
|
+
/**
|
867
|
+
* @zh 是否开启虚拟滚动条
|
868
|
+
* @en Whether to enable virtual scroll bar
|
869
|
+
* @version 2.38.0
|
870
|
+
*/
|
871
|
+
scrollbar: {
|
872
|
+
type: PropType<boolean | ScrollbarProps>;
|
873
|
+
default: boolean;
|
874
|
+
};
|
875
|
+
/**
|
876
|
+
* @zh 是否展示空子树
|
877
|
+
* @en Whether to display empty subtrees
|
878
|
+
* @version 2.51.0
|
879
|
+
*/
|
880
|
+
showEmptyTree: {
|
881
|
+
type: BooleanConstructor;
|
882
|
+
default: boolean;
|
883
|
+
};
|
884
|
+
}>> & Readonly<{
|
885
|
+
onSelect?: ((rowKeys: (string | number)[], rowKey: string | number, record: TableData) => any) | undefined;
|
886
|
+
onChange?: ((data: TableData[], extra: TableChangeExtra, currentData: TableData[]) => any) | undefined;
|
887
|
+
"onUpdate:selectedKeys"?: ((rowKeys: (string | number)[]) => any) | undefined;
|
888
|
+
onPageSizeChange?: ((pageSize: number) => any) | undefined;
|
889
|
+
onExpand?: ((rowKey: string | number, record: TableData) => any) | undefined;
|
890
|
+
onSelectAll?: ((checked: boolean) => any) | undefined;
|
891
|
+
onSelectionChange?: ((rowKeys: (string | number)[]) => any) | undefined;
|
892
|
+
"onUpdate:expandedKeys"?: ((rowKeys: (string | number)[]) => any) | undefined;
|
893
|
+
onExpandedChange?: ((rowKeys: (string | number)[]) => any) | undefined;
|
894
|
+
onPageChange?: ((page: number) => any) | undefined;
|
895
|
+
onColumnResize?: ((dataIndex: string, width: number) => any) | undefined;
|
896
|
+
onSorterChange?: ((dataIndex: string, direction: string) => any) | undefined;
|
897
|
+
onFilterChange?: ((dataIndex: string, filteredValues: string[]) => any) | undefined;
|
898
|
+
onCellMouseEnter?: ((record: TableData, column: TableColumnData, ev: Event) => any) | undefined;
|
899
|
+
onCellMouseLeave?: ((record: TableData, column: TableColumnData, ev: Event) => any) | undefined;
|
900
|
+
onCellClick?: ((record: TableData, column: TableColumnData, ev: Event) => any) | undefined;
|
901
|
+
onRowClick?: ((record: TableData, ev: Event) => any) | undefined;
|
902
|
+
onHeaderClick?: ((column: TableColumnData, ev: Event) => any) | undefined;
|
903
|
+
onRowDblclick?: ((record: TableData, ev: Event) => any) | undefined;
|
904
|
+
onCellDblclick?: ((record: TableData, column: TableColumnData, ev: Event) => any) | undefined;
|
905
|
+
onRowContextmenu?: ((record: TableData, ev: Event) => any) | undefined;
|
906
|
+
onCellContextmenu?: ((record: TableData, column: TableColumnData, ev: Event) => any) | undefined;
|
907
|
+
}>, {
|
908
|
+
size: "mini" | "small" | "medium" | "large";
|
909
|
+
data: TableData[];
|
910
|
+
loading: boolean | Record<string, any>;
|
911
|
+
columns: TableColumnData[];
|
912
|
+
scrollbar: boolean | ScrollbarProps;
|
913
|
+
bordered: boolean | TableBorder;
|
914
|
+
hoverable: boolean;
|
915
|
+
pagination: boolean | PaginationProps;
|
916
|
+
defaultExpandAllRows: boolean;
|
917
|
+
filterIconAlignLeft: boolean;
|
918
|
+
indentSize: number;
|
919
|
+
stripe: boolean;
|
920
|
+
tableLayoutFixed: boolean;
|
921
|
+
pagePosition: "top" | "tl" | "tr" | "bottom" | "bl" | "br";
|
922
|
+
rowKey: string;
|
923
|
+
showHeader: boolean;
|
924
|
+
spanAll: boolean;
|
925
|
+
hideExpandButtonOnEmpty: boolean;
|
926
|
+
columnResizable: boolean;
|
927
|
+
summaryText: string;
|
928
|
+
stickyHeader: number | boolean;
|
929
|
+
showEmptyTree: boolean;
|
930
|
+
}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
|
931
|
+
export default _default;
|