@next-bricks/advanced 0.50.1 → 0.50.2

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.
@@ -4,226 +4,345 @@
4
4
  "name": "advanced",
5
5
  "bricks": [
6
6
  {
7
- "name": "eo-next-table",
7
+ "name": "eo-table",
8
+ "alias": [
9
+ "advanced.general-table"
10
+ ],
8
11
  "properties": [
9
12
  {
10
- "name": "rowKey",
11
- "description": "指定表格行的 key",
12
- "default": "\"key\"",
13
- "type": "string"
13
+ "name": "showCard",
14
+ "description": "是否显示外层卡片",
15
+ "default": "true"
14
16
  },
15
17
  {
16
- "name": "columns",
17
- "description": "列定义",
18
+ "name": "rowSelection",
19
+ "description": "表格行是否可选择,具体查阅:[rowSelection](https://ant.design/components/table-cn/#rowSelection)",
18
20
  "attribute": false,
19
- "type": "Column[]"
21
+ "type": "false | TableRowSelection<any>"
20
22
  },
21
23
  {
22
- "name": "cell",
23
- "description": "单元格",
24
- "attribute": false,
25
- "type": "CellConfig"
24
+ "name": "rowKey",
25
+ "description": "指定每一行的 key,不指定则默认为索引 index。强烈建议设置该属性,否则在某些情况下可能行为不如预期。",
26
+ "type": "string"
26
27
  },
27
28
  {
28
- "name": "dataSource",
29
- "description": "数据源",
29
+ "name": "hiddenColumns",
30
+ "description": "隐藏相应列(输入对应的 dataIndex 或者 key 即可)",
30
31
  "attribute": false,
31
- "type": "DataSource"
32
+ "type": "Array<string | number>"
32
33
  },
33
34
  {
34
- "name": "frontSearch",
35
- "description": "是否前端搜索",
36
- "type": "boolean"
35
+ "name": "showSelectInfo",
36
+ "description": "是否显示已选择信息和清除按钮。仅在设置了`rowSelection`时有效。默认不显示",
37
+ "default": "false"
37
38
  },
38
39
  {
39
- "name": "pagination",
40
- "description": "分页配置",
40
+ "name": "filters",
41
+ "description": "表头过滤的过滤项,key 为 column 的 dataIndex,value 为过滤值集合。",
41
42
  "attribute": false,
42
- "type": "PaginationType"
43
+ "type": "Record<string, string[]>"
43
44
  },
44
45
  {
45
- "name": "loading",
46
- "description": "显示加载中状态",
47
- "type": "boolean"
46
+ "name": "configProps",
47
+ "description": "ant-design 的 Table 相关配置项,具体查阅:[Table](https://ant.design/components/table-cn/#Table),其中分页配置和行选择配值在构件中设置了常用的默认配置,也可自行覆盖,具体描述见下表",
48
+ "attribute": false,
49
+ "type": "any"
48
50
  },
49
51
  {
50
- "name": "multiSort",
51
- "description": "是否支持多列排序,前端搜索时需设置 column.sortPriority 优先级",
52
- "type": "boolean"
52
+ "name": "sort",
53
+ "description": "被排序列的 dataIndex。通常来自于 url 参数,可以设置成 ${QUERY.sort}。",
54
+ "type": "string | null"
53
55
  },
54
56
  {
55
- "name": "sort",
56
- "description": "排序信息",
57
+ "name": "order",
58
+ "description": "升序/降序,可以设置成 ${QUERY.order}。",
57
59
  "attribute": false,
58
- "type": "Sort | Sort[]"
60
+ "type": "string | number | null"
59
61
  },
60
62
  {
61
- "name": "rowSelection",
62
- "description": "表格行可选择配置",
63
+ "name": "rowDisabledConfig",
64
+ "description": "配置每一行是否禁用,其中 `field` 表示数据源中的字段路径, `value` 表示与其字段比较的值, `operator` 表示两者比较的方法,结果为 `true` 时会禁用当前行, 需要注意的是该配置需要在 `rowSelection: true` 的前提下使用,并且设置 `rowKey` 属性赋予每行唯一的 key,防止顺序变化时造成的错误勾选(如上 demo 所示)",
63
65
  "attribute": false,
64
- "type": "RowSelectionType"
66
+ "type": "RowDisabledProps | RowDisabledProps[]"
65
67
  },
66
68
  {
67
- "name": "selectedRowKeys",
68
- "description": "选中项的 key",
69
+ "name": "expandedRowBrick",
70
+ "description": "自定义行展开的构件 [UseBrickConf](/next-docs/docs/api-reference/brick-types.usesinglebrickconf)",
69
71
  "attribute": false,
70
- "type": "(string | number)[]"
72
+ "type": "{\n useBrick?: UseSingleBrickConf;\n }"
71
73
  },
72
74
  {
73
- "name": "hiddenColumns",
74
- "description": "隐藏的列(输入对应的 column.key)",
75
+ "name": "expandIcon",
76
+ "description": "自定义展开图标。",
77
+ "default": "{collapsedIcon:{lib:'antd',icon:'down',theme:'outlined'},expandedIcon:{lib:'antd',icon:'right',theme:'outlined'}}",
75
78
  "attribute": false,
76
- "type": "(string | number)[]"
79
+ "type": "{\n collapsedIcon: GeneralIconProps;\n expandedIcon: GeneralIconProps;\n }"
77
80
  },
78
81
  {
79
- "name": "expandable",
80
- "description": "表格行展开配置",
82
+ "name": "expandIconAsCell",
83
+ "description": "展开的图标是否为一个单元格,默认显示在第一列;设置为 false 的时候,可以通过`expandIconColumnIndex`属性设置展开的图标在哪一列",
84
+ "default": "true",
85
+ "attribute": false
86
+ },
87
+ {
88
+ "name": "expandIconColumnIndex",
89
+ "description": "展开的图标显示在哪一列,如果没有 rowSelection,默认显示在第一列,否则显示在选择框后面。当`expandIconAsCell`为 false 时,该属性生效。",
90
+ "type": "number"
91
+ },
92
+ {
93
+ "name": "expandRowByClick",
94
+ "description": "通过点击行来展开子行",
95
+ "type": "boolean"
96
+ },
97
+ {
98
+ "name": "optimizedColumns",
99
+ "description": "优化渲染的列(输入对应的 dataIndex),针对配置了 useBrick 的列。当前 antd 在更新 state 的时候,会全量渲染单元格,如果确定某一列在后续操作中不需要重新渲染,例如仅作为展示的单元格,可通过该属性设置以优化性能。注意,在树形表格中,当某一列内包含展开/收起按钮,则不应该设置该列。",
81
100
  "attribute": false,
82
- "type": "ExpandableType"
101
+ "type": "Array<string | number>"
102
+ },
103
+ {
104
+ "name": "stripEmptyExpandableChildren",
105
+ "description": "树形数据展示时是否需要去除空数组",
106
+ "default": "false",
107
+ "attribute": false
108
+ },
109
+ {
110
+ "name": "defaultExpandAllRows",
111
+ "description": "初始时,是否展开所有行",
112
+ "type": "boolean"
113
+ },
114
+ {
115
+ "name": "ellipsisInfo",
116
+ "description": "是否显示省略信息",
117
+ "type": "boolean"
83
118
  },
84
119
  {
85
120
  "name": "expandedRowKeys",
86
- "description": "展开项的 key",
121
+ "description": "展开的行的 rowKey",
87
122
  "attribute": false,
88
- "type": "(string | number)[]"
123
+ "type": "string[]"
124
+ },
125
+ {
126
+ "name": "selectAllChildren",
127
+ "description": "表格树形数据展示的时候,行选择父节点的时候是否同步勾选/取消勾选所有子节点,并且被同步勾选的子节点不能单独取消。注意,该属性必须设置 `rowKey` 属性。",
128
+ "type": "boolean"
129
+ },
130
+ {
131
+ "name": "defaultSelectAll",
132
+ "description": "是否默认选择所有行。注意,该属性必须设置 `rowKey` 属性。",
133
+ "type": "boolean"
89
134
  },
90
135
  {
91
136
  "name": "childrenColumnName",
92
- "description": "树形结构的列名",
93
- "default": "\"children\"",
94
- "type": "string"
137
+ "description": "指定树形结构的列名",
138
+ "default": "children",
139
+ "attribute": false
95
140
  },
96
141
  {
97
- "name": "rowDraggable",
98
- "description": "表格行拖拽配置",
142
+ "name": "sortable",
143
+ "description": "是否支持排序。默认开启,当对应列的sorter设置成true时则可排序。sortable为false时则排序都不生效。",
144
+ "default": "true",
145
+ "attribute": false
146
+ },
147
+ {
148
+ "name": "frontSearch",
149
+ "description": "是否前端进行搜索,配合`presentational-bricks.brick-input`使用",
99
150
  "type": "boolean"
100
151
  },
101
152
  {
102
- "name": "searchFields",
103
- "description": "进行前端搜索的字段,支持嵌套的写法。不配置的时候默认为对所有 column.dataIndex 进行前端搜索",
153
+ "name": "frontSearchQuery",
154
+ "description": "前端搜索参数",
155
+ "default": "\"\""
156
+ },
157
+ {
158
+ "name": "exactSearch",
159
+ "description": "是否精确搜索",
160
+ "type": "boolean"
161
+ },
162
+ {
163
+ "name": "frontSearchFilterKeys",
164
+ "description": "进行前端搜索的字段,支持嵌套的写法如[\"name\",\"value.a\"],不配置的时候默认为对所有 columns 的 dataIndex[]进行前端搜索",
104
165
  "attribute": false,
105
- "type": "(string | string[])[]"
166
+ "type": "string[]"
106
167
  },
107
168
  {
108
- "name": "size",
109
- "description": "表格大小",
110
- "default": "\"large\"",
111
- "type": "TableProps<RecordType>[\"size\"]"
169
+ "name": "page",
170
+ "description": "页码。后台搜索的时候一般不需要配置,列表接口返回格式通常为{list:[],page:1,pageSize:10,total:20},即默认取自 page;前台搜索的时候,一般配置成 \"${query.page=1|number}\"",
171
+ "type": "number"
112
172
  },
113
173
  {
114
- "name": "showHeader",
115
- "description": "是否显示表头",
116
- "default": "true",
174
+ "name": "pageSize",
175
+ "description": "页码条数。后台搜索的时候一般不需要配置,列表接口返回格式通常为{list:[],page:1,pageSize:10,total:20},即默认取自 pageSize/page_size;前台搜索的时候,一般配置成 \"${query.pageSize=10|number}\"",
176
+ "type": "number"
177
+ },
178
+ {
179
+ "name": "scrollConfigs",
180
+ "description": "",
181
+ "default": "{ x: true }",
182
+ "attribute": false,
183
+ "type": "TableProps<unknown>[\"scroll\"]"
184
+ },
185
+ {
186
+ "name": "qField",
187
+ "description": "把过滤条件更新到 url 时的字段名",
188
+ "default": "\"q\""
189
+ },
190
+ {
191
+ "name": "tableDraggable",
192
+ "description": "表格行是否可拖拽,注意,树形数据的表格不支持该功能",
117
193
  "type": "boolean"
118
194
  },
119
195
  {
120
- "name": "bordered",
121
- "description": "是否显示边框",
196
+ "name": "zebraPattern",
197
+ "description": "是否展示斑马纹",
122
198
  "type": "boolean"
123
199
  },
124
200
  {
125
- "name": "scrollConfig",
126
- "description": "滚动配置",
127
- "default": "{ x: true }",
201
+ "name": "storeCheckedByUrl",
202
+ "description": "翻页时是否记住之前选中的项。注意,选中项的rowKey将保存在url中,如果不设置rowKey,该设置不生效。如果选择太多可能会造成url过长,请谨慎使用",
203
+ "type": "boolean"
204
+ },
205
+ {
206
+ "name": "extraRows",
207
+ "description": "额外的行,通常为跨页勾选时,不在当前页的行",
208
+ "default": "[]",
128
209
  "attribute": false,
129
- "type": "TableScroll"
210
+ "type": "Record<string, unknown>[]"
130
211
  },
131
212
  {
132
- "name": "optimizedColumns",
133
- "description": "优化渲染的列(输入对应的 column.key)",
213
+ "name": "autoSelectParentWhenAllChildrenSelected",
214
+ "description": "当所有子节点选中时,自动选中父节点",
215
+ "type": "boolean"
216
+ },
217
+ {
218
+ "name": "thTransparent",
219
+ "description": "表格表头是否透明",
220
+ "type": "boolean"
221
+ },
222
+ {
223
+ "name": "showHeader",
224
+ "description": "是否显示表头",
225
+ "default": "true"
226
+ },
227
+ {
228
+ "name": "pagination",
229
+ "description": "是否显示分页",
134
230
  "attribute": false,
135
- "type": "(string | number)[]"
231
+ "type": "false | TablePaginationConfig"
136
232
  },
137
233
  {
138
- "name": "themeVariant",
139
- "description": "主题变体",
140
- "type": "\"default\" | \"elevo\""
234
+ "name": "size",
235
+ "description": "表格大小(antd原生size)",
236
+ "type": "SizeType | \"x-small\""
237
+ },
238
+ {
239
+ "name": "type",
240
+ "description": "选框类型(单选/多选)",
241
+ "attribute": false,
242
+ "type": "RowSelectionType"
243
+ },
244
+ {
245
+ "name": "shouldUpdateUrlParams",
246
+ "description": "是否更新 url 参数。设置为否之后,如果是后台进行分页/排序等功能,则需要结合事件进行编排。如果是前台进行分页/排序,则不需要。",
247
+ "default": "true"
248
+ },
249
+ {
250
+ "name": "shouldRenderWhenUrlParamsUpdate",
251
+ "description": "更新 url 参数时是否触发页面重新渲染。仅在`shouldUpdateUrlParams`为true时有效。",
252
+ "default": "true"
253
+ },
254
+ {
255
+ "name": "selectedRowKeys",
256
+ "description": "指定选中项的 key 数组",
257
+ "default": "[]",
258
+ "attribute": false,
259
+ "type": "React.Key[]"
141
260
  }
142
261
  ],
143
262
  "events": [
144
263
  {
145
- "name": "page.change",
146
- "description": "page pageSize 改变的回调",
264
+ "name": "page.update",
265
+ "description": "页码变化,pagePath 可在 fields.page 中设置,默认为 page",
147
266
  "detail": {
148
- "description": "改变后的页码及每页条数",
149
- "type": "{ page: number; pageSize: number }"
267
+ "type": "Record<string, number>"
150
268
  }
151
269
  },
152
270
  {
153
- "name": "page.size.change",
154
- "description": "pageSize 变化的回调",
155
- "deprecated": "统一用 `page.change` 事件",
271
+ "name": "filter.update",
272
+ "description": "每页条数变化 ,pagePath 可在 fields.page 中设置,pageSizePath 可在 fields.pageSize 中设置,默认为 pageSize",
156
273
  "detail": {
157
- "description": "改变后的页码及每页条数",
158
- "type": "{\n page: number;\n pageSize: number;\n }"
274
+ "type": "Record<string, number>"
159
275
  }
160
276
  },
161
277
  {
162
- "name": "sort.change",
163
- "description": "排序变化的回调",
278
+ "name": "select.update",
279
+ "description": "勾选框变化,detail 中为所选的行数据",
164
280
  "detail": {
165
- "description": "当前排序的信息",
166
- "type": "Sort | Sort[] | undefined"
281
+ "type": "Record<string, any>[]"
167
282
  }
168
283
  },
169
284
  {
170
- "name": "row.select",
171
- "description": "行选中项发生变化时的回调",
285
+ "name": "select.row.keys.update",
286
+ "description": "勾选框变化,detail 中为所选的行key集合",
172
287
  "detail": {
173
- "description": "改变后的 rowKey 及行数据",
174
- "type": "{\n keys: (string | number)[];\n rows: RecordType[];\n info: { type: RowSelectMethod };\n }"
288
+ "type": "string[]"
175
289
  }
176
290
  },
177
291
  {
178
- "name": "row.select.v2",
179
- "description": "行选中项发生变化时的回调(v2 版本)",
292
+ "name": "sort.update",
293
+ "description": "排序变化,detail 中的 sort 为对应排序列的 key/dataIndex,order 为升序/降序",
180
294
  "detail": {
181
- "description": "改变后的行数据",
182
- "type": "RecordType[]"
295
+ "type": "{\n sort: string;\n order: string | number;\n }"
183
296
  }
184
297
  },
185
298
  {
186
299
  "name": "row.expand",
187
- "description": "点击展开图标时触发",
300
+ "description": "点击展开图标时触发的事件,事件详情中`expanded`为是否展开,`record`被点击的行信息",
188
301
  "detail": {
189
- "description": "当前行的展开情况及数据",
190
- "type": "{\n expanded: boolean;\n record: RecordType;\n }"
302
+ "type": "{\n expanded: boolean;\n record: Record<string, any>;\n }"
191
303
  }
192
304
  },
193
305
  {
194
- "name": "expanded.rows.change",
195
- "description": "展开的行变化时触发",
306
+ "name": "expand.rows.change",
307
+ "description": "展开的行变化时触发的事件,事件详情为当前展开的所有行的`rowKey`集合",
196
308
  "detail": {
197
- "description": "所有展开行的 key",
198
- "type": "(string | number)[]"
309
+ "type": "{\n expandedRows: React.Key[];\n }"
199
310
  }
200
311
  },
201
312
  {
202
313
  "name": "row.drag",
203
- "description": "表格行拖拽结束发生的事件",
314
+ "description": "表格行拖拽结束发生的事件,事件详情为拖拽后重新排序的所有行数据",
204
315
  "detail": {
205
- "description": "重新排序的行数据、拖拽的行数据、放下位置的行数据",
206
- "type": "{\n list: RecordType[];\n active: RecordType;\n over: RecordType;\n }"
316
+ "type": "{\n data: Record<string, any>[];\n }"
207
317
  }
208
318
  }
209
319
  ],
210
320
  "slots": [],
211
321
  "methods": [
212
322
  {
213
- "name": "search",
323
+ "name": "filterSourceData",
214
324
  "params": [
215
325
  {
216
- "name": "params",
217
- "type": "{ q: string }"
326
+ "name": "event",
327
+ "type": "CustomEvent"
218
328
  }
219
329
  ],
220
- "description": "前端搜索",
330
+ "description": "搜索过滤",
331
+ "returns": {
332
+ "type": "void"
333
+ }
334
+ },
335
+ {
336
+ "name": "expandAll",
337
+ "params": [],
338
+ "description": "展开所有行",
221
339
  "returns": {}
222
340
  }
223
341
  ],
224
342
  "parts": [],
225
- "description": "大型表格",
226
- "category": "table"
343
+ "description": "简易表格构件。\n\n⚠️ 通常情况下,应使用 `eo-next-table` 替代。",
344
+ "category": "table",
345
+ "insider": true
227
346
  },
228
347
  {
229
348
  "name": "eo-cascader",
@@ -333,348 +452,229 @@
333
452
  "category": "form-input-basic"
334
453
  },
335
454
  {
336
- "name": "eo-table",
337
- "alias": [
338
- "advanced.general-table"
339
- ],
455
+ "name": "eo-next-table",
340
456
  "properties": [
341
- {
342
- "name": "showCard",
343
- "description": "是否显示外层卡片",
344
- "default": "true"
345
- },
346
- {
347
- "name": "rowSelection",
348
- "description": "表格行是否可选择,具体查阅:[rowSelection](https://ant.design/components/table-cn/#rowSelection)",
349
- "attribute": false,
350
- "type": "false | TableRowSelection<any>"
351
- },
352
457
  {
353
458
  "name": "rowKey",
354
- "description": "指定每一行的 key,不指定则默认为索引 index。强烈建议设置该属性,否则在某些情况下可能行为不如预期。",
459
+ "description": "指定表格行的 key",
460
+ "default": "\"key\"",
355
461
  "type": "string"
356
462
  },
357
463
  {
358
- "name": "hiddenColumns",
359
- "description": "隐藏相应列(输入对应的 dataIndex 或者 key 即可)",
360
- "attribute": false,
361
- "type": "Array<string | number>"
362
- },
363
- {
364
- "name": "showSelectInfo",
365
- "description": "是否显示已选择信息和清除按钮。仅在设置了`rowSelection`时有效。默认不显示",
366
- "default": "false"
367
- },
368
- {
369
- "name": "filters",
370
- "description": "表头过滤的过滤项,key 为 column 的 dataIndex,value 为过滤值集合。",
371
- "attribute": false,
372
- "type": "Record<string, string[]>"
373
- },
374
- {
375
- "name": "configProps",
376
- "description": "ant-design 的 Table 相关配置项,具体查阅:[Table](https://ant.design/components/table-cn/#Table),其中分页配置和行选择配值在构件中设置了常用的默认配置,也可自行覆盖,具体描述见下表",
377
- "attribute": false,
378
- "type": "any"
379
- },
380
- {
381
- "name": "sort",
382
- "description": "被排序列的 dataIndex。通常来自于 url 参数,可以设置成 ${QUERY.sort}。",
383
- "type": "string | null"
384
- },
385
- {
386
- "name": "order",
387
- "description": "升序/降序,可以设置成 ${QUERY.order}。",
388
- "attribute": false,
389
- "type": "string | number | null"
390
- },
391
- {
392
- "name": "rowDisabledConfig",
393
- "description": "配置每一行是否禁用,其中 `field` 表示数据源中的字段路径, `value` 表示与其字段比较的值, `operator` 表示两者比较的方法,结果为 `true` 时会禁用当前行, 需要注意的是该配置需要在 `rowSelection: true` 的前提下使用,并且设置 `rowKey` 属性赋予每行唯一的 key,防止顺序变化时造成的错误勾选(如上 demo 所示)",
394
- "attribute": false,
395
- "type": "RowDisabledProps | RowDisabledProps[]"
396
- },
397
- {
398
- "name": "expandedRowBrick",
399
- "description": "自定义行展开的构件 [UseBrickConf](/next-docs/docs/api-reference/brick-types.usesinglebrickconf)",
400
- "attribute": false,
401
- "type": "{\n useBrick?: UseSingleBrickConf;\n }"
402
- },
403
- {
404
- "name": "expandIcon",
405
- "description": "自定义展开图标。",
406
- "default": "{collapsedIcon:{lib:'antd',icon:'down',theme:'outlined'},expandedIcon:{lib:'antd',icon:'right',theme:'outlined'}}",
464
+ "name": "columns",
465
+ "description": "列定义",
407
466
  "attribute": false,
408
- "type": "{\n collapsedIcon: GeneralIconProps;\n expandedIcon: GeneralIconProps;\n }"
409
- },
410
- {
411
- "name": "expandIconAsCell",
412
- "description": "展开的图标是否为一个单元格,默认显示在第一列;设置为 false 的时候,可以通过`expandIconColumnIndex`属性设置展开的图标在哪一列",
413
- "default": "true",
414
- "attribute": false
415
- },
416
- {
417
- "name": "expandIconColumnIndex",
418
- "description": "展开的图标显示在哪一列,如果没有 rowSelection,默认显示在第一列,否则显示在选择框后面。当`expandIconAsCell`为 false 时,该属性生效。",
419
- "type": "number"
420
- },
421
- {
422
- "name": "expandRowByClick",
423
- "description": "通过点击行来展开子行",
424
- "type": "boolean"
467
+ "type": "Column[]"
425
468
  },
426
469
  {
427
- "name": "optimizedColumns",
428
- "description": "优化渲染的列(输入对应的 dataIndex),针对配置了 useBrick 的列。当前 antd 在更新 state 的时候,会全量渲染单元格,如果确定某一列在后续操作中不需要重新渲染,例如仅作为展示的单元格,可通过该属性设置以优化性能。注意,在树形表格中,当某一列内包含展开/收起按钮,则不应该设置该列。",
470
+ "name": "cell",
471
+ "description": "单元格",
429
472
  "attribute": false,
430
- "type": "Array<string | number>"
431
- },
432
- {
433
- "name": "stripEmptyExpandableChildren",
434
- "description": "树形数据展示时是否需要去除空数组",
435
- "default": "false",
436
- "attribute": false
437
- },
438
- {
439
- "name": "defaultExpandAllRows",
440
- "description": "初始时,是否展开所有行",
441
- "type": "boolean"
442
- },
443
- {
444
- "name": "ellipsisInfo",
445
- "description": "是否显示省略信息",
446
- "type": "boolean"
473
+ "type": "CellConfig"
447
474
  },
448
475
  {
449
- "name": "expandedRowKeys",
450
- "description": "展开的行的 rowKey",
476
+ "name": "dataSource",
477
+ "description": "数据源",
451
478
  "attribute": false,
452
- "type": "string[]"
453
- },
454
- {
455
- "name": "selectAllChildren",
456
- "description": "表格树形数据展示的时候,行选择父节点的时候是否同步勾选/取消勾选所有子节点,并且被同步勾选的子节点不能单独取消。注意,该属性必须设置 `rowKey` 属性。",
457
- "type": "boolean"
458
- },
459
- {
460
- "name": "defaultSelectAll",
461
- "description": "是否默认选择所有行。注意,该属性必须设置 `rowKey` 属性。",
462
- "type": "boolean"
463
- },
464
- {
465
- "name": "childrenColumnName",
466
- "description": "指定树形结构的列名",
467
- "default": "children",
468
- "attribute": false
469
- },
470
- {
471
- "name": "sortable",
472
- "description": "是否支持排序。默认开启,当对应列的sorter设置成true时则可排序。sortable为false时则排序都不生效。",
473
- "default": "true",
474
- "attribute": false
479
+ "type": "DataSource"
475
480
  },
476
481
  {
477
482
  "name": "frontSearch",
478
- "description": "是否前端进行搜索,配合`presentational-bricks.brick-input`使用",
479
- "type": "boolean"
480
- },
481
- {
482
- "name": "frontSearchQuery",
483
- "description": "前端搜索参数",
484
- "default": "\"\""
485
- },
486
- {
487
- "name": "exactSearch",
488
- "description": "是否精确搜索",
483
+ "description": "是否前端搜索",
489
484
  "type": "boolean"
490
485
  },
491
486
  {
492
- "name": "frontSearchFilterKeys",
493
- "description": "进行前端搜索的字段,支持嵌套的写法如[\"name\",\"value.a\"],不配置的时候默认为对所有 columns 的 dataIndex[]进行前端搜索",
487
+ "name": "pagination",
488
+ "description": "分页配置",
494
489
  "attribute": false,
495
- "type": "string[]"
496
- },
497
- {
498
- "name": "page",
499
- "description": "页码。后台搜索的时候一般不需要配置,列表接口返回格式通常为{list:[],page:1,pageSize:10,total:20},即默认取自 page;前台搜索的时候,一般配置成 \"${query.page=1|number}\"",
500
- "type": "number"
490
+ "type": "PaginationType"
501
491
  },
502
492
  {
503
- "name": "pageSize",
504
- "description": "页码条数。后台搜索的时候一般不需要配置,列表接口返回格式通常为{list:[],page:1,pageSize:10,total:20},即默认取自 pageSize/page_size;前台搜索的时候,一般配置成 \"${query.pageSize=10|number}\"",
505
- "type": "number"
493
+ "name": "loading",
494
+ "description": "显示加载中状态",
495
+ "type": "boolean"
506
496
  },
507
497
  {
508
- "name": "scrollConfigs",
509
- "description": "",
510
- "default": "{ x: true }",
511
- "attribute": false,
512
- "type": "TableProps<unknown>[\"scroll\"]"
498
+ "name": "multiSort",
499
+ "description": "是否支持多列排序,前端搜索时需设置 column.sortPriority 优先级",
500
+ "type": "boolean"
513
501
  },
514
502
  {
515
- "name": "qField",
516
- "description": "把过滤条件更新到 url 时的字段名",
517
- "default": "\"q\""
503
+ "name": "sort",
504
+ "description": "排序信息",
505
+ "attribute": false,
506
+ "type": "Sort | Sort[]"
518
507
  },
519
508
  {
520
- "name": "tableDraggable",
521
- "description": "表格行是否可拖拽,注意,树形数据的表格不支持该功能",
522
- "type": "boolean"
509
+ "name": "rowSelection",
510
+ "description": "表格行可选择配置",
511
+ "attribute": false,
512
+ "type": "RowSelectionType"
523
513
  },
524
514
  {
525
- "name": "zebraPattern",
526
- "description": "是否展示斑马纹",
527
- "type": "boolean"
515
+ "name": "selectedRowKeys",
516
+ "description": "选中项的 key",
517
+ "attribute": false,
518
+ "type": "(string | number)[]"
528
519
  },
529
520
  {
530
- "name": "storeCheckedByUrl",
531
- "description": "翻页时是否记住之前选中的项。注意,选中项的rowKey将保存在url中,如果不设置rowKey,该设置不生效。如果选择太多可能会造成url过长,请谨慎使用",
532
- "type": "boolean"
521
+ "name": "hiddenColumns",
522
+ "description": "隐藏的列(输入对应的 column.key)",
523
+ "attribute": false,
524
+ "type": "(string | number)[]"
533
525
  },
534
526
  {
535
- "name": "extraRows",
536
- "description": "额外的行,通常为跨页勾选时,不在当前页的行",
537
- "default": "[]",
527
+ "name": "expandable",
528
+ "description": "表格行展开配置",
538
529
  "attribute": false,
539
- "type": "Record<string, unknown>[]"
530
+ "type": "ExpandableType"
540
531
  },
541
532
  {
542
- "name": "autoSelectParentWhenAllChildrenSelected",
543
- "description": "当所有子节点选中时,自动选中父节点",
544
- "type": "boolean"
533
+ "name": "expandedRowKeys",
534
+ "description": "展开项的 key",
535
+ "attribute": false,
536
+ "type": "(string | number)[]"
545
537
  },
546
538
  {
547
- "name": "thTransparent",
548
- "description": "表格表头是否透明",
549
- "type": "boolean"
539
+ "name": "childrenColumnName",
540
+ "description": "树形结构的列名",
541
+ "default": "\"children\"",
542
+ "type": "string"
550
543
  },
551
544
  {
552
- "name": "showHeader",
553
- "description": "是否显示表头",
554
- "default": "true"
545
+ "name": "rowDraggable",
546
+ "description": "表格行拖拽配置",
547
+ "type": "boolean"
555
548
  },
556
549
  {
557
- "name": "pagination",
558
- "description": "是否显示分页",
550
+ "name": "searchFields",
551
+ "description": "进行前端搜索的字段,支持嵌套的写法。不配置的时候默认为对所有 column.dataIndex 进行前端搜索",
559
552
  "attribute": false,
560
- "type": "false | TablePaginationConfig"
553
+ "type": "(string | string[])[]"
561
554
  },
562
555
  {
563
556
  "name": "size",
564
- "description": "表格大小(antd原生size)",
565
- "type": "SizeType | \"x-small\""
557
+ "description": "表格大小",
558
+ "default": "\"large\"",
559
+ "type": "TableProps<RecordType>[\"size\"]"
566
560
  },
567
561
  {
568
- "name": "type",
569
- "description": "选框类型(单选/多选)",
570
- "attribute": false,
571
- "type": "RowSelectionType"
562
+ "name": "showHeader",
563
+ "description": "是否显示表头",
564
+ "default": "true",
565
+ "type": "boolean"
572
566
  },
573
567
  {
574
- "name": "shouldUpdateUrlParams",
575
- "description": "是否更新 url 参数。设置为否之后,如果是后台进行分页/排序等功能,则需要结合事件进行编排。如果是前台进行分页/排序,则不需要。",
576
- "default": "true"
568
+ "name": "bordered",
569
+ "description": "是否显示边框",
570
+ "type": "boolean"
577
571
  },
578
572
  {
579
- "name": "shouldRenderWhenUrlParamsUpdate",
580
- "description": "更新 url 参数时是否触发页面重新渲染。仅在`shouldUpdateUrlParams`为true时有效。",
581
- "default": "true"
573
+ "name": "scrollConfig",
574
+ "description": "滚动配置",
575
+ "default": "{ x: true }",
576
+ "attribute": false,
577
+ "type": "TableScroll"
582
578
  },
583
579
  {
584
- "name": "selectedRowKeys",
585
- "description": "指定选中项的 key 数组",
586
- "default": "[]",
580
+ "name": "optimizedColumns",
581
+ "description": "优化渲染的列(输入对应的 column.key",
587
582
  "attribute": false,
588
- "type": "React.Key[]"
583
+ "type": "(string | number)[]"
584
+ },
585
+ {
586
+ "name": "themeVariant",
587
+ "description": "主题变体",
588
+ "type": "\"default\" | \"elevo\""
589
589
  }
590
590
  ],
591
591
  "events": [
592
592
  {
593
- "name": "page.update",
594
- "description": "页码变化,pagePath 可在 fields.page 中设置,默认为 page",
593
+ "name": "page.change",
594
+ "description": "page pageSize 改变的回调",
595
595
  "detail": {
596
- "type": "Record<string, number>"
596
+ "description": "改变后的页码及每页条数",
597
+ "type": "{ page: number; pageSize: number }"
597
598
  }
598
599
  },
599
600
  {
600
- "name": "filter.update",
601
- "description": "每页条数变化 ,pagePath 可在 fields.page 中设置,pageSizePath 可在 fields.pageSize 中设置,默认为 pageSize",
601
+ "name": "page.size.change",
602
+ "description": "pageSize 变化的回调",
603
+ "deprecated": "统一用 `page.change` 事件",
602
604
  "detail": {
603
- "type": "Record<string, number>"
605
+ "description": "改变后的页码及每页条数",
606
+ "type": "{\n page: number;\n pageSize: number;\n }"
604
607
  }
605
608
  },
606
609
  {
607
- "name": "select.update",
608
- "description": "勾选框变化,detail 中为所选的行数据",
610
+ "name": "sort.change",
611
+ "description": "排序变化的回调",
609
612
  "detail": {
610
- "type": "Record<string, any>[]"
613
+ "description": "当前排序的信息",
614
+ "type": "Sort | Sort[] | undefined"
611
615
  }
612
616
  },
613
617
  {
614
- "name": "select.row.keys.update",
615
- "description": "勾选框变化,detail 中为所选的行key集合",
618
+ "name": "row.select",
619
+ "description": "行选中项发生变化时的回调",
616
620
  "detail": {
617
- "type": "string[]"
621
+ "description": "改变后的 rowKey 及行数据",
622
+ "type": "{\n keys: (string | number)[];\n rows: RecordType[];\n info: { type: RowSelectMethod };\n }"
618
623
  }
619
624
  },
620
625
  {
621
- "name": "sort.update",
622
- "description": "排序变化,detail 中的 sort 为对应排序列的 key/dataIndex,order 为升序/降序",
626
+ "name": "row.select.v2",
627
+ "description": "行选中项发生变化时的回调(v2 版本)",
623
628
  "detail": {
624
- "type": "{\n sort: string;\n order: string | number;\n }"
629
+ "description": "改变后的行数据",
630
+ "type": "RecordType[]"
625
631
  }
626
632
  },
627
633
  {
628
634
  "name": "row.expand",
629
- "description": "点击展开图标时触发的事件,事件详情中`expanded`为是否展开,`record`被点击的行信息",
635
+ "description": "点击展开图标时触发",
630
636
  "detail": {
631
- "type": "{\n expanded: boolean;\n record: Record<string, any>;\n }"
637
+ "description": "当前行的展开情况及数据",
638
+ "type": "{\n expanded: boolean;\n record: RecordType;\n }"
632
639
  }
633
640
  },
634
641
  {
635
- "name": "expand.rows.change",
636
- "description": "展开的行变化时触发的事件,事件详情为当前展开的所有行的`rowKey`集合",
642
+ "name": "expanded.rows.change",
643
+ "description": "展开的行变化时触发",
637
644
  "detail": {
638
- "type": "{\n expandedRows: React.Key[];\n }"
645
+ "description": "所有展开行的 key",
646
+ "type": "(string | number)[]"
639
647
  }
640
648
  },
641
649
  {
642
650
  "name": "row.drag",
643
- "description": "表格行拖拽结束发生的事件,事件详情为拖拽后重新排序的所有行数据",
651
+ "description": "表格行拖拽结束发生的事件",
644
652
  "detail": {
645
- "type": "{\n data: Record<string, any>[];\n }"
653
+ "description": "重新排序的行数据、拖拽的行数据、放下位置的行数据",
654
+ "type": "{\n list: RecordType[];\n active: RecordType;\n over: RecordType;\n }"
646
655
  }
647
656
  }
648
657
  ],
649
658
  "slots": [],
650
659
  "methods": [
651
660
  {
652
- "name": "filterSourceData",
661
+ "name": "search",
653
662
  "params": [
654
663
  {
655
- "name": "event",
656
- "type": "CustomEvent"
664
+ "name": "params",
665
+ "type": "{ q: string }"
657
666
  }
658
667
  ],
659
- "description": "搜索过滤",
660
- "returns": {
661
- "type": "void"
662
- }
663
- },
664
- {
665
- "name": "expandAll",
666
- "params": [],
667
- "description": "展开所有行",
668
+ "description": "前端搜索",
668
669
  "returns": {}
669
670
  }
670
671
  ],
671
672
  "parts": [],
672
- "description": "简易表格构件。\n\n⚠️ 通常情况下,应使用 `eo-next-table` 替代。",
673
- "category": "table",
674
- "insider": true
673
+ "description": "大型表格",
674
+ "category": "table"
675
675
  },
676
676
  {
677
- "name": "eo-workbench-layout",
677
+ "name": "eo-workbench-layout-v2",
678
678
  "properties": [
679
679
  {
680
680
  "name": "cardTitle",
@@ -687,25 +687,46 @@
687
687
  {
688
688
  "name": "layouts",
689
689
  "attribute": false,
690
- "type": "Layout[]"
690
+ "type": "ExtraLayout[]"
691
+ },
692
+ {
693
+ "name": "toolbarBricks",
694
+ "attribute": false,
695
+ "type": "{ useBrick: UseSingleBrickConf[] }"
691
696
  },
692
697
  {
693
698
  "name": "componentList",
694
699
  "attribute": false,
695
- "type": "Item[]"
700
+ "type": "WorkbenchComponent[]"
701
+ },
702
+ {
703
+ "name": "customDefaultCardConfigMap",
704
+ "description": "自定义卡片默认配置, 用于覆盖默认卡片配置",
705
+ "attribute": false,
706
+ "type": "Record<string, CardStyleConfig>"
707
+ },
708
+ {
709
+ "name": "showSettingButton",
710
+ "description": "description: 用于设置页面样式和布局的按钮",
711
+ "type": "boolean"
712
+ },
713
+ {
714
+ "name": "gap",
715
+ "description": "description: 卡片间隔",
716
+ "type": "number"
696
717
  }
697
718
  ],
698
719
  "events": [
699
720
  {
700
721
  "name": "change",
701
722
  "detail": {
702
- "type": "Layout[]"
723
+ "type": "ExtraLayout[]"
703
724
  }
704
725
  },
705
726
  {
706
727
  "name": "save",
707
728
  "detail": {
708
- "type": "Layout[]"
729
+ "type": "ExtraLayout[]"
709
730
  }
710
731
  },
711
732
  {
@@ -714,6 +735,12 @@
714
735
  "type": "void"
715
736
  }
716
737
  },
738
+ {
739
+ "name": "setting",
740
+ "detail": {
741
+ "type": "void"
742
+ }
743
+ },
717
744
  {
718
745
  "name": "action.click",
719
746
  "description": "操作点击事件",
@@ -736,11 +763,10 @@
736
763
  }
737
764
  ],
738
765
  "parts": [],
739
- "description": "工作台布局",
740
- "deprecated": "Please use eo-workbench-layout-v2 which support global styles instead"
766
+ "description": "工作台布局V2, 未使用shadow dom"
741
767
  },
742
768
  {
743
- "name": "eo-workbench-layout-v2",
769
+ "name": "eo-workbench-layout",
744
770
  "properties": [
745
771
  {
746
772
  "name": "cardTitle",
@@ -753,46 +779,25 @@
753
779
  {
754
780
  "name": "layouts",
755
781
  "attribute": false,
756
- "type": "ExtraLayout[]"
757
- },
758
- {
759
- "name": "toolbarBricks",
760
- "attribute": false,
761
- "type": "{ useBrick: UseSingleBrickConf[] }"
782
+ "type": "Layout[]"
762
783
  },
763
784
  {
764
785
  "name": "componentList",
765
786
  "attribute": false,
766
- "type": "WorkbenchComponent[]"
767
- },
768
- {
769
- "name": "customDefaultCardConfigMap",
770
- "description": "自定义卡片默认配置, 用于覆盖默认卡片配置",
771
- "attribute": false,
772
- "type": "Record<string, CardStyleConfig>"
773
- },
774
- {
775
- "name": "showSettingButton",
776
- "description": "description: 用于设置页面样式和布局的按钮",
777
- "type": "boolean"
778
- },
779
- {
780
- "name": "gap",
781
- "description": "description: 卡片间隔",
782
- "type": "number"
787
+ "type": "Item[]"
783
788
  }
784
789
  ],
785
790
  "events": [
786
791
  {
787
792
  "name": "change",
788
793
  "detail": {
789
- "type": "ExtraLayout[]"
794
+ "type": "Layout[]"
790
795
  }
791
796
  },
792
797
  {
793
798
  "name": "save",
794
799
  "detail": {
795
- "type": "ExtraLayout[]"
800
+ "type": "Layout[]"
796
801
  }
797
802
  },
798
803
  {
@@ -801,12 +806,6 @@
801
806
  "type": "void"
802
807
  }
803
808
  },
804
- {
805
- "name": "setting",
806
- "detail": {
807
- "type": "void"
808
- }
809
- },
810
809
  {
811
810
  "name": "action.click",
812
811
  "description": "操作点击事件",
@@ -829,7 +828,8 @@
829
828
  }
830
829
  ],
831
830
  "parts": [],
832
- "description": "工作台布局V2, 未使用shadow dom"
831
+ "description": "工作台布局",
832
+ "deprecated": "Please use eo-workbench-layout-v2 which support global styles instead"
833
833
  },
834
834
  {
835
835
  "name": "eo-tree",