@next-bricks/presentational-bricks 1.245.2 → 1.246.1

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/dist/stories.json CHANGED
@@ -2104,10 +2104,8 @@
2104
2104
  "label": "Tags",
2105
2105
  "useBrick": {
2106
2106
  "brick": "presentational-bricks.brick-tag",
2107
- "transform": {
2108
- "tagList": "@{tags}"
2109
- },
2110
2107
  "properties": {
2108
+ "tagList": "<% DATA.tags %>",
2111
2109
  "configProps": {
2112
2110
  "color": "orange"
2113
2111
  },
@@ -2132,10 +2130,8 @@
2132
2130
  "label": "开始时间",
2133
2131
  "useBrick": {
2134
2132
  "brick": "presentational-bricks.brick-humanize-time",
2135
- "transform": {
2136
- "value": "@{ctime}"
2137
- },
2138
2133
  "properties": {
2134
+ "value": "<% DATA.ctime %>",
2139
2135
  "formatter": "full"
2140
2136
  }
2141
2137
  }
@@ -2175,10 +2171,8 @@
2175
2171
  "group": "a",
2176
2172
  "useBrick": {
2177
2173
  "brick": "presentational-bricks.brick-tag",
2178
- "transform": {
2179
- "tagList": "@{tags}"
2180
- },
2181
2174
  "properties": {
2175
+ "tagList": "<% DATA.tags %>",
2182
2176
  "configProps": {
2183
2177
  "color": "orange"
2184
2178
  },
@@ -2227,10 +2221,8 @@
2227
2221
  "group": "c",
2228
2222
  "useBrick": {
2229
2223
  "brick": "presentational-bricks.brick-tag",
2230
- "transform": {
2231
- "tagList": "@{tags}"
2232
- },
2233
2224
  "properties": {
2225
+ "tagList": "<% DATA.tags %>",
2234
2226
  "configProps": {
2235
2227
  "color": "orange"
2236
2228
  },
@@ -2278,21 +2270,23 @@
2278
2270
  "type": "BrickDescriptionsItemProps[]",
2279
2271
  "required": "true",
2280
2272
  "default": "-",
2281
- "description": "描述列表项,扩展自 ant-design DescriptionItem 相关配置项,额外扩展项如下,其他项查阅:[https://ant.design/components/descriptions-cn/#DescriptionItem](https://ant.design/components/descriptions-cn/#DescriptionItem)"
2273
+ "description": "描述列表项,扩展自 ant-design DescriptionItem 相关配置项,额外扩展项如下,其他项查阅:[DescriptionItem](https://ant.design/components/descriptions-cn/#DescriptionItem)"
2282
2274
  },
2283
2275
  {
2284
2276
  "name": "showCard",
2285
2277
  "type": "boolean",
2286
2278
  "required": "false",
2287
2279
  "default": "true",
2288
- "description": "是否显示卡片"
2280
+ "description": "是否显示卡片",
2281
+ "group": "ui"
2289
2282
  },
2290
2283
  {
2291
2284
  "name": "column",
2292
2285
  "type": "number|object",
2293
2286
  "required": "false",
2294
2287
  "default": "3",
2295
- "description": "一行的 DescriptionItems 数量,可以写成像素值或支持响应式的对象写法 { xs: 8, sm: 16, md: 24}"
2288
+ "description": "一行的 DescriptionItems 数量,可以写成像素值或支持响应式的对象写法 { xs: 8, sm: 16, md: 24}",
2289
+ "group": "ui"
2296
2290
  },
2297
2291
  {
2298
2292
  "name": "layout",
@@ -2300,7 +2294,7 @@
2300
2294
  "required": "false",
2301
2295
  "default": "horizontal",
2302
2296
  "description": "描述布局",
2303
- "group": "advanced"
2297
+ "group": "ui"
2304
2298
  },
2305
2299
  {
2306
2300
  "name": "bordered",
@@ -2308,7 +2302,7 @@
2308
2302
  "required": "false",
2309
2303
  "default": "false",
2310
2304
  "description": "是否展示边框",
2311
- "group": "advanced"
2305
+ "group": "ui"
2312
2306
  },
2313
2307
  {
2314
2308
  "name": "size",
@@ -2316,23 +2310,21 @@
2316
2310
  "required": "false",
2317
2311
  "default": "-",
2318
2312
  "description": "设置列表的大小。可以设置为 middle 、small, 或不填(只有设置 bordered={true} 生效)",
2319
- "group": "advanced"
2313
+ "group": "ui"
2320
2314
  },
2321
2315
  {
2322
2316
  "name": "configProps",
2323
2317
  "type": "DescriptionsProps",
2324
2318
  "required": "false",
2325
2319
  "default": "-",
2326
- "description": "ant-design 相关配置项,具体查阅:[https://ant.design/components/descriptions-cn/#Descriptions](https://ant.design/components/descriptions-cn/#Descriptions)",
2327
- "group": "advanced"
2320
+ "description": "ant-design 相关配置项,具体查阅:[Descriptions](https://ant.design/components/descriptions-cn/#Descriptions)"
2328
2321
  },
2329
2322
  {
2330
2323
  "name": "hideGroups",
2331
2324
  "type": "string[] | string",
2332
2325
  "required": "false",
2333
2326
  "default": "-",
2334
- "description": "设置需要隐藏的描述列表项。请先在 itemList 中定义列表项所属 group",
2335
- "group": "advanced"
2327
+ "description": "设置需要隐藏的描述列表项。请先在 itemList 中定义列表项所属 group"
2336
2328
  },
2337
2329
  {
2338
2330
  "name": "dataSource",
@@ -2340,8 +2332,7 @@
2340
2332
  "required": "false",
2341
2333
  "default": "-",
2342
2334
  "deprecated": true,
2343
- "description": "[已废弃]数据来源,通常来源于后台",
2344
- "group": "advanced"
2335
+ "description": "[已废弃]数据来源,通常来源于后台"
2345
2336
  }
2346
2337
  ],
2347
2338
  "interface": [
@@ -4761,7 +4752,7 @@
4761
4752
  {
4762
4753
  "description": {
4763
4754
  "title": "基础用法",
4764
- "message": "注意对表格数据进行筛选时,需将页码恢复为第一页。"
4755
+ "message": "注意对表格数据进行筛选时,需将页码恢复为第一页"
4765
4756
  },
4766
4757
  "brick": "presentational-bricks.brick-table",
4767
4758
  "properties": {
@@ -4769,8 +4760,6 @@
4769
4760
  "testid": "basic-demo"
4770
4761
  },
4771
4762
  "rowKey": "id",
4772
- "page": "${query.page=1|number}",
4773
- "pageSize": "${query.pageSize=10|number}",
4774
4763
  "shouldUpdateUrlParams": false,
4775
4764
  "rowDisabledConfig": {
4776
4765
  "field": "name",
@@ -4817,11 +4806,9 @@
4817
4806
  "dataIndex": "tags",
4818
4807
  "useBrick": {
4819
4808
  "brick": "presentational-bricks.brick-tag",
4820
- "transform": {
4821
- "tagList": "@{cellData}"
4822
- },
4823
4809
  "properties": {
4824
4810
  "showCard": false,
4811
+ "tagList": "<% DATA.cellData %>",
4825
4812
  "configProps": {
4826
4813
  "color": "var(--color-brand)"
4827
4814
  }
@@ -4834,10 +4821,8 @@
4834
4821
  "dataIndex": "operate",
4835
4822
  "useBrick": {
4836
4823
  "brick": "presentational-bricks.brick-link",
4837
- "transform": {
4838
- "dataSource": "@{rowData}"
4839
- },
4840
4824
  "properties": {
4825
+ "dataSource": "<% DATA.rowData %>",
4841
4826
  "notToJumpWhenEmpty": true,
4842
4827
  "icon": {
4843
4828
  "lib": "fa",
@@ -5021,13 +5006,10 @@
5021
5006
  "expandedRowBrick": {
5022
5007
  "useBrick": {
5023
5008
  "brick": "presentational-bricks.brick-table",
5024
- "transformFrom": "rowData",
5025
- "transform": {
5026
- "dataSource": {
5027
- "list": "@{containerList}"
5028
- }
5029
- },
5030
5009
  "properties": {
5010
+ "dataSource": {
5011
+ "list": "<% DATA.rowData.containerList %>"
5012
+ },
5031
5013
  "style": {
5032
5014
  "background": "#f5f5f5"
5033
5015
  },
@@ -5051,10 +5033,8 @@
5051
5033
  "dataIndex": "operate",
5052
5034
  "useBrick": {
5053
5035
  "brick": "presentational-bricks.brick-link",
5054
- "transform": {
5055
- "dataSource": "@{rowData}"
5056
- },
5057
5036
  "properties": {
5037
+ "dataSource": "<% DATA.rowData %>",
5058
5038
  "notToJumpWhenEmpty": true,
5059
5039
  "icon": {
5060
5040
  "lib": "fa",
@@ -5167,8 +5147,6 @@
5167
5147
  "testid": "customized-expand-icon-demo"
5168
5148
  },
5169
5149
  "rowKey": "id",
5170
- "page": "${query.page=1|number}",
5171
- "pageSize": "${query.pageSize=10|number}",
5172
5150
  "expandIcon": {
5173
5151
  "collapsedIcon": {
5174
5152
  "lib": "fa",
@@ -5307,8 +5285,8 @@
5307
5285
  "dataIndex": "branch",
5308
5286
  "useBrick": {
5309
5287
  "brick": "presentational-bricks.brick-link",
5310
- "transform": {
5311
- "label": "@{cellData}"
5288
+ "properties": {
5289
+ "label": "<% DATA.cellData %>"
5312
5290
  }
5313
5291
  },
5314
5292
  "cellStatus": {
@@ -5342,10 +5320,8 @@
5342
5320
  "dataIndex": "status",
5343
5321
  "useBrick": {
5344
5322
  "brick": "presentational-bricks.brick-value-mapping",
5345
- "transform": {
5346
- "value": "@{cellData}"
5347
- },
5348
5323
  "properties": {
5324
+ "value": "<% DATA.cellData %>",
5349
5325
  "mapping": {
5350
5326
  "success": {
5351
5327
  "color": "green"
@@ -5451,10 +5427,8 @@
5451
5427
  "dataIndex": "tags",
5452
5428
  "useBrick": {
5453
5429
  "brick": "presentational-bricks.brick-tag",
5454
- "transform": {
5455
- "tagList": "@{cellData}"
5456
- },
5457
5430
  "properties": {
5431
+ "tagList": "<% DATA.cellData %>",
5458
5432
  "showCard": false,
5459
5433
  "configProps": {
5460
5434
  "color": "var(--color-brand)"
@@ -5468,10 +5442,8 @@
5468
5442
  "dataIndex": "operate",
5469
5443
  "useBrick": {
5470
5444
  "brick": "presentational-bricks.brick-link",
5471
- "transform": {
5472
- "dataSource": "@{rowData}"
5473
- },
5474
5445
  "properties": {
5446
+ "dataSource": "<% DATA.rowData %>",
5475
5447
  "notToJumpWhenEmpty": true,
5476
5448
  "icon": {
5477
5449
  "lib": "fa",
@@ -5643,7 +5615,8 @@
5643
5615
  },
5644
5616
  {
5645
5617
  "description": {
5646
- "title": "前端搜索"
5618
+ "title": "前端搜索",
5619
+ "message": "前端搜索需要搭配构件的 `filterSourceData` 方法使用"
5647
5620
  },
5648
5621
  "brick": "basic-bricks.general-card",
5649
5622
  "properties": {
@@ -5688,6 +5661,7 @@
5688
5661
  {
5689
5662
  "brick": "presentational-bricks.brick-table",
5690
5663
  "properties": {
5664
+ "id": "front-search-table",
5691
5665
  "dataset": {
5692
5666
  "testid": "front-search-table"
5693
5667
  },
@@ -5751,7 +5725,8 @@
5751
5725
  },
5752
5726
  {
5753
5727
  "description": {
5754
- "title": "内容滚动"
5728
+ "title": "内容滚动",
5729
+ "message": "当宽度过小时,内容滑动显示"
5755
5730
  },
5756
5731
  "brick": "presentational-bricks.brick-table",
5757
5732
  "properties": {
@@ -5895,7 +5870,7 @@
5895
5870
  "title": "通知内容",
5896
5871
  "useBrick": {
5897
5872
  "brick": "presentational-bricks.markdown-display",
5898
- "transform": {
5873
+ "properties": {
5899
5874
  "value": "<% DATA.cellData || \"暂无数据\" %>"
5900
5875
  }
5901
5876
  }
@@ -5907,7 +5882,7 @@
5907
5882
  "title": "告警维度",
5908
5883
  "useBrick": {
5909
5884
  "brick": "presentational-bricks.markdown-display",
5910
- "transform": {
5885
+ "properties": {
5911
5886
  "value": "<% DATA.cellData || \"暂无数据\" %>"
5912
5887
  }
5913
5888
  }
@@ -5919,7 +5894,7 @@
5919
5894
  "title": "通知人",
5920
5895
  "useBrick": {
5921
5896
  "brick": "presentational-bricks.markdown-display",
5922
- "transform": {
5897
+ "properties": {
5923
5898
  "value": "<% DATA.cellData || \"暂无数据\" %>"
5924
5899
  }
5925
5900
  }
@@ -5936,10 +5911,9 @@
5936
5911
  },
5937
5912
  "transform": {
5938
5913
  "dataSource": {
5939
- "list": "@{containerList}"
5914
+ "list": "<% DATA.rowData.containerList %>"
5940
5915
  }
5941
- },
5942
- "transformFrom": "rowData"
5916
+ }
5943
5917
  }
5944
5918
  },
5945
5919
  "expandIconAsCell": false,
@@ -6081,7 +6055,7 @@
6081
6055
  "title": "IP",
6082
6056
  "useBrick": {
6083
6057
  "brick": "span",
6084
- "transform": {
6058
+ "properties": {
6085
6059
  "textContent": "<% DATA.cellData || DATA.rowData.clusterName %>"
6086
6060
  }
6087
6061
  },
@@ -6145,7 +6119,8 @@
6145
6119
  },
6146
6120
  {
6147
6121
  "description": {
6148
- "title": "使用 flattenTreeDataListAndCalcRowSpan custom processor 平铺树形结构列表,并计算行合并"
6122
+ "title": "使用 flattenTreeDataListAndCalcRowSpan custom processor 平铺树形结构列表,并计算行合并",
6123
+ "message": "以上示例使用了 `PROCESSORS` 加工函数,具体可查看 [Custom Processors](/next-docs/docs/brick-next/custom-processors)"
6149
6124
  },
6150
6125
  "brick": "presentational-bricks.brick-table",
6151
6126
  "properties": {
@@ -6185,9 +6160,25 @@
6185
6160
  "en": "Basic",
6186
6161
  "zh": "常用"
6187
6162
  },
6188
- "advanced": {
6189
- "en": "Advanced",
6190
- "zh": "高级"
6163
+ "paginationAndFilter": {
6164
+ "en": "Pagination/Order/Filter",
6165
+ "zh": "分页/排序及搜索"
6166
+ },
6167
+ "expand": {
6168
+ "en": "Expand/Collapse",
6169
+ "zh": "展开/折叠"
6170
+ },
6171
+ "ui": {
6172
+ "en": "UI",
6173
+ "zh": "外观"
6174
+ },
6175
+ "rowSelection": {
6176
+ "en": "RowSelection",
6177
+ "zh": "行选择配置(rowSelection)"
6178
+ },
6179
+ "other": {
6180
+ "en": "其他",
6181
+ "zh": "other"
6191
6182
  }
6192
6183
  },
6193
6184
  "author": "lynette",
@@ -6266,99 +6257,95 @@
6266
6257
  "change": "新增 `shouldUpdateUrlParams` 属性和 `sort.update` 事件"
6267
6258
  }
6268
6259
  ],
6269
- "memo": "> Tips: 在 react 中,boolean 类型的值是合法的子元素,但是不会被渲染出来。如果希望 boolean 值在表格单元格中展示成 `true`|`false`,可以使用平台管道进行转换,例如`@{someProperties|string}`。更多场景下可以结合 [基本数值映射构件](developers/brick-book/brick/presentational-bricks.brick-value-mapping) 把 boolean 类型的值转换成有意义的文本进行展示。\n\n## dataSource 表格数据源\n| property | type | required | default | description |\n| ------------- | -------------- | -------- | ------- | -------------------------------------------------- |\n| dataSource | any | - | - | 数据源,通过 useResolves 从后台接口获取或者直接在 storyboard 中配置 |\n\n## columns 表格列配置\n| property | type | required | default | description |\n| ------------- | -------------- | -------- | ------- | -------------------------------------------------- |\n| columns | CustomColumn[] | - | - | 扩展自 ant-design 的 Column 相关配置项,具体查阅:[https://ant.design/components/table-cn/#Column](https://ant.design/components/table-cn/#Column) |\n\n### CustomColumn\n| property | type | required | default | description |\n| -------------------- | --------------------- | -------- | ------- | -------------------------------------------------------------- |\n| <del>component</del> | CustomColumnComponent | - | - | Deprecated。支持为某列自定义展示构件 |\n| valueSuffix | string | - | - | 字段的值展示时的后缀 |\n| useBrick | UseBrickConf | - | - | 支持为某列自定义展示构件 |\n| titleUseBrick | UseBrickConf | - | - | 支持为某列的标题自定义展示构件,可通过 DATA.title 获取标题文本 |\n| filters | {text:string,value:any}[] | - | - | 表头的筛选菜单项 |\n| verticalAlign | `top` &#124; `bottom` | - | - | 单元格内元素的垂直对齐方式 |\n| colSpanKey | string | - | - | 每条记录的控制列合并的值的 key |\n| rowSpanKey | string | - | - | 每条记录的控制行合并的值的 key。如果希望将树形列表展平,并计算行合并的值,可以使用 flattenTreeDataListAndCalcRowSpan 自定义加工函数 |\n\n### UseBrickConf\n\n| property | type | required | default | description |\n| ------------- | -------------- | -------- | ------- | -------------------------------------------------- |\n| brick | string | ✔️ | - | 构件名称 |\n| properties | object | - | - | 构件属性 |\n| events | BrickEventsMap | - | - | 事件 |\n| transform | string\\|object | - | - | 属性数据转换 |\n| transformFrom | string | - | - | 属性数据转换来自数据源的哪个字段,不填则为整个数据 |\n\n`<presentational-bricks.brick-table>` 为某列自定义展示构件传递的数据源为:\n\n| field | type | description |\n| ----------- | ------ | ----------- |\n| cellData | any | 单元格数据 |\n| rowData | any | 整行数据 |\n| columnIndex | number | 列序号 |\n\n`<presentational-bricks.brick-table>` 为自定义行展开的构件传递的数据源为:\n\n| field | type | description |\n| -------- | ------ | ----------- |\n| rowData | any | 整行数据 |\n| rowIndex | number | 行序号 |\n\n### <del>CustomColumnComponent</del>\n\n<details>\n<summary>展开</summary>\n\n| property | type | required | default | description |\n| ---------- | -------------------------------------------- | -------- | ------- | ----------------------------------------------- |\n| brick | string | ✔️ | - | 构件名称 |\n| fields | {value: string; item: string; index: string} | ✔️ | - | 字段值、列表项和 index 对应所用构件的属性的 key |\n| properties | object | - | - | 构件属性 |\n| events | BrickEventsMap | - | - | 事件 |\n\n</details>\n\n### fields\n| property | type | required | default | description |\n| ---------- | ------ | -------- | -------- | -------------------------------------------------------------------------------------------------------- |\n| fields | fieldsType | - | - | 设置相关字段取自哪里,具体描述见下表 |\n\n### fieldsType\n| property | type | required | default | description |\n| ---------- | ------ | -------- | -------- | -------------------------------------------------------------------------------------------------------- |\n| dataSource | string | - | list | 指定 dataSource 从哪里来,默认为列表接口返回格式是{list:[],page:1,pageSize:10,total:20},即默认取自 list |\n| total | string | - | total | 指定 total 从哪里来,默认为列表接口返回格式是{list:[],page:1,pageSize:10,total:20},即默认取自 total |\n| page | string | - | page | 指定下表中 \"page.update\" 事件 detail 的 pagePath |\n| pageSize | string | - | pageSize | 指定下表 \"filter.update\" 事件 detail 的 pageSizePath |\n| ascend | string | - | ascend | 指定 ascend 升序排序对应字段,例如有些后台对应为 1 ,有些对应为 \"asc\"。这里默认为 \"ascend\" |\n| descend | string | - | descend | 指定 descend 降序排序对应字段,例如有些后台对应为 0 ,有些对应为 \"desc\"。这里默认为 \"descend\" |\n\n### pagination 默认配置\n\n如果不希望分页,只需在 storyboard 中如下设置即可:\n\n```\n{\n \"configProps\": {\n \"pagination\": false\n }\n}\n```\n\n如果希望覆盖默认配置,只需在 storyboard 中覆盖对应项即可,相关配置项具体查阅:<a href=\"https://ant.design/components/pagination-cn/#API\" target=\"_blank\">https://ant.design/components/pagination-cn/#API</a>:\n\n```\n{\n \"configProps\": {\n \"pagination\": {\n \"pageSizeOptions\": [\"10\",\"100\",\"1000\"]\n }\n }\n}\n```\n\n| property | type | required | default | description |\n| --------------- | -------- | -------- | ------------------ | ------------------------------------- |\n| current | string | - | - | 页码,从 page properties 获取 |\n| pageSize | string | - | - | 每页条数,从 pageSize properties 获取 |\n| total | object | - | - | 总数,从 dataSource.total 获取 |\n| showSizeChanger | boolean | - | true | 展示页码变化器 |\n| pageSizeOptions | array | - | [\"10\", \"20\", \"50\"] | 每页条数选项 |\n| showTotal | function | - | - | 渲染成\"共 xx 条\" |\n\n\n### rowSelection 默认配置\n\n行选择默认为 false,即如果不在 storyboard 中配置就不显示。如果要开启只需在 storyboard 中如下设置即可,这时 brick-table 会默认配置 onChange 事件:\n\n```\n{\n \"configProps\": {\n \"rowSelection\": true\n }\n}\n```\n\n如果希望覆盖或者扩展默认配置,只需在 storyboard 中覆盖对应项即可,相关配置项具体查阅:<a href=\"https://ant.design/components/table-cn/#rowSelection\" target=\"_blank\">https://ant.design/components/table-cn/#rowSelection</a>:\n\n```\n{\n \"configProps\": {\n \"rowSelection\": {\n \"columnWidth\": \"88px\"\n }\n }\n}\n```\n\n| property | type | required | default | description |\n| -------- | -------- | -------- | ------- | --------------------------------- |\n| onChange | function | - | - | 选择行,会抛出事件\"select.update\" |\n\n### 排序\n\n如果某一列希望排序,则可以设对应列 `sorter:true`,例如:\n\n```\n{\n \"columns\": [\n {\n \"title\": \"主机\",\n \"key\": \"hostname\",\n \"dataIndex\": \"hostname\",\n \"sorter\": true\n }\n ]\n}\n```\n\n## flattenTreeDataListAndCalcRowSpan 自定义加工函数\n\n将树形数据列表按照 `options.flattenConfigs` 进行展平,并生成相应的行合并数据\n\n### Params\n\n| param | type | required | default | description |\n| ------------ | ------------------------------------------ | -------- | ------- | ------------------------------------------------------------------------ |\n| treeDataList | `Record<string, unknown>[]` | ✔️ | - | 树形数据列表 |\n| options | `FlattenTreeDataListAndCalcRowSpanOptions` | ✔️ | - | 函数选项 |\n| depth | `number` | - | `0` | 当前展平的深度,用于确定 `options.flattenConfigs` 中的当前层级的展平配置 |\n\n### Returns\n\n| type | description |\n| --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `Record<string, unknown>[]` | 展平后的列表,除了按照 `options.flattenConfigs` 进行展平外,还会生成相应层级以 `options.flattenConfigs[].parentInChildKey + \"RowSpan\"` 为 key 的行合并数据 |\n\n### FlattenTreeDataListAndCalcRowSpanOptions\n\n| property | type | required | default | description |\n| -------------------- | ----------------- | -------- | ------- | ---------------------------------------- |\n| flattenConfigs | `FlattenConfig[]` | ✔️ | - | 展平配置列表,按照由父到子的顺序一一对应 |\n| omitChildrenInParent | `boolean` | - | - | 展平后,是否省略父级里的子列表 |\n\n### FlattenConfig\n\n| property | type | required | default | description |\n| ---------------- | -------- | -------- | ------- | ------------------------ |\n| childrenKey | `string` | ✔️ | - | 对应层级子列表的 key |\n| parentInChildKey | `string` | ✔️ | - | 展平后,父级在子级的 key |",
6260
+ "memo": "> Tips: 在 react 中,boolean 类型的值是合法的子元素,但是不会被渲染出来。如果希望 boolean 值在表格单元格中展示成 `true`|`false`,可以使用平台管道进行转换,例如`@{someProperties|string}`。更多场景下可以结合 [基本数值映射构件](developers/brick-book/brick/presentational-bricks.brick-value-mapping) 把 boolean 类型的值转换成有意义的文本进行展示。\n### CustomColumn\n| property | type | required | default | description |\n| -------------------- | --------------------- | -------- | ------- | -------------------------------------------------------------- |\n| ~~component~~ | ~~CustomColumnComponent~~ | - | - | ~~ Deprecated。支持为某列自定义展示构件 ~~ |\n| valueSuffix | string | - | - | 字段的值展示时的后缀 |\n| useBrick | UseBrickConf | - | - | 支持为某列自定义展示构件, 具体查看 [UseBrickConf](/next-docs/docs/api-reference/brick-types.usesinglebrickconf) |\n| titleUseBrick | UseBrickConf | - | - | 支持为某列的标题自定义展示构件,可通过 DATA.title 获取标题文本,具体查看 [UseBrickConf](/next-docs/docs/api-reference/brick-types.usesinglebrickconf) |\n| filters | {text:string,value:any}[] | - | - | 表头的筛选菜单项 |\n| verticalAlign | top \\| bottom | - | - | 单元格内元素的垂直对齐方式 |\n| colSpanKey | string | - | - | 每条记录的控制列合并的值的 key |\n| rowSpanKey | string | - | - | 每条记录的控制行合并的值的 key。如果希望将树形列表展平,并计算行合并的值,可以使用 flattenTreeDataListAndCalcRowSpan 自定义加工函数 |\n\n### UseBrickConf\n\n| property | type | required | default | description |\n| ------------- | -------------- | -------- | ------- | -------------------------------------------------- |\n| brick | string | ✔️ | - | 构件名称 |\n| properties | object | - | - | 构件属性 |\n| events | BrickEventsMap | - | - | 事件 |\n| transform | string\\|object | - | - | 属性数据转换 |\n| transformFrom | string | - | - | 属性数据转换来自数据源的哪个字段,不填则为整个数据 |\n\n`<presentational-bricks.brick-table>` 为某列自定义展示构件传递的数据源为:\n\n| field | type | description |\n| ----------- | ------ | ----------- |\n| cellData | any | 单元格数据 |\n| rowData | any | 整行数据 |\n| columnIndex | number | 列序号 |\n\n`<presentational-bricks.brick-table>` 为自定义行展开的构件传递的数据源为:\n\n| field | type | description |\n| -------- | ------ | ----------- |\n| rowData | any | 整行数据 |\n| rowIndex | number | 行序号 |\n\n### <del>CustomColumnComponent</del>\n\n<details>\n<summary>展开</summary>\n\n| property | type | required | default | description |\n| ---------- | -------------------------------------------- | -------- | ------- | ----------------------------------------------- |\n| brick | string | ✔️ | - | 构件名称 |\n| fields | {value: string; item: string; index: string} | ✔️ | - | 字段值、列表项和 index 对应所用构件的属性的 key |\n| properties | object | - | - | 构件属性 |\n| events | BrickEventsMap | - | - | 事件 |\n\n</details>\n\n### fields\n| property | type | required | default | description |\n| ---------- | ------ | -------- | -------- | -------------------------------------------------------------------------------------------------------- |\n| fields | fieldsType | - | - | 设置相关字段取自哪里,具体描述见下表 |\n\n### fieldsType\n| property | type | required | default | description |\n| ---------- | ------ | -------- | -------- | -------------------------------------------------------------------------------------------------------- |\n| dataSource | string | - | list | 指定 dataSource 从哪里来,默认为列表接口返回格式是{list:[],page:1,pageSize:10,total:20},即默认取自 list |\n| total | string | - | total | 指定 total 从哪里来,默认为列表接口返回格式是{list:[],page:1,pageSize:10,total:20},即默认取自 total |\n| page | string | - | page | 指定下表中 \"page.update\" 事件 detail 的 pagePath |\n| pageSize | string | - | pageSize | 指定下表 \"filter.update\" 事件 detail 的 pageSizePath |\n| ascend | string | - | ascend | 指定 ascend 升序排序对应字段,例如有些后台对应为 1 ,有些对应为 \"asc\"。这里默认为 \"ascend\" |\n| descend | string | - | descend | 指定 descend 降序排序对应字段,例如有些后台对应为 0 ,有些对应为 \"desc\"。这里默认为 \"descend\" |\n\n### pagination 默认配置\n\n如果不希望分页,只需在 storyboard 中如下设置即可:\n\n```\n{\n \"configProps\": {\n \"pagination\": false\n }\n}\n```\n\n如果希望覆盖默认配置,只需在 storyboard 中覆盖对应项即可,相关配置项具体查阅:[pagination](https://ant.design/components/pagination-cn/#API)\n\n```\n{\n \"configProps\": {\n \"pagination\": {\n \"pageSizeOptions\": [\"10\",\"100\",\"1000\"]\n }\n }\n}\n```\n\n| property | type | required | default | description |\n| --------------- | -------- | -------- | ------------------ | ------------------------------------- |\n| current | string | - | - | 页码,从 page properties 获取 |\n| pageSize | string | - | - | 每页条数,从 pageSize properties 获取 |\n| total | object | - | - | 总数,从 dataSource.total 获取 |\n| showSizeChanger | boolean | - | true | 展示页码变化器 |\n| pageSizeOptions | array | - | [\"10\", \"20\", \"50\"] | 每页条数选项 |\n| showTotal | function | - | - | 渲染成\"共 xx 条\" |\n\n\n### rowSelection 默认配置\n\n行选择默认为 false,即如果不在 storyboard 中配置就不显示。如果要开启只需在 storyboard 中如下设置即可,这时 brick-table 会默认配置 onChange 事件:\n\n```\n{\n \"configProps\": {\n \"rowSelection\": true\n }\n}\n```\n\n如果希望覆盖或者扩展默认配置,只需在 storyboard 中覆盖对应项即可,相关配置项具体查阅:[rowSelection](https://ant.design/components/table-cn/#rowSelection)\n\n```\n{\n \"configProps\": {\n \"rowSelection\": {\n \"columnWidth\": \"88px\"\n }\n }\n}\n```\n\n| property | type | required | default | description |\n| -------- | -------- | -------- | ------- | --------------------------------- |\n| onChange | function | - | - | 选择行,会抛出事件\"select.update\" |\n\n### 排序\n\n如果某一列希望排序,则可以设对应列 `sorter:true`,例如:\n\n```\n{\n \"columns\": [\n {\n \"title\": \"主机\",\n \"key\": \"hostname\",\n \"dataIndex\": \"hostname\",\n \"sorter\": true\n }\n ]\n}\n```\n\n## flattenTreeDataListAndCalcRowSpan 自定义加工函数\n\n将树形数据列表按照 `options.flattenConfigs` 进行展平,并生成相应的行合并数据\n\n### Params\n\n| param | type | required | default | description |\n| ------------ | ------------------------------------------ | -------- | ------- | ------------------------------------------------------------------------ |\n| treeDataList | `Record<string, unknown>[]` | ✔️ | - | 树形数据列表 |\n| options | `FlattenTreeDataListAndCalcRowSpanOptions` | ✔️ | - | 函数选项 |\n| depth | `number` | - | 0 | 当前展平的深度,用于确定 `options.flattenConfigs` 中的当前层级的展平配置 |\n\n### Returns\n\n| type | description |\n| --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `Record<string, unknown>[]` | 展平后的列表,除了按照 `options.flattenConfigs` 进行展平外,还会生成相应层级以 `options.flattenConfigs[].parentInChildKey + \"RowSpan\"` 为 key 的行合并数据 |\n\n### FlattenTreeDataListAndCalcRowSpanOptions\n\n| property | type | required | default | description |\n| -------------------- | ----------------- | -------- | ------- | ---------------------------------------- |\n| flattenConfigs | `FlattenConfig[]` | ✔️ | - | 展平配置列表,按照由父到子的顺序一一对应 |\n| omitChildrenInParent | `boolean` | - | - | 展平后,是否省略父级里的子列表 |\n\n### FlattenConfig\n\n| property | type | required | default | description |\n| ---------------- | -------- | -------- | ------- | ------------------------ |\n| childrenKey | `string` | ✔️ | - | 对应层级子列表的 key |\n| parentInChildKey | `string` | ✔️ | - | 展平后,父级在子级的 key |",
6270
6261
  "properties": [
6271
6262
  {
6272
6263
  "name": "columns",
6273
6264
  "type": "CustomColumn[]",
6274
6265
  "required": "false",
6275
6266
  "default": "-",
6276
- "description": "扩展自 ant-design 的 Column 相关配置项,具体查阅:<a href=\"https://ant.design/components/table-cn/#Column\" target=\"_blank\">https://ant.design/components/table-cn/#Column</a>"
6267
+ "description": "扩展自 ant-design 的 Column 相关配置项,具体查阅:[Column](https://ant.design/components/table-cn/#Column)",
6268
+ "group": "basic"
6277
6269
  },
6278
6270
  {
6279
6271
  "name": "dataSource",
6280
6272
  "type": "any",
6281
6273
  "required": "false",
6282
6274
  "default": "-",
6283
- "description": "数据源,通过 useResolves 从后台接口获取或者直接在 storyboard 中配置"
6275
+ "description": "数据源,通过 useResolves 从后台接口获取或者直接在 storyboard 中配置",
6276
+ "group": "basic"
6284
6277
  },
6285
6278
  {
6286
6279
  "name": "rowKey",
6287
6280
  "type": "string",
6288
6281
  "required": "false",
6289
6282
  "default": "-",
6290
- "description": "指定每一行的 key,不指定则默认为索引 index。强烈建议设置该属性,否则在某些情况下可能行为不如预期。"
6283
+ "description": "指定每一行的 key,不指定则默认为索引 index。强烈建议设置该属性,否则在某些情况下可能行为不如预期。",
6284
+ "group": "basic"
6291
6285
  },
6292
6286
  {
6293
6287
  "name": "hiddenColumns",
6294
6288
  "type": "(string|number)[]",
6295
6289
  "required": "false",
6296
6290
  "default": "-",
6297
- "description": "隐藏相应列(输入对应的 dataIndex 或者 key 即可)"
6298
- },
6299
- {
6300
- "name": "shouldUpdateUrlParams",
6301
- "type": "boolean",
6302
- "required": "false",
6303
- "default": "true",
6304
- "description": "是否更新 url 参数。设置为否之后,如果是后台进行分页/排序等功能,则需要结合事件进行编排。如果是前台进行分页/排序,则不需要。"
6305
- },
6306
- {
6307
- "name": "shouldRenderWhenUrlParamsUpdate",
6308
- "type": "boolean",
6309
- "required": "false",
6310
- "default": "true",
6311
- "description": "更新 url 参数时是否触发页面重新渲染。仅在`shouldUpdateUrlParams`为true时有效。"
6291
+ "description": "隐藏相应列(输入对应的 dataIndex 或者 key 即可)",
6292
+ "group": "basic"
6312
6293
  },
6313
6294
  {
6314
6295
  "name": "showSelectInfo",
6315
6296
  "type": "boolean",
6316
6297
  "required": "false",
6317
- "default": "`false`",
6318
- "description": "是否显示已选择信息和清除按钮。仅在设置了`configProps.rowSelection`时有效。默认不显示"
6298
+ "default": "false",
6299
+ "description": "是否显示已选择信息和清除按钮。仅在设置了`configProps.rowSelection`时有效。默认不显示",
6300
+ "group": "rowSelection"
6319
6301
  },
6320
6302
  {
6321
6303
  "name": "filters",
6322
6304
  "type": "Record<string,string[]>",
6323
6305
  "required": "false",
6324
6306
  "default": "-",
6325
- "description": "表头过滤的过滤项,key 为 column 的 dataIndex,value 为过滤值集合。"
6307
+ "description": "表头过滤的过滤项,key 为 column 的 dataIndex,value 为过滤值集合。",
6308
+ "group": "paginationAndFilter"
6326
6309
  },
6327
6310
  {
6328
6311
  "name": "showCard",
6329
6312
  "type": "boolean",
6330
6313
  "required": "false",
6331
6314
  "default": "true",
6332
- "description": "是否显示外层卡片"
6315
+ "description": "是否显示外层卡片",
6316
+ "group": "ui"
6333
6317
  },
6334
6318
  {
6335
6319
  "name": "configProps",
6336
6320
  "type": "object",
6337
6321
  "required": "false",
6338
6322
  "default": "-",
6339
- "description": "ant-design 的 Table 相关配置项,具体查阅:[https://ant.design/components/table-cn/#Table](https://ant.design/components/table-cn/#Table),其中分页配置和行选择配值在构件中设置了常用的默认配置,也可自行覆盖,具体描述见下表",
6340
- "group": "advanced"
6323
+ "description": "ant-design 的 Table 相关配置项,具体查阅:[Table](https://ant.design/components/table-cn/#Table),其中分页配置和行选择配值在构件中设置了常用的默认配置,也可自行覆盖,具体描述见下表",
6324
+ "group": "other"
6341
6325
  },
6342
6326
  {
6343
6327
  "name": "sort",
6344
6328
  "type": "string",
6345
6329
  "required": "false",
6346
6330
  "default": "-",
6347
- "description": "被排序列的 dataIndex。通常来自于 url 参数,可以设置成 ${QUERY.sort}。"
6331
+ "description": "被排序列的 dataIndex。通常来自于 url 参数,可以设置成 ${QUERY.sort}。",
6332
+ "group": "paginationAndFilter"
6348
6333
  },
6349
6334
  {
6350
6335
  "name": "order",
6351
6336
  "type": "string | number",
6352
6337
  "required": "false",
6353
6338
  "default": "-",
6354
- "description": "升序/降序,可以设置成 ${QUERY.order}。"
6339
+ "description": "升序/降序,可以设置成 ${QUERY.order}。",
6340
+ "group": "paginationAndFilter"
6355
6341
  },
6356
6342
  {
6357
6343
  "name": "rowDisabledConfig",
6358
6344
  "type": "RowDisabledProps | RowDisabledProps[]",
6359
6345
  "required": "false",
6360
6346
  "default": "-",
6361
- "description": "配置每一行是否禁用,其中 `field` 表示数据源中的字段路径, `value` 表示与其字段比较的值, `operator` 表示两者比较的方法,结果为 `true` 时会禁用当前行, 需要注意的是该配置需要在 `rowSelection: true` 的前提下使用,并且设置 `rowKey` 属性赋予每行唯一的 key,防止顺序变化时造成的错误勾选(如上 demo 所示)"
6347
+ "description": "配置每一行是否禁用,其中 `field` 表示数据源中的字段路径, `value` 表示与其字段比较的值, `operator` 表示两者比较的方法,结果为 `true` 时会禁用当前行, 需要注意的是该配置需要在 `rowSelection: true` 的前提下使用,并且设置 `rowKey` 属性赋予每行唯一的 key,防止顺序变化时造成的错误勾选(如上 demo 所示)",
6348
+ "group": "rowSelection"
6362
6349
  },
6363
6350
  {
6364
6351
  "name": "expandedRowBrick",
@@ -6366,7 +6353,7 @@
6366
6353
  "required": "false",
6367
6354
  "default": "-",
6368
6355
  "description": "自定义行展开的构件",
6369
- "group": "advanced"
6356
+ "group": "expand"
6370
6357
  },
6371
6358
  {
6372
6359
  "name": "expandIcon",
@@ -6374,7 +6361,7 @@
6374
6361
  "required": "false",
6375
6362
  "default": "{collapsedIcon:{lib:'antd',icon:'down',theme:'outlined'},expandedIcon:{lib:'antd',icon:'right',theme:'outlined'}}",
6376
6363
  "description": "自定义展开图标。",
6377
- "group": "advanced"
6364
+ "group": "expand"
6378
6365
  },
6379
6366
  {
6380
6367
  "name": "expandIconAsCell",
@@ -6382,7 +6369,7 @@
6382
6369
  "required": "false",
6383
6370
  "default": "true",
6384
6371
  "description": "展开的图标是否为一个单元格,默认显示在第一列;设置为 false 的时候,可以通过`expandIconColumnIndex`属性设置展开的图标在哪一列",
6385
- "group": "advanced"
6372
+ "group": "expand"
6386
6373
  },
6387
6374
  {
6388
6375
  "name": "expandIconColumnIndex",
@@ -6390,7 +6377,7 @@
6390
6377
  "required": "false",
6391
6378
  "default": "-",
6392
6379
  "description": "展开的图标显示在哪一列,如果没有 rowSelection,默认显示在第一列,否则显示在选择框后面。当`expandIconAsCell`为 false 时,该属性生效。",
6393
- "group": "advanced"
6380
+ "group": "expand"
6394
6381
  },
6395
6382
  {
6396
6383
  "name": "expandRowByClick",
@@ -6398,7 +6385,7 @@
6398
6385
  "required": "false",
6399
6386
  "default": "false",
6400
6387
  "description": "通过点击行来展开子行",
6401
- "group": "advanced"
6388
+ "group": "expand"
6402
6389
  },
6403
6390
  {
6404
6391
  "name": "optimizedColumns",
@@ -6406,7 +6393,7 @@
6406
6393
  "required": "false",
6407
6394
  "default": "-",
6408
6395
  "description": "优化渲染的列(输入对应的 dataIndex),针对配置了 useBrick 的列。当前 antd 在更新 state 的时候,会全量渲染单元格,如果确定某一列在后续操作中不需要重新渲染,例如仅作为展示的单元格,可通过该属性设置以优化性能。注意,在树形表格中,当某一列内包含展开/收起按钮,则不应该设置该列。",
6409
- "group": "advanced"
6396
+ "group": "basic"
6410
6397
  },
6411
6398
  {
6412
6399
  "name": "wrapperConfig",
@@ -6414,7 +6401,7 @@
6414
6401
  "default": "-",
6415
6402
  "required": "false",
6416
6403
  "description": "设置容器空状态时显示`empty`构件属性",
6417
- "group": "advanced"
6404
+ "group": "ui"
6418
6405
  },
6419
6406
  {
6420
6407
  "name": "stripEmptyExpandableChildren",
@@ -6422,7 +6409,7 @@
6422
6409
  "required": "false",
6423
6410
  "default": "false",
6424
6411
  "description": "树形数据展示时是否需要去除空数组",
6425
- "group": "advanced"
6412
+ "group": "expand"
6426
6413
  },
6427
6414
  {
6428
6415
  "name": "defaultExpandAllRows",
@@ -6430,7 +6417,7 @@
6430
6417
  "required": "false",
6431
6418
  "default": "false",
6432
6419
  "description": "初始时,是否展开所有行",
6433
- "group": "advanced"
6420
+ "group": "expand"
6434
6421
  },
6435
6422
  {
6436
6423
  "name": "expandedRowKeys",
@@ -6438,7 +6425,7 @@
6438
6425
  "required": "false",
6439
6426
  "default": "-",
6440
6427
  "description": "展开的行的 rowKey",
6441
- "group": "advanced"
6428
+ "group": "expand"
6442
6429
  },
6443
6430
  {
6444
6431
  "name": "selectAllChildren",
@@ -6446,21 +6433,23 @@
6446
6433
  "required": "false",
6447
6434
  "default": "false",
6448
6435
  "description": "表格树形数据展示的时候,行选择父节点的时候是否同步勾选/取消勾选所有子节点,并且被同步勾选的子节点不能单独取消。注意,该属性必须设置 `rowKey` 属性。",
6449
- "group": "advanced"
6436
+ "group": "expand"
6450
6437
  },
6451
6438
  {
6452
6439
  "name": "defaultSelectAll",
6453
6440
  "type": "boolean",
6454
6441
  "required": "false",
6455
6442
  "default": "false",
6456
- "description": "是否默认选择所有行。注意,该属性必须设置 `rowKey` 属性。"
6443
+ "description": "是否默认选择所有行。注意,该属性必须设置 `rowKey` 属性。",
6444
+ "group": "expand"
6457
6445
  },
6458
6446
  {
6459
6447
  "name": "ellipsisInfo",
6460
6448
  "type": "boolean",
6461
6449
  "required": "false",
6462
- "default": "`false`",
6463
- "description": "是否显示省略信息"
6450
+ "default": "false",
6451
+ "description": "是否显示省略信息",
6452
+ "group": "basic"
6464
6453
  },
6465
6454
  {
6466
6455
  "name": "childrenColumnName",
@@ -6468,14 +6457,15 @@
6468
6457
  "required": "false",
6469
6458
  "default": "children",
6470
6459
  "description": "指定树形结构的列名",
6471
- "group": "advanced"
6460
+ "group": "expand"
6472
6461
  },
6473
6462
  {
6474
6463
  "name": "sortable",
6475
6464
  "type": "boolean",
6476
6465
  "required": "false",
6477
6466
  "default": "true",
6478
- "description": "是否支持排序。默认开启,当对应列的sorter设置成true时则可排序。sortable为false时则排序都不生效。"
6467
+ "description": "是否支持排序。默认开启,当对应列的sorter设置成true时则可排序。sortable为false时则排序都不生效。",
6468
+ "group": "paginationAndFilter"
6479
6469
  },
6480
6470
  {
6481
6471
  "name": "fields",
@@ -6483,71 +6473,79 @@
6483
6473
  "required": "false",
6484
6474
  "default": "-",
6485
6475
  "description": "设置相关字段取自哪里,具体描述见下表",
6486
- "group": "advanced"
6476
+ "group": "basic"
6487
6477
  },
6488
6478
  {
6489
6479
  "name": "frontSearch",
6490
6480
  "type": "boolean",
6491
6481
  "required": "false",
6492
6482
  "default": "false",
6493
- "description": "是否前端进行搜索,配合`presentational-bricks.brick-input`使用"
6483
+ "description": "是否前端进行搜索,配合`presentational-bricks.brick-input`使用",
6484
+ "group": "paginationAndFilter"
6494
6485
  },
6495
6486
  {
6496
6487
  "name": "frontSearchQuery",
6497
6488
  "type": "string",
6498
6489
  "required": "false",
6499
6490
  "default": "-",
6500
- "description": "前端搜索参数"
6491
+ "description": "前端搜索参数",
6492
+ "group": "paginationAndFilter"
6501
6493
  },
6502
6494
  {
6503
6495
  "name": "exactSearch",
6504
6496
  "type": "boolean",
6505
6497
  "required": "false",
6506
6498
  "default": "false",
6507
- "description": "是否精确搜索"
6499
+ "description": "是否精确搜索",
6500
+ "group": "paginationAndFilter"
6508
6501
  },
6509
6502
  {
6510
6503
  "name": "frontSearchFilterKeys",
6511
6504
  "type": "string[]",
6512
6505
  "required": "false",
6513
6506
  "default": "-",
6514
- "description": "进行前端搜索的字段,支持嵌套的写法如[\"name\",\"value.a\"],不配置的时候默认为对所有 columns 的 dataIndex[]进行前端搜索"
6507
+ "description": "进行前端搜索的字段,支持嵌套的写法如[\"name\",\"value.a\"],不配置的时候默认为对所有 columns 的 dataIndex[]进行前端搜索",
6508
+ "group": "paginationAndFilter"
6515
6509
  },
6516
6510
  {
6517
6511
  "name": "page",
6518
6512
  "type": "number",
6519
6513
  "required": "false",
6520
6514
  "default": "-",
6521
- "description": "页码。后台搜索的时候一般不需要配置,列表接口返回格式通常为{list:[],page:1,pageSize:10,total:20},即默认取自 page;前台搜索的时候,一般配置成 \"${query.page=1|number}\""
6515
+ "description": "页码。后台搜索的时候一般不需要配置,列表接口返回格式通常为{list:[],page:1,pageSize:10,total:20},即默认取自 page;前台搜索的时候,一般配置成 \"${query.page=1|number}\"",
6516
+ "group": "paginationAndFilter"
6522
6517
  },
6523
6518
  {
6524
6519
  "name": "pageSize",
6525
6520
  "type": "number",
6526
6521
  "required": "false",
6527
6522
  "default": "-",
6528
- "description": "页码条数。后台搜索的时候一般不需要配置,列表接口返回格式通常为{list:[],page:1,pageSize:10,total:20},即默认取自 pageSize/page_size;前台搜索的时候,一般配置成 \"${query.pageSize=10|number}\""
6523
+ "description": "页码条数。后台搜索的时候一般不需要配置,列表接口返回格式通常为{list:[],page:1,pageSize:10,total:20},即默认取自 pageSize/page_size;前台搜索的时候,一般配置成 \"${query.pageSize=10|number}\"",
6524
+ "group": "paginationAndFilter"
6529
6525
  },
6530
6526
  {
6531
6527
  "name": "scrollConfigs",
6532
6528
  "type": "{\n x?: string | number | true;\n y?: number | string;\n} & {\n scrollToFirstRowOnChange?: boolean;\n}",
6533
6529
  "required": "false",
6534
6530
  "default": "{ x: true }",
6535
- "description": "表格是否可滚动,也可以指定滚动区域的宽、高,配置项。详见 https://ant.design/components/table-cn/#scroll",
6536
- "group": "advanced"
6531
+ "description": "表格是否可滚动,也可以指定滚动区域的宽、高,配置项。详见 [scroll](https://ant.design/components/table-cn/#scroll)",
6532
+ "group": "other"
6537
6533
  },
6538
6534
  {
6539
6535
  "name": "qField",
6540
6536
  "type": "string",
6541
6537
  "required": "false",
6542
6538
  "default": "\"q\"",
6543
- "description": "把过滤条件更新到 url 时的字段名"
6539
+ "description": "把过滤条件更新到 url 时的字段名",
6540
+ "group": "paginationAndFilter"
6544
6541
  },
6545
6542
  {
6546
6543
  "name": "tableDraggable",
6547
6544
  "type": "boolean",
6548
6545
  "required": "false",
6549
6546
  "default": "false",
6550
- "description": "表格行是否可拖拽,注意,树形数据的表格不支持该功能"
6547
+ "description": "表格行是否可拖拽,注意,树形数据的表格不支持该功能",
6548
+ "group": "basic"
6551
6549
  },
6552
6550
  {
6553
6551
  "name": "zebraPattern",
@@ -6555,7 +6553,7 @@
6555
6553
  "required": "false",
6556
6554
  "default": "false",
6557
6555
  "description": "是否展示斑马纹",
6558
- "group": "advanced"
6556
+ "group": "ui"
6559
6557
  },
6560
6558
  {
6561
6559
  "name": "storeCheckedByUrl",
@@ -6563,6 +6561,14 @@
6563
6561
  "required": "false",
6564
6562
  "default": "false",
6565
6563
  "description": "翻页时是否记住之前选中的项。注意,选中项的rowKey将保存在url中,如果不设置rowKey,该设置不生效。如果选择太多可能会造成url过长,请谨慎使用",
6564
+ "group": "other"
6565
+ },
6566
+ {
6567
+ "name": "extraRows",
6568
+ "type": "Record<string, unknown>[]",
6569
+ "required": "false",
6570
+ "default": "-",
6571
+ "description": "额外的行,通常为跨页勾选时,不在当前页的行",
6566
6572
  "group": "advanced"
6567
6573
  },
6568
6574
  {
@@ -6571,7 +6577,7 @@
6571
6577
  "required": "false",
6572
6578
  "default": "false",
6573
6579
  "description": "[已废弃]请用 tableDraggable 代替",
6574
- "group": "advanced"
6580
+ "group": "other"
6575
6581
  },
6576
6582
  {
6577
6583
  "name": "autoSelectParentWhenAllChildrenSelected",
@@ -6579,49 +6585,71 @@
6579
6585
  "required": "false",
6580
6586
  "default": "false",
6581
6587
  "description": "当所有子节点选中时,自动选中父节点",
6582
- "group": "advanced"
6588
+ "group": "expand"
6583
6589
  },
6584
6590
  {
6585
6591
  "name": "thTransparent",
6586
6592
  "type": "boolean",
6587
6593
  "required": "-",
6588
6594
  "default": "-",
6589
- "description": "表格表头是否透明"
6595
+ "description": "表格表头是否透明",
6596
+ "group": "ui"
6590
6597
  },
6591
6598
  {
6592
6599
  "name": "showHeader",
6593
6600
  "type": "boolean",
6594
6601
  "required": "false",
6595
6602
  "default": "true",
6596
- "description": "是否显示表头"
6603
+ "description": "是否显示表头",
6604
+ "group": "ui"
6597
6605
  },
6598
6606
  {
6599
6607
  "name": "pagination",
6600
6608
  "type": "false | TablePaginationConfig",
6601
6609
  "required": "false",
6602
6610
  "default": "-",
6603
- "description": "是否显示分页,影响优先级低于configProps.pagination"
6611
+ "description": "是否显示分页",
6612
+ "group": "paginationAndFilter"
6604
6613
  },
6605
6614
  {
6606
6615
  "name": "size",
6607
6616
  "type": "SizeType",
6608
6617
  "required": "false",
6609
6618
  "default": "-",
6610
- "description": "表格大小(antd原生size),影响优先级低于configProps.size"
6619
+ "description": "表格大小(antd原生size",
6620
+ "group": "ui"
6611
6621
  },
6612
6622
  {
6613
6623
  "name": "type",
6614
6624
  "type": "RowSelectionType",
6615
6625
  "required": "false",
6616
6626
  "default": "-",
6617
- "description": "选框类型(单选/多选),影响优先级低于configProps.rowSelection.type"
6627
+ "description": "选框类型(单选/多选)",
6628
+ "group": "rowSelection"
6629
+ },
6630
+ {
6631
+ "name": "shouldUpdateUrlParams",
6632
+ "type": "boolean",
6633
+ "required": "false",
6634
+ "default": "true",
6635
+ "description": "是否更新 url 参数。设置为否之后,如果是后台进行分页/排序等功能,则需要结合事件进行编排。如果是前台进行分页/排序,则不需要。",
6636
+ "group": "other"
6637
+ },
6638
+ {
6639
+ "name": "shouldRenderWhenUrlParamsUpdate",
6640
+ "type": "boolean",
6641
+ "required": "false",
6642
+ "default": "true",
6643
+ "description": "更新 url 参数时是否触发页面重新渲染。仅在`shouldUpdateUrlParams`为true时有效。",
6644
+ "group": "other"
6618
6645
  },
6619
6646
  {
6620
6647
  "name": "selectedRowKeys",
6621
6648
  "type": "React.Key[]",
6622
6649
  "default": "[]",
6623
6650
  "required": "false",
6624
- "description": "指定选中项的 key 数组"
6651
+ "description": "指定选中项的 key 数组",
6652
+ "group": "rowSelection"
6625
6653
  }
6626
6654
  ],
6627
6655
  "events": [
@@ -6665,6 +6693,10 @@
6665
6693
  {
6666
6694
  "name": "expandAll",
6667
6695
  "description": "展开所有行"
6696
+ },
6697
+ {
6698
+ "name": "filterSourceData",
6699
+ "description": "搜索过滤"
6668
6700
  }
6669
6701
  ],
6670
6702
  "interface": [