@next-bricks/advanced 0.51.1 → 0.51.3

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,351 +4,294 @@
4
4
  "name": "advanced",
5
5
  "bricks": [
6
6
  {
7
- "name": "eo-table",
7
+ "name": "eo-cascader",
8
8
  "alias": [
9
- "advanced.general-table"
9
+ "advanced.general-cascader"
10
10
  ],
11
11
  "properties": [
12
12
  {
13
- "name": "showCard",
14
- "description": "是否显示外层卡片",
15
- "default": "true"
13
+ "name": "name",
14
+ "type": "string"
16
15
  },
17
16
  {
18
- "name": "rowSelection",
19
- "description": "表格行是否可选择,具体查阅:[rowSelection](https://ant.design/components/table-cn/#rowSelection)",
20
- "attribute": false,
21
- "type": "false | TableRowSelection<any>"
17
+ "name": "label",
18
+ "type": "string"
22
19
  },
23
20
  {
24
- "name": "rowKey",
25
- "description": "指定每一行的 key,不指定则默认为索引 index。强烈建议设置该属性,否则在某些情况下可能行为不如预期。",
26
- "type": "string"
21
+ "name": "required",
22
+ "type": "boolean"
27
23
  },
28
24
  {
29
- "name": "hiddenColumns",
30
- "description": "隐藏相应列(输入对应的 dataIndex 或者 key 即可)",
25
+ "name": "options",
31
26
  "attribute": false,
32
- "type": "Array<string | number>"
27
+ "type": "AntdCascaderProps[\"options\"]"
33
28
  },
34
29
  {
35
- "name": "showSelectInfo",
36
- "description": "是否显示已选择信息和清除按钮。仅在设置了`rowSelection`时有效。默认不显示",
37
- "default": "false"
30
+ "name": "fieldNames",
31
+ "attribute": false,
32
+ "type": "AntdCascaderProps[\"fieldNames\"]",
33
+ "default": "{\n label: \"label\",\n value: \"value\",\n children: \"children\",\n }"
38
34
  },
39
35
  {
40
- "name": "filters",
41
- "description": "表头过滤的过滤项,key 为 column 的 dataIndex,value 为过滤值集合。",
36
+ "name": "value",
42
37
  "attribute": false,
43
- "type": "Record<string, string[]>"
38
+ "type": "AntdCascaderProps[\"value\"]"
44
39
  },
45
40
  {
46
- "name": "configProps",
47
- "description": "ant-design 的 Table 相关配置项,具体查阅:[Table](https://ant.design/components/table-cn/#Table),其中分页配置和行选择配值在构件中设置了常用的默认配置,也可自行覆盖,具体描述见下表",
48
- "attribute": false,
49
- "type": "any"
41
+ "name": "placeholder",
42
+ "type": "string"
50
43
  },
51
44
  {
52
- "name": "sort",
53
- "description": "被排序列的 dataIndex。通常来自于 url 参数,可以设置成 ${QUERY.sort}。",
54
- "type": "string | null"
45
+ "name": "multiple",
46
+ "type": "boolean"
55
47
  },
56
48
  {
57
- "name": "order",
58
- "description": "升序/降序,可以设置成 ${QUERY.order}。",
59
- "attribute": false,
60
- "type": "string | number | null"
49
+ "name": "disabled",
50
+ "type": "boolean"
61
51
  },
62
52
  {
63
- "name": "rowDisabledConfig",
64
- "description": "配置每一行是否禁用,其中 `field` 表示数据源中的字段路径, `value` 表示与其字段比较的值, `operator` 表示两者比较的方法,结果为 `true` 时会禁用当前行, 需要注意的是该配置需要在 `rowSelection: true` 的前提下使用,并且设置 `rowKey` 属性赋予每行唯一的 key,防止顺序变化时造成的错误勾选(如上 demo 所示)",
65
- "attribute": false,
66
- "type": "RowDisabledProps | RowDisabledProps[]"
53
+ "name": "allowClear",
54
+ "type": "boolean",
55
+ "default": "true"
67
56
  },
68
57
  {
69
- "name": "expandedRowBrick",
70
- "description": "自定义行展开的构件 [UseBrickConf](/next-docs/docs/api-reference/brick-types.usesinglebrickconf)",
71
- "attribute": false,
72
- "type": "{\n useBrick?: UseSingleBrickConf;\n }"
58
+ "name": "showSearch",
59
+ "type": "boolean",
60
+ "default": "true"
73
61
  },
74
62
  {
75
- "name": "expandIcon",
76
- "description": "自定义展开图标。",
77
- "default": "{collapsedIcon:{lib:'antd',icon:'down',theme:'outlined'},expandedIcon:{lib:'antd',icon:'right',theme:'outlined'}}",
63
+ "name": "suffixIcon",
78
64
  "attribute": false,
79
- "type": "{\n collapsedIcon: GeneralIconProps;\n expandedIcon: GeneralIconProps;\n }"
65
+ "type": "GeneralIconProps"
80
66
  },
81
67
  {
82
- "name": "expandIconAsCell",
83
- "description": "展开的图标是否为一个单元格,默认显示在第一列;设置为 false 的时候,可以通过`expandIconColumnIndex`属性设置展开的图标在哪一列",
84
- "default": "true",
85
- "attribute": false
68
+ "name": "expandTrigger",
69
+ "type": "AntdCascaderProps[\"expandTrigger\"]",
70
+ "default": "\"click\""
86
71
  },
87
72
  {
88
- "name": "expandIconColumnIndex",
89
- "description": "展开的图标显示在哪一列,如果没有 rowSelection,默认显示在第一列,否则显示在选择框后面。当`expandIconAsCell`为 false 时,该属性生效。",
90
- "type": "number"
73
+ "name": "popupPlacement",
74
+ "type": "AntdCascaderProps[\"placement\"]",
75
+ "default": "\"bottomLeft\""
91
76
  },
92
77
  {
93
- "name": "expandRowByClick",
94
- "description": "通过点击行来展开子行",
95
- "type": "boolean"
78
+ "name": "size",
79
+ "type": "AntdCascaderProps[\"size\"]"
96
80
  },
97
81
  {
98
- "name": "optimizedColumns",
99
- "description": "优化渲染的列(输入对应的 dataIndex),针对配置了 useBrick 的列。当前 antd 在更新 state 的时候,会全量渲染单元格,如果确定某一列在后续操作中不需要重新渲染,例如仅作为展示的单元格,可通过该属性设置以优化性能。注意,在树形表格中,当某一列内包含展开/收起按钮,则不应该设置该列。",
100
- "attribute": false,
101
- "type": "Array<string | number>"
82
+ "name": "limit",
83
+ "type": "number",
84
+ "default": "50"
102
85
  },
103
86
  {
104
- "name": "stripEmptyExpandableChildren",
105
- "description": "树形数据展示时是否需要去除空数组",
106
- "default": "false",
107
- "attribute": false
87
+ "name": "maxTagCount",
88
+ "attribute": false,
89
+ "type": "number | \"responsive\""
108
90
  },
109
91
  {
110
- "name": "defaultExpandAllRows",
111
- "description": "初始时,是否展开所有行",
112
- "type": "boolean"
92
+ "name": "cascaderStyle",
93
+ "attribute": false,
94
+ "type": "CSSProperties"
95
+ }
96
+ ],
97
+ "events": [
98
+ {
99
+ "name": "cascader.change",
100
+ "description": "",
101
+ "detail": {
102
+ "description": "{ value: AntdCascaderProps[\"value\"], selectedOptions: DefaultOptionType[] | DefaultOptionType[][] }",
103
+ "type": "CascaderChangeEventDetail"
104
+ }
105
+ }
106
+ ],
107
+ "slots": [],
108
+ "methods": [],
109
+ "parts": [],
110
+ "description": "级联选择器",
111
+ "category": "form-input-basic"
112
+ },
113
+ {
114
+ "name": "eo-workbench-layout-v2",
115
+ "properties": [
116
+ {
117
+ "name": "cardTitle",
118
+ "type": "string"
113
119
  },
114
120
  {
115
- "name": "ellipsisInfo",
116
- "description": "是否显示省略信息",
121
+ "name": "isEdit",
117
122
  "type": "boolean"
118
123
  },
119
124
  {
120
- "name": "expandedRowKeys",
121
- "description": "展开的行的 rowKey",
125
+ "name": "layouts",
122
126
  "attribute": false,
123
- "type": "string[]"
124
- },
125
- {
126
- "name": "selectAllChildren",
127
- "description": "表格树形数据展示的时候,行选择父节点的时候是否同步勾选/取消勾选所有子节点,并且被同步勾选的子节点不能单独取消。注意,该属性必须设置 `rowKey` 属性。",
128
- "type": "boolean"
127
+ "type": "ExtraLayout[]"
129
128
  },
130
129
  {
131
- "name": "defaultSelectAll",
132
- "description": "是否默认选择所有行。注意,该属性必须设置 `rowKey` 属性。",
133
- "type": "boolean"
130
+ "name": "toolbarBricks",
131
+ "attribute": false,
132
+ "type": "{ useBrick: UseSingleBrickConf[] }"
134
133
  },
135
134
  {
136
- "name": "childrenColumnName",
137
- "description": "指定树形结构的列名",
138
- "default": "children",
139
- "attribute": false
135
+ "name": "componentList",
136
+ "attribute": false,
137
+ "type": "WorkbenchComponent[]"
140
138
  },
141
139
  {
142
- "name": "sortable",
143
- "description": "是否支持排序。默认开启,当对应列的sorter设置成true时则可排序。sortable为false时则排序都不生效。",
144
- "default": "true",
145
- "attribute": false
140
+ "name": "customDefaultCardConfigMap",
141
+ "description": "自定义卡片默认配置, 用于覆盖默认卡片配置",
142
+ "attribute": false,
143
+ "type": "Record<string, CardStyleConfig>"
146
144
  },
147
145
  {
148
- "name": "frontSearch",
149
- "description": "是否前端进行搜索,配合`presentational-bricks.brick-input`使用",
146
+ "name": "showSettingButton",
147
+ "description": "description: 用于设置页面样式和布局的按钮",
150
148
  "type": "boolean"
151
149
  },
152
150
  {
153
- "name": "frontSearchQuery",
154
- "description": "前端搜索参数",
155
- "default": "\"\""
156
- },
151
+ "name": "gap",
152
+ "description": "description: 卡片间隔",
153
+ "type": "number"
154
+ }
155
+ ],
156
+ "events": [
157
157
  {
158
- "name": "exactSearch",
159
- "description": "是否精确搜索",
160
- "type": "boolean"
158
+ "name": "change",
159
+ "detail": {
160
+ "type": "ExtraLayout[]"
161
+ }
161
162
  },
162
163
  {
163
- "name": "frontSearchFilterKeys",
164
- "description": "进行前端搜索的字段,支持嵌套的写法如[\"name\",\"value.a\"],不配置的时候默认为对所有 columns 的 dataIndex[]进行前端搜索",
165
- "attribute": false,
166
- "type": "string[]"
164
+ "name": "save",
165
+ "detail": {
166
+ "type": "ExtraLayout[]"
167
+ }
167
168
  },
168
169
  {
169
- "name": "page",
170
- "description": "页码。后台搜索的时候一般不需要配置,列表接口返回格式通常为{list:[],page:1,pageSize:10,total:20},即默认取自 page;前台搜索的时候,一般配置成 \"${query.page=1|number}\"",
171
- "type": "number"
170
+ "name": "cancel",
171
+ "detail": {
172
+ "type": "void"
173
+ }
172
174
  },
173
175
  {
174
- "name": "pageSize",
175
- "description": "页码条数。后台搜索的时候一般不需要配置,列表接口返回格式通常为{list:[],page:1,pageSize:10,total:20},即默认取自 pageSize/page_size;前台搜索的时候,一般配置成 \"${query.pageSize=10|number}\"",
176
- "type": "number"
176
+ "name": "setting",
177
+ "detail": {
178
+ "type": "void"
179
+ }
177
180
  },
178
181
  {
179
- "name": "scrollConfigs",
180
- "description": "",
181
- "default": "{ x: true }",
182
+ "name": "action.click",
183
+ "description": "操作点击事件",
184
+ "detail": {
185
+ "description": "{\naction: SimpleAction;\nlayouts: Layout[];\n}",
186
+ "type": "{\n action: SimpleAction;\n layouts: Layout[];\n }"
187
+ }
188
+ }
189
+ ],
190
+ "slots": [],
191
+ "methods": [
192
+ {
193
+ "name": "setLayouts",
194
+ "params": [
195
+ {
196
+ "name": "layouts",
197
+ "type": "Layout[]"
198
+ }
199
+ ]
200
+ }
201
+ ],
202
+ "parts": [],
203
+ "description": "工作台布局V2, 未使用shadow dom"
204
+ },
205
+ {
206
+ "name": "eo-tree",
207
+ "properties": [
208
+ {
209
+ "name": "dataSource",
182
210
  "attribute": false,
183
- "type": "TableProps<unknown>[\"scroll\"]"
211
+ "type": "TreeNode[]"
184
212
  },
185
213
  {
186
- "name": "qField",
187
- "description": "把过滤条件更新到 url 时的字段名",
188
- "default": "\"q\""
214
+ "name": "checkable",
215
+ "type": "boolean"
189
216
  },
190
217
  {
191
- "name": "tableDraggable",
192
- "description": "表格行是否可拖拽,注意,树形数据的表格不支持该功能",
218
+ "name": "selectable",
219
+ "description": "",
220
+ "default": "true",
193
221
  "type": "boolean"
194
222
  },
195
223
  {
196
- "name": "zebraPattern",
197
- "description": "是否展示斑马纹",
224
+ "name": "defaultExpandAll",
198
225
  "type": "boolean"
199
226
  },
200
227
  {
201
- "name": "storeCheckedByUrl",
202
- "description": "翻页时是否记住之前选中的项。注意,选中项的rowKey将保存在url中,如果不设置rowKey,该设置不生效。如果选择太多可能会造成url过长,请谨慎使用",
228
+ "name": "showLine",
203
229
  "type": "boolean"
204
230
  },
205
231
  {
206
- "name": "extraRows",
207
- "description": "额外的行,通常为跨页勾选时,不在当前页的行",
208
- "default": "[]",
232
+ "name": "expandedKeys",
209
233
  "attribute": false,
210
- "type": "Record<string, unknown>[]"
211
- },
212
- {
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"
234
+ "type": "TreeNodeKey[]"
226
235
  },
227
236
  {
228
- "name": "pagination",
229
- "description": "是否显示分页",
237
+ "name": "checkedKeys",
230
238
  "attribute": false,
231
- "type": "false | TablePaginationConfig"
232
- },
233
- {
234
- "name": "size",
235
- "description": "表格大小(antd原生size)",
236
- "type": "SizeType | \"x-small\""
239
+ "type": "TreeNodeKey[]"
237
240
  },
238
241
  {
239
- "name": "type",
240
- "description": "选框类型(单选/多选)",
242
+ "name": "nodeDraggable",
241
243
  "attribute": false,
242
- "type": "RowSelectionType"
244
+ "type": "boolean | { icon?: false }"
243
245
  },
244
246
  {
245
- "name": "shouldUpdateUrlParams",
246
- "description": "是否更新 url 参数。设置为否之后,如果是后台进行分页/排序等功能,则需要结合事件进行编排。如果是前台进行分页/排序,则不需要。",
247
- "default": "true"
247
+ "name": "switcherIcon",
248
+ "attribute": false,
249
+ "type": "\"auto\" | \"chevron\" | false"
248
250
  },
249
251
  {
250
- "name": "shouldRenderWhenUrlParamsUpdate",
251
- "description": "更新 url 参数时是否触发页面重新渲染。仅在`shouldUpdateUrlParams`为true时有效。",
252
- "default": "true"
252
+ "name": "allowDrop",
253
+ "attribute": false,
254
+ "type": "((info: AllowDropInfo) => boolean)"
253
255
  },
254
256
  {
255
- "name": "selectedRowKeys",
256
- "description": "指定选中项的 key 数组",
257
- "default": "[]",
257
+ "name": "titleSuffixBrick",
258
258
  "attribute": false,
259
- "type": "React.Key[]"
259
+ "type": "{ useBrick: UseBrickConf }"
260
260
  }
261
261
  ],
262
262
  "events": [
263
263
  {
264
- "name": "page.update",
265
- "description": "页码变化,pagePath 可在 fields.page 中设置,默认为 page",
266
- "detail": {
267
- "type": "Record<string, number>"
268
- }
269
- },
270
- {
271
- "name": "filter.update",
272
- "description": "每页条数变化 ,pagePath 可在 fields.page 中设置,pageSizePath 可在 fields.pageSize 中设置,默认为 pageSize",
273
- "detail": {
274
- "type": "Record<string, number>"
275
- }
276
- },
277
- {
278
- "name": "select.update",
279
- "description": "勾选框变化,detail 中为所选的行数据",
280
- "detail": {
281
- "type": "Record<string, any>[]"
282
- }
283
- },
284
- {
285
- "name": "select.row.keys.update",
286
- "description": "勾选框变化,detail 中为所选的行key集合",
287
- "detail": {
288
- "type": "string[]"
289
- }
290
- },
291
- {
292
- "name": "sort.update",
293
- "description": "排序变化,detail 中的 sort 为对应排序列的 key/dataIndex,order 为升序/降序",
264
+ "name": "check",
294
265
  "detail": {
295
- "type": "{\n sort: string;\n order: string | number;\n }"
266
+ "type": "TreeNodeKey[]"
296
267
  }
297
268
  },
298
269
  {
299
- "name": "row.expand",
300
- "description": "点击展开图标时触发的事件,事件详情中`expanded`为是否展开,`record`被点击的行信息",
270
+ "name": "check.detail",
301
271
  "detail": {
302
- "type": "{\n expanded: boolean;\n record: Record<string, any>;\n }"
272
+ "type": "CheckDetail"
303
273
  }
304
274
  },
305
275
  {
306
- "name": "expand.rows.change",
307
- "description": "展开的行变化时触发的事件,事件详情为当前展开的所有行的`rowKey`集合",
276
+ "name": "expand",
308
277
  "detail": {
309
- "type": "{\n expandedRows: React.Key[];\n }"
278
+ "type": "TreeNodeKey[]"
310
279
  }
311
280
  },
312
281
  {
313
- "name": "row.drag",
314
- "description": "表格行拖拽结束发生的事件,事件详情为拖拽后重新排序的所有行数据",
282
+ "name": "node.drop",
315
283
  "detail": {
316
- "type": "{\n data: Record<string, any>[];\n }"
284
+ "type": "DropDetail"
317
285
  }
318
286
  }
319
287
  ],
320
288
  "slots": [],
321
- "methods": [
322
- {
323
- "name": "filterSourceData",
324
- "params": [
325
- {
326
- "name": "event",
327
- "type": "CustomEvent"
328
- }
329
- ],
330
- "description": "搜索过滤",
331
- "returns": {
332
- "type": "void"
333
- }
334
- },
335
- {
336
- "name": "expandAll",
337
- "params": [],
338
- "description": "展开所有行",
339
- "returns": {}
340
- }
341
- ],
289
+ "methods": [],
342
290
  "parts": [],
343
- "description": "简易表格构件。\n\n⚠️ 通常情况下,应使用 `eo-next-table` 替代。",
344
- "category": "table",
345
- "insider": true
291
+ "description": "树形构件"
346
292
  },
347
293
  {
348
- "name": "eo-cascader",
349
- "alias": [
350
- "advanced.general-cascader"
351
- ],
294
+ "name": "eo-tree-select",
352
295
  "properties": [
353
296
  {
354
297
  "name": "name",
@@ -363,20 +306,28 @@
363
306
  "type": "boolean"
364
307
  },
365
308
  {
366
- "name": "options",
309
+ "name": "treeData",
367
310
  "attribute": false,
368
- "type": "AntdCascaderProps[\"options\"]"
311
+ "type": "AntdTreeSelectProps[\"treeData\"]"
312
+ },
313
+ {
314
+ "name": "treeDefaultExpandAll",
315
+ "type": "boolean"
316
+ },
317
+ {
318
+ "name": "treeExpandedKeys",
319
+ "attribute": false,
320
+ "type": "string[]"
369
321
  },
370
322
  {
371
323
  "name": "fieldNames",
372
324
  "attribute": false,
373
- "type": "AntdCascaderProps[\"fieldNames\"]",
374
- "default": "{\n label: \"label\",\n value: \"value\",\n children: \"children\",\n }"
325
+ "type": "AntdTreeSelectProps[\"fieldNames\"]"
375
326
  },
376
327
  {
377
328
  "name": "value",
378
329
  "attribute": false,
379
- "type": "AntdCascaderProps[\"value\"]"
330
+ "type": "AntdTreeSelectProps[\"value\"]"
380
331
  },
381
332
  {
382
333
  "name": "placeholder",
@@ -390,11 +341,25 @@
390
341
  "name": "disabled",
391
342
  "type": "boolean"
392
343
  },
344
+ {
345
+ "name": "checkable",
346
+ "type": "boolean"
347
+ },
393
348
  {
394
349
  "name": "allowClear",
395
350
  "type": "boolean",
396
351
  "default": "true"
397
352
  },
353
+ {
354
+ "name": "loading",
355
+ "type": "boolean",
356
+ "default": "false"
357
+ },
358
+ {
359
+ "name": "filterTreeNode",
360
+ "attribute": false,
361
+ "type": "AntdTreeSelectProps[\"filterTreeNode\"]"
362
+ },
398
363
  {
399
364
  "name": "showSearch",
400
365
  "type": "boolean",
@@ -405,24 +370,14 @@
405
370
  "attribute": false,
406
371
  "type": "GeneralIconProps"
407
372
  },
408
- {
409
- "name": "expandTrigger",
410
- "type": "AntdCascaderProps[\"expandTrigger\"]",
411
- "default": "\"click\""
412
- },
413
373
  {
414
374
  "name": "popupPlacement",
415
- "type": "AntdCascaderProps[\"placement\"]",
375
+ "type": "AntdTreeSelectProps[\"placement\"]",
416
376
  "default": "\"bottomLeft\""
417
377
  },
418
378
  {
419
379
  "name": "size",
420
- "type": "AntdCascaderProps[\"size\"]"
421
- },
422
- {
423
- "name": "limit",
424
- "type": "number",
425
- "default": "50"
380
+ "type": "AntdTreeSelectProps[\"size\"]"
426
381
  },
427
382
  {
428
383
  "name": "maxTagCount",
@@ -430,27 +385,72 @@
430
385
  "type": "number | \"responsive\""
431
386
  },
432
387
  {
433
- "name": "cascaderStyle",
388
+ "name": "dropdownStyle",
434
389
  "attribute": false,
435
390
  "type": "CSSProperties"
391
+ },
392
+ {
393
+ "name": "popupMatchSelectWidth",
394
+ "type": "boolean",
395
+ "default": "true"
436
396
  }
437
397
  ],
438
398
  "events": [
439
399
  {
440
- "name": "cascader.change",
400
+ "name": "change",
441
401
  "description": "",
442
402
  "detail": {
443
- "description": "{ value: AntdCascaderProps[\"value\"], selectedOptions: DefaultOptionType[] | DefaultOptionType[][] }",
444
- "type": "{\n value: AntdCascaderProps[\"value\"];\n selectedOptions: DefaultOptionType[] | DefaultOptionType[][];\n }"
403
+ "description": "{ value: AntdTreeSelectProps[\"value\"], selectedOptions: DefaultOptionType[] | DefaultOptionType[][] }",
404
+ "type": "{\n value: AntdTreeSelectProps[\"value\"];\n }"
405
+ }
406
+ },
407
+ {
408
+ "name": "search",
409
+ "detail": {
410
+ "type": "string"
411
+ }
412
+ },
413
+ {
414
+ "name": "select",
415
+ "detail": {
416
+ "type": "{ value: AntdTreeSelectProps[\"value\"] }"
417
+ }
418
+ },
419
+ {
420
+ "name": "expand",
421
+ "detail": {
422
+ "type": "{ keys: React.Key[] }"
445
423
  }
446
424
  }
447
425
  ],
448
426
  "slots": [],
449
427
  "methods": [],
450
428
  "parts": [],
451
- "description": "级联选择器",
429
+ "description": "树选择器",
452
430
  "category": "form-input-basic"
453
431
  },
432
+ {
433
+ "name": "eo-text-tooltip",
434
+ "properties": [
435
+ {
436
+ "name": "label",
437
+ "description": "文案",
438
+ "default": null,
439
+ "type": "string"
440
+ },
441
+ {
442
+ "name": "lineClamp",
443
+ "description": "省略行数",
444
+ "default": "1",
445
+ "type": "number"
446
+ }
447
+ ],
448
+ "events": [],
449
+ "slots": [],
450
+ "methods": [],
451
+ "parts": [],
452
+ "description": "超出宽度鼠标悬浮显示tooltip\n构件 `eo-text-tooltip`"
453
+ },
454
454
  {
455
455
  "name": "eo-workbench-layout",
456
456
  "properties": [
@@ -518,607 +518,607 @@
518
518
  "deprecated": "Please use eo-workbench-layout-v2 which support global styles instead"
519
519
  },
520
520
  {
521
- "name": "eo-workbench-layout-v2",
521
+ "name": "advanced.pdf-viewer",
522
522
  "properties": [
523
523
  {
524
- "name": "cardTitle",
524
+ "name": "url",
525
525
  "type": "string"
526
526
  },
527
527
  {
528
- "name": "isEdit",
529
- "type": "boolean"
530
- },
531
- {
532
- "name": "layouts",
533
- "attribute": false,
534
- "type": "ExtraLayout[]"
528
+ "name": "page",
529
+ "type": "number"
535
530
  },
536
531
  {
537
- "name": "toolbarBricks",
538
- "attribute": false,
539
- "type": "{ useBrick: UseSingleBrickConf[] }"
532
+ "name": "search",
533
+ "type": "string"
540
534
  },
541
535
  {
542
- "name": "componentList",
536
+ "name": "viewerStyle",
543
537
  "attribute": false,
544
- "type": "WorkbenchComponent[]"
545
- },
546
- {
547
- "name": "customDefaultCardConfigMap",
548
- "description": "自定义卡片默认配置, 用于覆盖默认卡片配置",
549
- "attribute": false,
550
- "type": "Record<string, CardStyleConfig>"
551
- },
552
- {
553
- "name": "showSettingButton",
554
- "description": "description: 用于设置页面样式和布局的按钮",
555
- "type": "boolean"
556
- },
557
- {
558
- "name": "gap",
559
- "description": "description: 卡片间隔",
560
- "type": "number"
538
+ "type": "React.CSSProperties"
561
539
  }
562
540
  ],
563
- "events": [
564
- {
565
- "name": "change",
566
- "detail": {
567
- "type": "ExtraLayout[]"
568
- }
569
- },
541
+ "events": [],
542
+ "slots": [],
543
+ "methods": [],
544
+ "parts": [],
545
+ "description": "构件 `advanced.pdf-viewer`"
546
+ },
547
+ {
548
+ "name": "eo-next-table",
549
+ "properties": [
570
550
  {
571
- "name": "save",
572
- "detail": {
573
- "type": "ExtraLayout[]"
574
- }
551
+ "name": "rowKey",
552
+ "description": "指定表格行的 key",
553
+ "default": "\"key\"",
554
+ "type": "string"
575
555
  },
576
556
  {
577
- "name": "cancel",
578
- "detail": {
579
- "type": "void"
580
- }
557
+ "name": "columns",
558
+ "description": "列定义",
559
+ "attribute": false,
560
+ "type": "Column[]"
581
561
  },
582
562
  {
583
- "name": "setting",
584
- "detail": {
585
- "type": "void"
586
- }
563
+ "name": "cell",
564
+ "description": "单元格",
565
+ "attribute": false,
566
+ "type": "CellConfig"
587
567
  },
588
- {
589
- "name": "action.click",
590
- "description": "操作点击事件",
591
- "detail": {
592
- "description": "{\naction: SimpleAction;\nlayouts: Layout[];\n}",
593
- "type": "{\n action: SimpleAction;\n layouts: Layout[];\n }"
594
- }
595
- }
596
- ],
597
- "slots": [],
598
- "methods": [
599
- {
600
- "name": "setLayouts",
601
- "params": [
602
- {
603
- "name": "layouts",
604
- "type": "Layout[]"
605
- }
606
- ]
607
- }
608
- ],
609
- "parts": [],
610
- "description": "工作台布局V2, 未使用shadow dom"
611
- },
612
- {
613
- "name": "eo-tree",
614
- "properties": [
615
568
  {
616
569
  "name": "dataSource",
570
+ "description": "数据源",
617
571
  "attribute": false,
618
- "type": "TreeNode[]"
572
+ "type": "DataSource"
619
573
  },
620
574
  {
621
- "name": "checkable",
575
+ "name": "frontSearch",
576
+ "description": "是否前端搜索",
622
577
  "type": "boolean"
623
578
  },
624
579
  {
625
- "name": "selectable",
626
- "description": "",
627
- "default": "true",
628
- "type": "boolean"
580
+ "name": "pagination",
581
+ "description": "分页配置",
582
+ "attribute": false,
583
+ "type": "PaginationType"
629
584
  },
630
585
  {
631
- "name": "defaultExpandAll",
586
+ "name": "loading",
587
+ "description": "显示加载中状态",
632
588
  "type": "boolean"
633
589
  },
634
590
  {
635
- "name": "showLine",
591
+ "name": "multiSort",
592
+ "description": "是否支持多列排序,前端搜索时需设置 column.sortPriority 优先级",
636
593
  "type": "boolean"
637
594
  },
638
595
  {
639
- "name": "expandedKeys",
596
+ "name": "sort",
597
+ "description": "排序信息",
640
598
  "attribute": false,
641
- "type": "TreeNodeKey[]"
599
+ "type": "Sort | Sort[]"
642
600
  },
643
601
  {
644
- "name": "checkedKeys",
602
+ "name": "rowSelection",
603
+ "description": "表格行可选择配置",
645
604
  "attribute": false,
646
- "type": "TreeNodeKey[]"
605
+ "type": "RowSelectionType"
647
606
  },
648
607
  {
649
- "name": "nodeDraggable",
608
+ "name": "selectedRowKeys",
609
+ "description": "选中项的 key",
650
610
  "attribute": false,
651
- "type": "boolean | { icon?: false }"
611
+ "type": "(string | number)[]"
652
612
  },
653
613
  {
654
- "name": "switcherIcon",
614
+ "name": "hiddenColumns",
615
+ "description": "隐藏的列(输入对应的 column.key)",
655
616
  "attribute": false,
656
- "type": "\"auto\" | \"chevron\" | false"
617
+ "type": "(string | number)[]"
657
618
  },
658
619
  {
659
- "name": "allowDrop",
620
+ "name": "expandable",
621
+ "description": "表格行展开配置",
660
622
  "attribute": false,
661
- "type": "((info: AllowDropInfo) => boolean)"
623
+ "type": "ExpandableType"
662
624
  },
663
625
  {
664
- "name": "titleSuffixBrick",
626
+ "name": "expandedRowKeys",
627
+ "description": "展开项的 key",
665
628
  "attribute": false,
666
- "type": "{ useBrick: UseBrickConf }"
667
- }
668
- ],
669
- "events": [
670
- {
671
- "name": "check",
672
- "detail": {
673
- "type": "TreeNodeKey[]"
674
- }
675
- },
676
- {
677
- "name": "check.detail",
678
- "detail": {
679
- "type": "CheckDetail"
680
- }
681
- },
682
- {
683
- "name": "expand",
684
- "detail": {
685
- "type": "TreeNodeKey[]"
686
- }
687
- },
688
- {
689
- "name": "node.drop",
690
- "detail": {
691
- "type": "DropDetail"
692
- }
693
- }
694
- ],
695
- "slots": [],
696
- "methods": [],
697
- "parts": [],
698
- "description": "树形构件"
699
- },
700
- {
701
- "name": "eo-tree-select",
702
- "properties": [
703
- {
704
- "name": "name",
705
- "type": "string"
629
+ "type": "(string | number)[]"
706
630
  },
707
631
  {
708
- "name": "label",
632
+ "name": "childrenColumnName",
633
+ "description": "树形结构的列名",
634
+ "default": "\"children\"",
709
635
  "type": "string"
710
636
  },
711
637
  {
712
- "name": "required",
638
+ "name": "rowDraggable",
639
+ "description": "表格行拖拽配置",
713
640
  "type": "boolean"
714
641
  },
715
642
  {
716
- "name": "treeData",
717
- "attribute": false,
718
- "type": "AntdTreeSelectProps[\"treeData\"]"
719
- },
720
- {
721
- "name": "treeDefaultExpandAll",
643
+ "name": "rowClickable",
644
+ "description": "表格行可点击(激活鼠标手势)",
722
645
  "type": "boolean"
723
646
  },
724
647
  {
725
- "name": "treeExpandedKeys",
726
- "attribute": false,
727
- "type": "string[]"
728
- },
729
- {
730
- "name": "fieldNames",
731
- "attribute": false,
732
- "type": "AntdTreeSelectProps[\"fieldNames\"]"
733
- },
734
- {
735
- "name": "value",
648
+ "name": "searchFields",
649
+ "description": "进行前端搜索的字段,支持嵌套的写法。不配置的时候默认为对所有 column.dataIndex 进行前端搜索",
736
650
  "attribute": false,
737
- "type": "AntdTreeSelectProps[\"value\"]"
738
- },
739
- {
740
- "name": "placeholder",
741
- "type": "string"
651
+ "type": "(string | string[])[]"
742
652
  },
743
653
  {
744
- "name": "multiple",
745
- "type": "boolean"
654
+ "name": "size",
655
+ "description": "表格大小",
656
+ "default": "\"large\"",
657
+ "type": "TableProps<RecordType>[\"size\"]"
746
658
  },
747
659
  {
748
- "name": "disabled",
660
+ "name": "showHeader",
661
+ "description": "是否显示表头",
662
+ "default": "true",
749
663
  "type": "boolean"
750
664
  },
751
665
  {
752
- "name": "checkable",
666
+ "name": "bordered",
667
+ "description": "是否显示边框",
753
668
  "type": "boolean"
754
669
  },
755
670
  {
756
- "name": "allowClear",
757
- "type": "boolean",
758
- "default": "true"
759
- },
760
- {
761
- "name": "loading",
762
- "type": "boolean",
763
- "default": "false"
671
+ "name": "scrollConfig",
672
+ "description": "滚动配置",
673
+ "default": "{ x: true }",
674
+ "attribute": false,
675
+ "type": "TableScroll"
764
676
  },
765
677
  {
766
- "name": "filterTreeNode",
678
+ "name": "optimizedColumns",
679
+ "description": "优化渲染的列(输入对应的 column.key)",
767
680
  "attribute": false,
768
- "type": "AntdTreeSelectProps[\"filterTreeNode\"]"
681
+ "type": "(string | number)[]"
769
682
  },
770
683
  {
771
- "name": "showSearch",
772
- "type": "boolean",
773
- "default": "true"
774
- },
684
+ "name": "themeVariant",
685
+ "description": "主题变体",
686
+ "type": "\"default\" | \"elevo\""
687
+ }
688
+ ],
689
+ "events": [
775
690
  {
776
- "name": "suffixIcon",
777
- "attribute": false,
778
- "type": "GeneralIconProps"
691
+ "name": "page.change",
692
+ "description": "page 或 pageSize 改变的回调",
693
+ "detail": {
694
+ "description": "改变后的页码及每页条数",
695
+ "type": "PageOrPageSizeChangeEventDetail"
696
+ }
779
697
  },
780
698
  {
781
- "name": "popupPlacement",
782
- "type": "AntdTreeSelectProps[\"placement\"]",
783
- "default": "\"bottomLeft\""
699
+ "name": "page.size.change",
700
+ "description": "pageSize 变化的回调",
701
+ "deprecated": "统一用 `page.change` 事件",
702
+ "detail": {
703
+ "description": "改变后的页码及每页条数",
704
+ "type": "PageOrPageSizeChangeEventDetail"
705
+ }
784
706
  },
785
707
  {
786
- "name": "size",
787
- "type": "AntdTreeSelectProps[\"size\"]"
708
+ "name": "sort.change",
709
+ "description": "排序变化的回调",
710
+ "detail": {
711
+ "description": "当前排序的信息",
712
+ "type": "Sort | Sort[] | undefined"
713
+ }
788
714
  },
789
715
  {
790
- "name": "maxTagCount",
791
- "attribute": false,
792
- "type": "number | \"responsive\""
716
+ "name": "row.click",
717
+ "description": "行点击时的回调",
718
+ "detail": {
719
+ "description": "被点击的行数据",
720
+ "type": "RecordType"
721
+ }
793
722
  },
794
723
  {
795
- "name": "dropdownStyle",
796
- "attribute": false,
797
- "type": "CSSProperties"
724
+ "name": "row.select",
725
+ "description": "行选中项发生变化时的回调",
726
+ "detail": {
727
+ "description": "改变后的 rowKey 及行数据",
728
+ "type": "RowSelectEventDetail"
729
+ }
798
730
  },
799
731
  {
800
- "name": "popupMatchSelectWidth",
801
- "type": "boolean",
802
- "default": "true"
803
- }
804
- ],
805
- "events": [
806
- {
807
- "name": "change",
808
- "description": "",
732
+ "name": "row.select.v2",
733
+ "description": "行选中项发生变化时的回调(v2 版本)",
809
734
  "detail": {
810
- "description": "{ value: AntdTreeSelectProps[\"value\"], selectedOptions: DefaultOptionType[] | DefaultOptionType[][] }",
811
- "type": "{\n value: AntdTreeSelectProps[\"value\"];\n }"
735
+ "description": "改变后的行数据",
736
+ "type": "RecordType[]"
812
737
  }
813
738
  },
814
739
  {
815
- "name": "search",
740
+ "name": "row.expand",
741
+ "description": "点击展开图标时触发",
816
742
  "detail": {
817
- "type": "string"
743
+ "description": "当前行的展开情况及数据",
744
+ "type": "RowExpandEventDetail"
818
745
  }
819
746
  },
820
747
  {
821
- "name": "select",
748
+ "name": "expanded.rows.change",
749
+ "description": "展开的行变化时触发",
822
750
  "detail": {
823
- "type": "{ value: AntdTreeSelectProps[\"value\"] }"
751
+ "description": "所有展开行的 key",
752
+ "type": "(string | number)[]"
824
753
  }
825
754
  },
826
755
  {
827
- "name": "expand",
756
+ "name": "row.drag",
757
+ "description": "表格行拖拽结束发生的事件",
828
758
  "detail": {
829
- "type": "{ keys: React.Key[] }"
759
+ "description": "重新排序的行数据、拖拽的行数据、放下位置的行数据",
760
+ "type": "RowDragEventDetail"
830
761
  }
831
762
  }
832
763
  ],
833
764
  "slots": [],
834
- "methods": [],
835
- "parts": [],
836
- "description": "树选择器",
837
- "category": "form-input-basic"
838
- },
839
- {
840
- "name": "eo-text-tooltip",
841
- "properties": [
842
- {
843
- "name": "label",
844
- "description": "文案",
845
- "default": null,
846
- "type": "string"
847
- },
765
+ "methods": [
848
766
  {
849
- "name": "lineClamp",
850
- "description": "省略行数",
851
- "default": "1",
852
- "type": "number"
767
+ "name": "search",
768
+ "params": [
769
+ {
770
+ "name": "params",
771
+ "type": "{ q: string }"
772
+ }
773
+ ],
774
+ "description": "前端搜索",
775
+ "returns": {}
853
776
  }
854
777
  ],
855
- "events": [],
856
- "slots": [],
857
- "methods": [],
858
778
  "parts": [],
859
- "description": "超出宽度鼠标悬浮显示tooltip\n构件 `eo-text-tooltip`"
779
+ "description": "大型表格",
780
+ "category": "table"
860
781
  },
861
782
  {
862
- "name": "advanced.pdf-viewer",
783
+ "name": "eo-table",
784
+ "alias": [
785
+ "advanced.general-table"
786
+ ],
863
787
  "properties": [
864
788
  {
865
- "name": "url",
866
- "type": "string"
789
+ "name": "showCard",
790
+ "description": "是否显示外层卡片",
791
+ "default": "true"
867
792
  },
868
793
  {
869
- "name": "page",
870
- "type": "number"
794
+ "name": "rowSelection",
795
+ "description": "表格行是否可选择,具体查阅:[rowSelection](https://ant.design/components/table-cn/#rowSelection)",
796
+ "attribute": false,
797
+ "type": "false | TableRowSelection<any>"
871
798
  },
872
799
  {
873
- "name": "search",
800
+ "name": "rowKey",
801
+ "description": "指定每一行的 key,不指定则默认为索引 index。强烈建议设置该属性,否则在某些情况下可能行为不如预期。",
874
802
  "type": "string"
875
803
  },
876
804
  {
877
- "name": "viewerStyle",
805
+ "name": "hiddenColumns",
806
+ "description": "隐藏相应列(输入对应的 dataIndex 或者 key 即可)",
878
807
  "attribute": false,
879
- "type": "React.CSSProperties"
880
- }
881
- ],
882
- "events": [],
883
- "slots": [],
884
- "methods": [],
885
- "parts": [],
886
- "description": "构件 `advanced.pdf-viewer`"
887
- },
888
- {
889
- "name": "eo-next-table",
890
- "properties": [
808
+ "type": "Array<string | number>"
809
+ },
891
810
  {
892
- "name": "rowKey",
893
- "description": "指定表格行的 key",
894
- "default": "\"key\"",
895
- "type": "string"
811
+ "name": "showSelectInfo",
812
+ "description": "是否显示已选择信息和清除按钮。仅在设置了`rowSelection`时有效。默认不显示",
813
+ "default": "false"
814
+ },
815
+ {
816
+ "name": "filters",
817
+ "description": "表头过滤的过滤项,key 为 column 的 dataIndex,value 为过滤值集合。",
818
+ "attribute": false,
819
+ "type": "Record<string, string[]>"
820
+ },
821
+ {
822
+ "name": "configProps",
823
+ "description": "ant-design 的 Table 相关配置项,具体查阅:[Table](https://ant.design/components/table-cn/#Table),其中分页配置和行选择配值在构件中设置了常用的默认配置,也可自行覆盖,具体描述见下表",
824
+ "attribute": false,
825
+ "type": "any"
826
+ },
827
+ {
828
+ "name": "sort",
829
+ "description": "被排序列的 dataIndex。通常来自于 url 参数,可以设置成 ${QUERY.sort}。",
830
+ "type": "string | null"
831
+ },
832
+ {
833
+ "name": "order",
834
+ "description": "升序/降序,可以设置成 ${QUERY.order}。",
835
+ "attribute": false,
836
+ "type": "string | number | null"
837
+ },
838
+ {
839
+ "name": "rowDisabledConfig",
840
+ "description": "配置每一行是否禁用,其中 `field` 表示数据源中的字段路径, `value` 表示与其字段比较的值, `operator` 表示两者比较的方法,结果为 `true` 时会禁用当前行, 需要注意的是该配置需要在 `rowSelection: true` 的前提下使用,并且设置 `rowKey` 属性赋予每行唯一的 key,防止顺序变化时造成的错误勾选(如上 demo 所示)",
841
+ "attribute": false,
842
+ "type": "RowDisabledProps | RowDisabledProps[]"
843
+ },
844
+ {
845
+ "name": "expandedRowBrick",
846
+ "description": "自定义行展开的构件 [UseBrickConf](/next-docs/docs/api-reference/brick-types.usesinglebrickconf)",
847
+ "attribute": false,
848
+ "type": "{\n useBrick?: UseSingleBrickConf;\n }"
849
+ },
850
+ {
851
+ "name": "expandIcon",
852
+ "description": "自定义展开图标。",
853
+ "default": "{collapsedIcon:{lib:'antd',icon:'down',theme:'outlined'},expandedIcon:{lib:'antd',icon:'right',theme:'outlined'}}",
854
+ "attribute": false,
855
+ "type": "{\n collapsedIcon: GeneralIconProps;\n expandedIcon: GeneralIconProps;\n }"
856
+ },
857
+ {
858
+ "name": "expandIconAsCell",
859
+ "description": "展开的图标是否为一个单元格,默认显示在第一列;设置为 false 的时候,可以通过`expandIconColumnIndex`属性设置展开的图标在哪一列",
860
+ "default": "true",
861
+ "attribute": false
862
+ },
863
+ {
864
+ "name": "expandIconColumnIndex",
865
+ "description": "展开的图标显示在哪一列,如果没有 rowSelection,默认显示在第一列,否则显示在选择框后面。当`expandIconAsCell`为 false 时,该属性生效。",
866
+ "type": "number"
896
867
  },
897
868
  {
898
- "name": "columns",
899
- "description": "列定义",
900
- "attribute": false,
901
- "type": "Column[]"
869
+ "name": "expandRowByClick",
870
+ "description": "通过点击行来展开子行",
871
+ "type": "boolean"
902
872
  },
903
873
  {
904
- "name": "cell",
905
- "description": "单元格",
874
+ "name": "optimizedColumns",
875
+ "description": "优化渲染的列(输入对应的 dataIndex),针对配置了 useBrick 的列。当前 antd 在更新 state 的时候,会全量渲染单元格,如果确定某一列在后续操作中不需要重新渲染,例如仅作为展示的单元格,可通过该属性设置以优化性能。注意,在树形表格中,当某一列内包含展开/收起按钮,则不应该设置该列。",
906
876
  "attribute": false,
907
- "type": "CellConfig"
877
+ "type": "Array<string | number>"
908
878
  },
909
879
  {
910
- "name": "dataSource",
911
- "description": "数据源",
912
- "attribute": false,
913
- "type": "DataSource"
880
+ "name": "stripEmptyExpandableChildren",
881
+ "description": "树形数据展示时是否需要去除空数组",
882
+ "default": "false",
883
+ "attribute": false
914
884
  },
915
885
  {
916
- "name": "frontSearch",
917
- "description": "是否前端搜索",
886
+ "name": "defaultExpandAllRows",
887
+ "description": "初始时,是否展开所有行",
918
888
  "type": "boolean"
919
889
  },
920
890
  {
921
- "name": "pagination",
922
- "description": "分页配置",
891
+ "name": "ellipsisInfo",
892
+ "description": "是否显示省略信息",
893
+ "type": "boolean"
894
+ },
895
+ {
896
+ "name": "expandedRowKeys",
897
+ "description": "展开的行的 rowKey",
923
898
  "attribute": false,
924
- "type": "PaginationType"
899
+ "type": "string[]"
925
900
  },
926
901
  {
927
- "name": "loading",
928
- "description": "显示加载中状态",
902
+ "name": "selectAllChildren",
903
+ "description": "表格树形数据展示的时候,行选择父节点的时候是否同步勾选/取消勾选所有子节点,并且被同步勾选的子节点不能单独取消。注意,该属性必须设置 `rowKey` 属性。",
929
904
  "type": "boolean"
930
905
  },
931
906
  {
932
- "name": "multiSort",
933
- "description": "是否支持多列排序,前端搜索时需设置 column.sortPriority 优先级",
907
+ "name": "defaultSelectAll",
908
+ "description": "是否默认选择所有行。注意,该属性必须设置 `rowKey` 属性。",
934
909
  "type": "boolean"
935
910
  },
936
911
  {
937
- "name": "sort",
938
- "description": "排序信息",
939
- "attribute": false,
940
- "type": "Sort | Sort[]"
912
+ "name": "childrenColumnName",
913
+ "description": "指定树形结构的列名",
914
+ "default": "children",
915
+ "attribute": false
941
916
  },
942
917
  {
943
- "name": "rowSelection",
944
- "description": "表格行可选择配置",
945
- "attribute": false,
946
- "type": "RowSelectionType"
918
+ "name": "sortable",
919
+ "description": "是否支持排序。默认开启,当对应列的sorter设置成true时则可排序。sortable为false时则排序都不生效。",
920
+ "default": "true",
921
+ "attribute": false
947
922
  },
948
923
  {
949
- "name": "selectedRowKeys",
950
- "description": "选中项的 key",
951
- "attribute": false,
952
- "type": "(string | number)[]"
924
+ "name": "frontSearch",
925
+ "description": "是否前端进行搜索,配合`presentational-bricks.brick-input`使用",
926
+ "type": "boolean"
953
927
  },
954
928
  {
955
- "name": "hiddenColumns",
956
- "description": "隐藏的列(输入对应的 column.key)",
957
- "attribute": false,
958
- "type": "(string | number)[]"
929
+ "name": "frontSearchQuery",
930
+ "description": "前端搜索参数",
931
+ "default": "\"\""
959
932
  },
960
933
  {
961
- "name": "expandable",
962
- "description": "表格行展开配置",
934
+ "name": "exactSearch",
935
+ "description": "是否精确搜索",
936
+ "type": "boolean"
937
+ },
938
+ {
939
+ "name": "frontSearchFilterKeys",
940
+ "description": "进行前端搜索的字段,支持嵌套的写法如[\"name\",\"value.a\"],不配置的时候默认为对所有 columns 的 dataIndex[]进行前端搜索",
963
941
  "attribute": false,
964
- "type": "ExpandableType"
942
+ "type": "string[]"
965
943
  },
966
944
  {
967
- "name": "expandedRowKeys",
968
- "description": "展开项的 key",
945
+ "name": "page",
946
+ "description": "页码。后台搜索的时候一般不需要配置,列表接口返回格式通常为{list:[],page:1,pageSize:10,total:20},即默认取自 page;前台搜索的时候,一般配置成 \"${query.page=1|number}\"",
947
+ "type": "number"
948
+ },
949
+ {
950
+ "name": "pageSize",
951
+ "description": "页码条数。后台搜索的时候一般不需要配置,列表接口返回格式通常为{list:[],page:1,pageSize:10,total:20},即默认取自 pageSize/page_size;前台搜索的时候,一般配置成 \"${query.pageSize=10|number}\"",
952
+ "type": "number"
953
+ },
954
+ {
955
+ "name": "scrollConfigs",
956
+ "description": "",
957
+ "default": "{ x: true }",
969
958
  "attribute": false,
970
- "type": "(string | number)[]"
959
+ "type": "TableProps<unknown>[\"scroll\"]"
971
960
  },
972
961
  {
973
- "name": "childrenColumnName",
974
- "description": "树形结构的列名",
975
- "default": "\"children\"",
976
- "type": "string"
962
+ "name": "qField",
963
+ "description": "把过滤条件更新到 url 时的字段名",
964
+ "default": "\"q\""
977
965
  },
978
966
  {
979
- "name": "rowDraggable",
980
- "description": "表格行拖拽配置",
967
+ "name": "tableDraggable",
968
+ "description": "表格行是否可拖拽,注意,树形数据的表格不支持该功能",
981
969
  "type": "boolean"
982
970
  },
983
971
  {
984
- "name": "rowClickable",
985
- "description": "表格行可点击(激活鼠标手势)",
972
+ "name": "zebraPattern",
973
+ "description": "是否展示斑马纹",
986
974
  "type": "boolean"
987
975
  },
988
976
  {
989
- "name": "searchFields",
990
- "description": "进行前端搜索的字段,支持嵌套的写法。不配置的时候默认为对所有 column.dataIndex 进行前端搜索",
991
- "attribute": false,
992
- "type": "(string | string[])[]"
977
+ "name": "storeCheckedByUrl",
978
+ "description": "翻页时是否记住之前选中的项。注意,选中项的rowKey将保存在url中,如果不设置rowKey,该设置不生效。如果选择太多可能会造成url过长,请谨慎使用",
979
+ "type": "boolean"
993
980
  },
994
981
  {
995
- "name": "size",
996
- "description": "表格大小",
997
- "default": "\"large\"",
998
- "type": "TableProps<RecordType>[\"size\"]"
982
+ "name": "extraRows",
983
+ "description": "额外的行,通常为跨页勾选时,不在当前页的行",
984
+ "default": "[]",
985
+ "attribute": false,
986
+ "type": "Record<string, unknown>[]"
999
987
  },
1000
988
  {
1001
- "name": "showHeader",
1002
- "description": "是否显示表头",
1003
- "default": "true",
989
+ "name": "autoSelectParentWhenAllChildrenSelected",
990
+ "description": "当所有子节点选中时,自动选中父节点",
1004
991
  "type": "boolean"
1005
992
  },
1006
993
  {
1007
- "name": "bordered",
1008
- "description": "是否显示边框",
994
+ "name": "thTransparent",
995
+ "description": "表格表头是否透明",
1009
996
  "type": "boolean"
1010
997
  },
1011
998
  {
1012
- "name": "scrollConfig",
1013
- "description": "滚动配置",
1014
- "default": "{ x: true }",
999
+ "name": "showHeader",
1000
+ "description": "是否显示表头",
1001
+ "default": "true"
1002
+ },
1003
+ {
1004
+ "name": "pagination",
1005
+ "description": "是否显示分页",
1015
1006
  "attribute": false,
1016
- "type": "TableScroll"
1007
+ "type": "false | TablePaginationConfig"
1017
1008
  },
1018
1009
  {
1019
- "name": "optimizedColumns",
1020
- "description": "优化渲染的列(输入对应的 column.key)",
1010
+ "name": "size",
1011
+ "description": "表格大小(antd原生size)",
1012
+ "type": "SizeType | \"x-small\""
1013
+ },
1014
+ {
1015
+ "name": "type",
1016
+ "description": "选框类型(单选/多选)",
1021
1017
  "attribute": false,
1022
- "type": "(string | number)[]"
1018
+ "type": "RowSelectionType"
1023
1019
  },
1024
1020
  {
1025
- "name": "themeVariant",
1026
- "description": "主题变体",
1027
- "type": "\"default\" | \"elevo\""
1021
+ "name": "shouldUpdateUrlParams",
1022
+ "description": "是否更新 url 参数。设置为否之后,如果是后台进行分页/排序等功能,则需要结合事件进行编排。如果是前台进行分页/排序,则不需要。",
1023
+ "default": "true"
1024
+ },
1025
+ {
1026
+ "name": "shouldRenderWhenUrlParamsUpdate",
1027
+ "description": "更新 url 参数时是否触发页面重新渲染。仅在`shouldUpdateUrlParams`为true时有效。",
1028
+ "default": "true"
1029
+ },
1030
+ {
1031
+ "name": "selectedRowKeys",
1032
+ "description": "指定选中项的 key 数组",
1033
+ "default": "[]",
1034
+ "attribute": false,
1035
+ "type": "React.Key[]"
1028
1036
  }
1029
1037
  ],
1030
1038
  "events": [
1031
1039
  {
1032
- "name": "page.change",
1033
- "description": "page pageSize 改变的回调",
1034
- "detail": {
1035
- "description": "改变后的页码及每页条数",
1036
- "type": "{ page: number; pageSize: number }"
1037
- }
1038
- },
1039
- {
1040
- "name": "page.size.change",
1041
- "description": "pageSize 变化的回调",
1042
- "deprecated": "统一用 `page.change` 事件",
1040
+ "name": "page.update",
1041
+ "description": "页码变化,pagePath 可在 fields.page 中设置,默认为 page",
1043
1042
  "detail": {
1044
- "description": "改变后的页码及每页条数",
1045
- "type": "{\n page: number;\n pageSize: number;\n }"
1043
+ "type": "Record<string, number>"
1046
1044
  }
1047
1045
  },
1048
1046
  {
1049
- "name": "sort.change",
1050
- "description": "排序变化的回调",
1047
+ "name": "filter.update",
1048
+ "description": "每页条数变化 ,pagePath 可在 fields.page 中设置,pageSizePath 可在 fields.pageSize 中设置,默认为 pageSize",
1051
1049
  "detail": {
1052
- "description": "当前排序的信息",
1053
- "type": "Sort | Sort[] | undefined"
1050
+ "type": "Record<string, number>"
1054
1051
  }
1055
1052
  },
1056
1053
  {
1057
- "name": "row.click",
1058
- "description": "行点击时的回调",
1054
+ "name": "select.update",
1055
+ "description": "勾选框变化,detail 中为所选的行数据",
1059
1056
  "detail": {
1060
- "description": "被点击的行数据",
1061
- "type": "RecordType"
1057
+ "type": "Record<string, any>[]"
1062
1058
  }
1063
1059
  },
1064
1060
  {
1065
- "name": "row.select",
1066
- "description": "行选中项发生变化时的回调",
1061
+ "name": "select.row.keys.update",
1062
+ "description": "勾选框变化,detail 中为所选的行key集合",
1067
1063
  "detail": {
1068
- "description": "改变后的 rowKey 及行数据",
1069
- "type": "{\n keys: (string | number)[];\n rows: RecordType[];\n info: { type: RowSelectMethod };\n }"
1064
+ "type": "string[]"
1070
1065
  }
1071
1066
  },
1072
1067
  {
1073
- "name": "row.select.v2",
1074
- "description": "行选中项发生变化时的回调(v2 版本)",
1068
+ "name": "sort.update",
1069
+ "description": "排序变化,detail 中的 sort 为对应排序列的 key/dataIndex,order 为升序/降序",
1075
1070
  "detail": {
1076
- "description": "改变后的行数据",
1077
- "type": "RecordType[]"
1071
+ "type": "SortUpdateEventDetail"
1078
1072
  }
1079
1073
  },
1080
1074
  {
1081
1075
  "name": "row.expand",
1082
- "description": "点击展开图标时触发",
1076
+ "description": "点击展开图标时触发的事件,事件详情中`expanded`为是否展开,`record`被点击的行信息",
1083
1077
  "detail": {
1084
- "description": "当前行的展开情况及数据",
1085
- "type": "{\n expanded: boolean;\n record: RecordType;\n }"
1078
+ "type": "RowExpandEventDetail"
1086
1079
  }
1087
1080
  },
1088
1081
  {
1089
- "name": "expanded.rows.change",
1090
- "description": "展开的行变化时触发",
1082
+ "name": "expand.rows.change",
1083
+ "description": "展开的行变化时触发的事件,事件详情为当前展开的所有行的`rowKey`集合",
1091
1084
  "detail": {
1092
- "description": "所有展开行的 key",
1093
- "type": "(string | number)[]"
1085
+ "type": "ExpandRowsChangeEventDetail"
1094
1086
  }
1095
1087
  },
1096
1088
  {
1097
1089
  "name": "row.drag",
1098
- "description": "表格行拖拽结束发生的事件",
1090
+ "description": "表格行拖拽结束发生的事件,事件详情为拖拽后重新排序的所有行数据",
1099
1091
  "detail": {
1100
- "description": "重新排序的行数据、拖拽的行数据、放下位置的行数据",
1101
- "type": "{\n list: RecordType[];\n active: RecordType;\n over: RecordType;\n }"
1092
+ "type": "RowDragEventDetail"
1102
1093
  }
1103
1094
  }
1104
1095
  ],
1105
1096
  "slots": [],
1106
1097
  "methods": [
1107
1098
  {
1108
- "name": "search",
1099
+ "name": "filterSourceData",
1109
1100
  "params": [
1110
1101
  {
1111
- "name": "params",
1112
- "type": "{ q: string }"
1102
+ "name": "event",
1103
+ "type": "CustomEvent"
1113
1104
  }
1114
1105
  ],
1115
- "description": "前端搜索",
1106
+ "description": "搜索过滤",
1107
+ "returns": {
1108
+ "type": "void"
1109
+ }
1110
+ },
1111
+ {
1112
+ "name": "expandAll",
1113
+ "params": [],
1114
+ "description": "展开所有行",
1116
1115
  "returns": {}
1117
1116
  }
1118
1117
  ],
1119
1118
  "parts": [],
1120
- "description": "大型表格",
1121
- "category": "table"
1119
+ "description": "简易表格构件。\n\n⚠️ 通常情况下,应使用 `eo-next-table` 替代。",
1120
+ "category": "table",
1121
+ "insider": true
1122
1122
  }
1123
1123
  ],
1124
1124
  "providers": [