@next-bricks/basic-bricks 1.211.1 → 1.211.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.
package/dist/stories.json CHANGED
@@ -226,6 +226,71 @@
226
226
  }
227
227
  ],
228
228
  "memo": "### interface\n```typescript\ninterface ItemData {\n list: Record<string, any>[];\n page_size?: number | string;\n page?: number | string }\n}\n\ninterface AdvanceListContainerProps {\n data: {\n list: Record<string, any>[];\n page_size?: number | string;\n page?: number | string;\n };\n titleBrick: { useBrick: UseBrickConf };\n suffixBrick?: { useBrick: UseBrickConf };\n itemClick?: () => void;\n selectable?: boolean;\n defaultActiveIndex?: number;\n}\n```",
229
+ "events": [
230
+ {
231
+ "type": "item.click",
232
+ "detail": "`{item: any, index: number}`",
233
+ "description": "当前项的所有数据以及当前项的索引"
234
+ }
235
+ ],
236
+ "properties": [
237
+ {
238
+ "name": "data",
239
+ "type": "ItemData",
240
+ "required": "true",
241
+ "default": "-",
242
+ "description": "列表数据",
243
+ "group": "basic"
244
+ },
245
+ {
246
+ "name": "titleBrick",
247
+ "type": "{useBrick:UseBrickConf}",
248
+ "required": "true",
249
+ "default": "-",
250
+ "description": "列表项标题位置,相关类型[UseBrickConf](/next-docs/docs/api-reference/brick-types.usebrickconf)",
251
+ "group": "basic"
252
+ },
253
+ {
254
+ "name": "suffixBrick",
255
+ "type": "{useBrick:UseBrickConf}",
256
+ "required": "false",
257
+ "default": "-",
258
+ "description": "列表项 extra 位置(右边),相关类型[UseBrickConf](/next-docs/docs/api-reference/brick-types.usebrickconf)",
259
+ "group": "basic"
260
+ },
261
+ {
262
+ "name": "showCard",
263
+ "type": "boolean",
264
+ "required": "false",
265
+ "default": "false",
266
+ "description": "是否展示 card",
267
+ "group": "ui"
268
+ },
269
+ {
270
+ "name": "defaultActiveIndex",
271
+ "type": "number",
272
+ "required": "false",
273
+ "default": "-",
274
+ "description": "默认选中项",
275
+ "group": "basic"
276
+ },
277
+ {
278
+ "name": "notTriggerClickEventWhenInit",
279
+ "type": "boolean",
280
+ "required": "false",
281
+ "default": "false",
282
+ "description": "设置`defaultActiveIndex`时,构件初始化时会默认触发item.click事件,如果item.click后需要刷新页面,则会造成构件不断render,页面不断重刷,为避免此情况,可将此项设为true",
283
+ "group": "basic"
284
+ },
285
+ {
286
+ "name": "selectable",
287
+ "type": "boolean",
288
+ "required": "false",
289
+ "default": "true",
290
+ "description": "选项是否可选",
291
+ "group": "basic"
292
+ }
293
+ ],
229
294
  "interface": []
230
295
  }
231
296
  },
@@ -401,6 +466,50 @@
401
466
  }
402
467
  ],
403
468
  "dockind": "brick",
469
+ "properties": [
470
+ {
471
+ "name": "gridAreas",
472
+ "type": "Record<string, (string | number)[]>",
473
+ "required": true,
474
+ "description": "以键值对形式定义多个 [grid-area](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-area)",
475
+ "group": "basic"
476
+ },
477
+ {
478
+ "name": "gridTemplateAreas",
479
+ "type": "string[][]",
480
+ "required": true,
481
+ "description": "定义 [grid-template-areas](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-areas)",
482
+ "group": "basic"
483
+ },
484
+ {
485
+ "name": "gridTemplateColumns",
486
+ "type": "string | string[]",
487
+ "required": true,
488
+ "description": "定义 [grid-template-columns](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-columns)",
489
+ "group": "basic"
490
+ },
491
+ {
492
+ "name": "gridTemplateRows",
493
+ "type": "string | string[]",
494
+ "required": true,
495
+ "description": "定义 [grid-template-rows](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-rows)",
496
+ "group": "basic"
497
+ },
498
+ {
499
+ "name": "containerStyle",
500
+ "type": "CSSProperties",
501
+ "required": true,
502
+ "description": "定义网格容器的样式",
503
+ "group": "basic"
504
+ },
505
+ {
506
+ "name": "styleByAreas",
507
+ "type": "Record<string, CSSProperties>",
508
+ "required": true,
509
+ "description": "定义网格内各区域的样式",
510
+ "group": "basic"
511
+ }
512
+ ],
404
513
  "interface": []
405
514
  }
406
515
  },
@@ -481,6 +590,41 @@
481
590
  }
482
591
  ],
483
592
  "memo": "",
593
+ "properties": [
594
+ {
595
+ "name": "fileName",
596
+ "type": "string",
597
+ "required": "false",
598
+ "default": "-",
599
+ "description": "导出的文件名",
600
+ "group": "basic"
601
+ },
602
+ {
603
+ "name": "data",
604
+ "type": "object | string",
605
+ "required": "-",
606
+ "default": "-",
607
+ "description": "导出的文件数据",
608
+ "group": "basic"
609
+ }
610
+ ],
611
+ "events": [
612
+ {
613
+ "type": "json-file.export.failed",
614
+ "description": "导出文件失败"
615
+ },
616
+ {
617
+ "type": "json-file.export.success",
618
+ "description": "导出文件成功"
619
+ }
620
+ ],
621
+ "methods": [
622
+ {
623
+ "name": "export",
624
+ "params": "[{ detail: { fileName: string; data: object | string; } }]",
625
+ "description": "导出数据"
626
+ }
627
+ ],
484
628
  "interface": []
485
629
  }
486
630
  },
@@ -525,6 +669,28 @@
525
669
  "slots": null,
526
670
  "history": null,
527
671
  "memo": "",
672
+ "properties": [
673
+ {
674
+ "name": "useBrick",
675
+ "type": "UseBrickConf",
676
+ "required": true
677
+ },
678
+ {
679
+ "name": "foldName",
680
+ "type": "string",
681
+ "required": true
682
+ },
683
+ {
684
+ "name": "foldStyle",
685
+ "type": "Record<string, string>",
686
+ "required": true
687
+ },
688
+ {
689
+ "name": "defaultShow",
690
+ "type": "boolean",
691
+ "required": false
692
+ }
693
+ ],
528
694
  "interface": []
529
695
  }
530
696
  },
@@ -652,6 +818,72 @@
652
818
  }
653
819
  ],
654
820
  "memo": "",
821
+ "properties": [
822
+ {
823
+ "name": "foldName",
824
+ "type": "string",
825
+ "required": "true",
826
+ "default": "-",
827
+ "description": "折叠展示名称",
828
+ "group": "basic"
829
+ },
830
+ {
831
+ "name": "defaultShow",
832
+ "type": "boolean",
833
+ "required": "false",
834
+ "default": "-",
835
+ "description": "是否默认展开",
836
+ "group": "basic"
837
+ },
838
+ {
839
+ "name": "type",
840
+ "type": "\"normal\" | \"primary\"",
841
+ "required": "false",
842
+ "default": "\"normal\"",
843
+ "description": "折叠面板类型",
844
+ "group": "basic"
845
+ },
846
+ {
847
+ "name": "isShowFoldIcon",
848
+ "type": "boolean",
849
+ "required": "false",
850
+ "default": "true",
851
+ "description": "是否显示展开图标",
852
+ "group": "ui"
853
+ },
854
+ {
855
+ "name": "foldStyle",
856
+ "type": "object",
857
+ "required": "false",
858
+ "default": "-",
859
+ "description": "折叠展示的样式编写",
860
+ "group": "ui"
861
+ },
862
+ {
863
+ "name": "showDivider",
864
+ "type": "boolean",
865
+ "required": "false",
866
+ "default": "-",
867
+ "description": "是否展示分割线",
868
+ "group": "divider"
869
+ },
870
+ {
871
+ "name": "dividerOrientation",
872
+ "type": "\"left\"|\"right\"|\"center\"",
873
+ "required": "false",
874
+ "default": "center",
875
+ "description": "分割线标题的位置",
876
+ "group": "divider"
877
+ },
878
+ {
879
+ "name": "dividerDashed",
880
+ "type": "boolean",
881
+ "required": "false",
882
+ "default": "false",
883
+ "description": "是否虚线",
884
+ "group": "divider"
885
+ }
886
+ ],
655
887
  "interface": []
656
888
  }
657
889
  },
@@ -814,7 +1046,205 @@
814
1046
  }
815
1047
  ],
816
1048
  "memo": "注意,因为按钮是有 margin 的,在`type=link` 时候也一样会有,所以在表格里面放置点击链接的时候,请选用[链接](developers/brick-book/brick/presentational-bricks.brick-link)",
817
- "interface": []
1049
+ "events": [
1050
+ {
1051
+ "type": "general.button.click",
1052
+ "detail": "`Record<string, any>`",
1053
+ "description": "按钮被点击时触发, detail 为 dataSource 数据"
1054
+ }
1055
+ ],
1056
+ "properties": [
1057
+ {
1058
+ "name": "buttonName",
1059
+ "type": "string",
1060
+ "required": "false",
1061
+ "default": "-",
1062
+ "description": "按钮名称",
1063
+ "group": "basic"
1064
+ },
1065
+ {
1066
+ "name": "buttonIcon",
1067
+ "type": "MenuIcon",
1068
+ "required": "false",
1069
+ "default": "-",
1070
+ "description": "按钮 icon,支持的 [icon 图标库](developers/icon) 和 [MenuIcon配置](/next-docs/docs/api-reference/brick-types.menuicon#menuicon-interface),另外如果是 antd 图标库可以直接引用图标名称配置 { \"lib\": \"antd\", \"icon\": \"edit\" }与 \"edit\"等价",
1071
+ "group": "ui"
1072
+ },
1073
+ {
1074
+ "name": "buttonUrl",
1075
+ "type": "string",
1076
+ "required": "false",
1077
+ "default": "-",
1078
+ "description": "点击按钮跳转的 url",
1079
+ "group": "basic"
1080
+ },
1081
+ {
1082
+ "name": "buttonHref",
1083
+ "type": "string",
1084
+ "required": "false",
1085
+ "default": "-",
1086
+ "description": "是否使用原生 <a> 标签,通常用于外链的跳转",
1087
+ "group": "basic"
1088
+ },
1089
+ {
1090
+ "name": "target",
1091
+ "type": "string",
1092
+ "required": "false",
1093
+ "default": "-",
1094
+ "description": "跳转的 target,例如可以设置为\"_blank\"",
1095
+ "group": "basic"
1096
+ },
1097
+ {
1098
+ "name": "dataSource",
1099
+ "type": "Record<string, any>",
1100
+ "required": "false",
1101
+ "default": "{}",
1102
+ "description": "替代之前 detail 属性,用法相同。暂存的数据在事件传出时使用",
1103
+ "group": "basic"
1104
+ },
1105
+ {
1106
+ "name": "disabled",
1107
+ "type": "boolean",
1108
+ "required": "false",
1109
+ "default": "false",
1110
+ "description": "是否禁用按钮",
1111
+ "group": "basic"
1112
+ },
1113
+ {
1114
+ "name": "loading",
1115
+ "type": "boolean",
1116
+ "required": "false",
1117
+ "default": "false",
1118
+ "description": "按钮加载动画",
1119
+ "group": "ui"
1120
+ },
1121
+ {
1122
+ "name": "buttonType",
1123
+ "type": "ButtonType",
1124
+ "required": "false",
1125
+ "default": "-",
1126
+ "description": "按钮类型 ButtonType(`\"link\" | \"default\" | \"primary\" | \"ghost\" | \"dashed\" | \"danger\" | \"icon\"|\"text\"`)",
1127
+ "group": "ui"
1128
+ },
1129
+ {
1130
+ "name": "buttonDanger",
1131
+ "type": "boolean",
1132
+ "required": "false",
1133
+ "default": "false",
1134
+ "description": "设置危险按钮",
1135
+ "group": "ui"
1136
+ },
1137
+ {
1138
+ "name": "buttonShape",
1139
+ "type": "\"circle\" | \"round\"",
1140
+ "required": "false",
1141
+ "default": "-",
1142
+ "description": "按钮形状,支持圆形、椭圆形,不设置为默认方形",
1143
+ "group": "ui"
1144
+ },
1145
+ {
1146
+ "name": "buttonSize",
1147
+ "type": "small | large",
1148
+ "required": "false",
1149
+ "default": "-",
1150
+ "description": "按钮大小,支持大、小,不设置为默认中",
1151
+ "group": "ui"
1152
+ },
1153
+ {
1154
+ "name": "tooltip",
1155
+ "type": "string",
1156
+ "required": "false",
1157
+ "default": "-",
1158
+ "description": "按钮的 tooltip",
1159
+ "group": "basic"
1160
+ },
1161
+ {
1162
+ "name": "disabledTooltip",
1163
+ "type": "string",
1164
+ "required": "false",
1165
+ "default": "-",
1166
+ "description": "禁用按钮的 tooltip",
1167
+ "group": "basic"
1168
+ },
1169
+ {
1170
+ "name": "tooltipConfig",
1171
+ "type": "TooltipConfig",
1172
+ "required": "false",
1173
+ "default": "-",
1174
+ "description": "tooltip的配置,配置属性见TooltipConfig",
1175
+ "group": "basic"
1176
+ },
1177
+ {
1178
+ "name": "fadedText",
1179
+ "type": "boolean",
1180
+ "required": "false",
1181
+ "default": "false",
1182
+ "description": "淡化按钮文字,按钮类型为 text 时可以设置。默认 `false` 文字按钮颜色和平台的字体颜色一样,在一些希望弱化文字颜色的场景下可以设置为 `true`。",
1183
+ "group": "ui"
1184
+ },
1185
+ {
1186
+ "name": "disableAfterClick",
1187
+ "type": "boolean",
1188
+ "required": "false",
1189
+ "default": "false",
1190
+ "description": "点击按钮后自动禁用",
1191
+ "group": "basic"
1192
+ },
1193
+ {
1194
+ "name": "buttonProps",
1195
+ "type": "ButtonProps",
1196
+ "required": "-",
1197
+ "default": "-",
1198
+ "description": "完全透传给 antd 的 Button 属性",
1199
+ "group": "basic"
1200
+ },
1201
+ {
1202
+ "name": "buttonStyle",
1203
+ "type": "React.CSSProperties",
1204
+ "required": "-",
1205
+ "default": "-",
1206
+ "description": "适用于按钮某些场景下,需要自定义一些样式",
1207
+ "group": "ui"
1208
+ },
1209
+ {
1210
+ "name": "detail",
1211
+ "type": "any",
1212
+ "required": "false",
1213
+ "default": "{}",
1214
+ "deprecated": true,
1215
+ "description": "[已废弃]按钮点击事件传出的内容。当用于列表类构件,例如 `brick-table` 中,可通过传入传入 `detail` 来识别不通的行进行操作处理。",
1216
+ "group": "basic"
1217
+ }
1218
+ ],
1219
+ "interface": [
1220
+ {
1221
+ "name": "TooltipConfig",
1222
+ "typeParameter": null,
1223
+ "kind": "interface",
1224
+ "children": [
1225
+ {
1226
+ "name": "arrowPointAtCenter",
1227
+ "type": "boolean",
1228
+ "required": false,
1229
+ "description": "箭头是否指向目标元素中心"
1230
+ },
1231
+ {
1232
+ "name": "placement",
1233
+ "type": "TooltipPlacement",
1234
+ "required": false,
1235
+ "description": "气泡框位置,可选 `top` `left` `right` `bottom` `topLeft` `topRight` `bottomLeft` `bottomRight` `leftTop` `leftBottom` `rightTop` `rightBottom`"
1236
+ }
1237
+ ],
1238
+ "indexSignature": []
1239
+ },
1240
+ {
1241
+ "name": "TooltipPlacement",
1242
+ "typeParameter": null,
1243
+ "kind": "type",
1244
+ "description": "",
1245
+ "type": "\"top\" | \"left\" | \"right\" | \"bottom\" | \"topLeft\" | \"topRight\" | \"bottomLeft\" | \"bottomRight\" | \"leftTop\" | \"leftBottom\" | \"rightTop\" | \"rightBottom\""
1246
+ }
1247
+ ]
818
1248
  }
819
1249
  },
820
1250
  {
@@ -1268,7 +1698,114 @@
1268
1698
  "change": "新增属性 `fillVertical`"
1269
1699
  }
1270
1700
  ],
1271
- "interface": []
1701
+ "properties": [
1702
+ {
1703
+ "name": "cardTitle",
1704
+ "type": "string",
1705
+ "required": "false",
1706
+ "default": "-",
1707
+ "description": "卡片标题",
1708
+ "group": "basic"
1709
+ },
1710
+ {
1711
+ "name": "fillVertical",
1712
+ "type": "boolean",
1713
+ "required": "false",
1714
+ "default": "false",
1715
+ "description": "设置该属性后,设置卡片高度为 100%,卡片高度会自动撑满父容器",
1716
+ "group": "ui"
1717
+ },
1718
+ {
1719
+ "name": "verticalCenter",
1720
+ "type": "boolean",
1721
+ "required": "false",
1722
+ "default": "false",
1723
+ "description": "设置该属性后,卡片内容区的元素自动垂直居中",
1724
+ "group": "ui"
1725
+ },
1726
+ {
1727
+ "name": "hasExtraSlot",
1728
+ "type": "boolean",
1729
+ "required": "false",
1730
+ "default": "false",
1731
+ "description": "是否右上角有操作区 slot",
1732
+ "group": "basic"
1733
+ },
1734
+ {
1735
+ "name": "hasFooter",
1736
+ "type": "boolean",
1737
+ "required": true,
1738
+ "group": "basic"
1739
+ },
1740
+ {
1741
+ "name": "isFixedFooter",
1742
+ "type": "boolean",
1743
+ "required": "false",
1744
+ "default": "true",
1745
+ "description": "footer滚动到窗口外时,是否需要将footer固定在窗口底部",
1746
+ "group": "basic"
1747
+ },
1748
+ {
1749
+ "name": "operationButtons",
1750
+ "type": "OperationButton[]",
1751
+ "required": "false",
1752
+ "default": "-",
1753
+ "description": "右上角的操作按钮列表,可自定义指定该按钮的名字,按钮点击后发出的事件等"
1754
+ },
1755
+ {
1756
+ "name": "configProps",
1757
+ "type": "map",
1758
+ "required": "false",
1759
+ "default": "-",
1760
+ "description": "完全透传给 antd 的 Card 属性,详见:[Card](https://ant.design/components/card-cn/#Card)"
1761
+ }
1762
+ ],
1763
+ "interface": [
1764
+ {
1765
+ "name": "OperationButton",
1766
+ "typeParameter": null,
1767
+ "kind": "interface",
1768
+ "children": [
1769
+ {
1770
+ "name": "configProps",
1771
+ "type": "ButtonProps & { icon?: string }",
1772
+ "required": true,
1773
+ "description": ""
1774
+ },
1775
+ {
1776
+ "name": "eventName",
1777
+ "type": "string",
1778
+ "required": true,
1779
+ "description": ""
1780
+ },
1781
+ {
1782
+ "name": "id",
1783
+ "type": "string",
1784
+ "required": true,
1785
+ "description": ""
1786
+ },
1787
+ {
1788
+ "name": "needData",
1789
+ "type": "boolean",
1790
+ "required": false,
1791
+ "description": ""
1792
+ },
1793
+ {
1794
+ "name": "text",
1795
+ "type": "string",
1796
+ "required": false,
1797
+ "description": ""
1798
+ },
1799
+ {
1800
+ "name": "tooltip",
1801
+ "type": "string",
1802
+ "required": false,
1803
+ "description": ""
1804
+ }
1805
+ ],
1806
+ "indexSignature": []
1807
+ }
1808
+ ]
1272
1809
  }
1273
1810
  },
1274
1811
  {
@@ -2241,7 +2778,255 @@
2241
2778
  }
2242
2779
  ],
2243
2780
  "memo": "",
2244
- "interface": []
2781
+ "properties": [
2782
+ {
2783
+ "name": "customButtons",
2784
+ "type": "CustomButton[]",
2785
+ "required": true,
2786
+ "description": "自定义按钮组",
2787
+ "group": "basic"
2788
+ },
2789
+ {
2790
+ "name": "alignment",
2791
+ "type": "\"start\" | \"center\" | \"end\" | \"stretch\"",
2792
+ "required": false,
2793
+ "default": "\"center\"",
2794
+ "description": "对齐方式",
2795
+ "group": "basic"
2796
+ },
2797
+ {
2798
+ "name": "dataSource",
2799
+ "type": "any",
2800
+ "required": false,
2801
+ "description": "按钮事件的 detail",
2802
+ "group": "basic"
2803
+ },
2804
+ {
2805
+ "name": "disableAfterClick",
2806
+ "type": "boolean",
2807
+ "required": false,
2808
+ "description": "点击按钮后自动禁用",
2809
+ "group": "basic"
2810
+ },
2811
+ {
2812
+ "name": "isMoreButton",
2813
+ "type": "boolean",
2814
+ "required": false,
2815
+ "default": "false",
2816
+ "description": "按钮组中 isDropdown 为 true 的按钮收纳成 dropdown。isMoreButton 为 true 时更多按钮显示纯icon样式,为 false 时显示icon+文字样式。",
2817
+ "group": "moreButton"
2818
+ },
2819
+ {
2820
+ "name": "moreBtnIcon",
2821
+ "type": "MenuIcon | string",
2822
+ "required": false,
2823
+ "description": "isMoreButton 为 true 时更多按钮的图标,默认为`...`",
2824
+ "group": "moreButton"
2825
+ },
2826
+ {
2827
+ "name": "moreButtonType",
2828
+ "type": "ButtonType",
2829
+ "required": false,
2830
+ "description": "更多按钮的类型",
2831
+ "group": "moreButton"
2832
+ },
2833
+ {
2834
+ "name": "moreButtonShape",
2835
+ "type": "\"circle\" | \"no\" | \"rectangle\" | \"icon\"",
2836
+ "required": false,
2837
+ "description": "isMoreButton 为 true 时更多按钮的样式,通常使用 icon 类型",
2838
+ "group": "moreButton"
2839
+ },
2840
+ {
2841
+ "name": "dropdownBtnText",
2842
+ "type": "string",
2843
+ "required": false,
2844
+ "default": "\"管理\"",
2845
+ "description": "isMoreButton 为 false 时,按钮组中 isDropdown 为 true 的按钮收纳成 dropdown,收纳起来的按钮文字",
2846
+ "group": "dropdownButton"
2847
+ },
2848
+ {
2849
+ "name": "dropdownBtnType",
2850
+ "type": "\"default\" | \"link\"",
2851
+ "required": false,
2852
+ "default": "\"default\"",
2853
+ "description": "dropdown按钮的类型",
2854
+ "group": "dropdownButton"
2855
+ },
2856
+ {
2857
+ "name": "dropdownBtnIcon",
2858
+ "type": "MenuIcon | string",
2859
+ "required": false,
2860
+ "default": "\"setting\"",
2861
+ "description": "isMoreButton 为 false 时,按钮组中 isDropdown 为 true 的按钮收纳成 dropdown,收纳起来的按钮 icon,支持[icon 图标库](/next/developers/icon),可直接复制图标图标的配置(antd、fa 及 easyops 三种库都支持),也可只取 icon 字段的值(仅支持 antd 库)。配置{ \"lib\": \"antd\", \"icon\": \"edit\" }与 \"edit\"等价",
2862
+ "group": "dropdownButton"
2863
+ },
2864
+ {
2865
+ "name": "dropdownPlacement",
2866
+ "type": "DropdownPlacement",
2867
+ "required": false,
2868
+ "default": "\"bottomRight\"",
2869
+ "description": "dropdown 的弹出位置",
2870
+ "group": "dropdownButton"
2871
+ }
2872
+ ],
2873
+ "events": [
2874
+ {
2875
+ "type": "buttons.visible.change",
2876
+ "detail": "\"boolean\"",
2877
+ "description": "dropdown是否显示"
2878
+ }
2879
+ ],
2880
+ "methods": [
2881
+ {
2882
+ "name": "updateButton",
2883
+ "params": "id: string, btn: Partial<CustomButton>",
2884
+ "description": "更新按钮"
2885
+ }
2886
+ ],
2887
+ "interface": [
2888
+ {
2889
+ "name": "CustomButton",
2890
+ "typeParameter": null,
2891
+ "kind": "interface",
2892
+ "children": [
2893
+ {
2894
+ "name": "buttonHref",
2895
+ "type": "string",
2896
+ "required": false,
2897
+ "description": "点击跳转的地址,一般站外链接使用此属性"
2898
+ },
2899
+ {
2900
+ "name": "buttonShape",
2901
+ "type": "ButtonShape",
2902
+ "required": false,
2903
+ "description": "形状类型"
2904
+ },
2905
+ {
2906
+ "name": "buttonSize",
2907
+ "type": "ButtonSize",
2908
+ "required": false,
2909
+ "description": "按钮大小"
2910
+ },
2911
+ {
2912
+ "name": "buttonType",
2913
+ "type": "ButtonType | \"icon\"",
2914
+ "required": false,
2915
+ "description": "样式类型"
2916
+ },
2917
+ {
2918
+ "name": "buttonUrl",
2919
+ "type": "string",
2920
+ "required": false,
2921
+ "description": "点击跳转的地址,一般站内链接使用此属性"
2922
+ },
2923
+ {
2924
+ "name": "color",
2925
+ "type": "string",
2926
+ "required": false,
2927
+ "description": "按钮字体颜色"
2928
+ },
2929
+ {
2930
+ "name": "danger",
2931
+ "type": "boolean",
2932
+ "required": false,
2933
+ "description": "是否显示为危险样式"
2934
+ },
2935
+ {
2936
+ "name": "disabled",
2937
+ "type": "boolean",
2938
+ "required": false,
2939
+ "description": "是否禁用"
2940
+ },
2941
+ {
2942
+ "name": "disabledTooltip",
2943
+ "type": "string",
2944
+ "required": false,
2945
+ "description": "禁用按钮的 tooltip"
2946
+ },
2947
+ {
2948
+ "name": "eventName",
2949
+ "type": "string",
2950
+ "required": true,
2951
+ "description": "按钮点击事件名"
2952
+ },
2953
+ {
2954
+ "name": "hide",
2955
+ "type": "boolean",
2956
+ "required": false,
2957
+ "description": "是否隐藏"
2958
+ },
2959
+ {
2960
+ "name": "icon",
2961
+ "type": "MenuIcon | string",
2962
+ "required": false,
2963
+ "description": "按钮 icon,支持[icon图标库](/next/developers/icon),可直接复制图标图标的配置(antd、fa 及 easyops 三种库都支持),也可只取 icon 字段的值(仅支持 antd 库)。配置{ \"lib\": \"antd\", \"icon\": \"edit\" }与 \"edit\"等价"
2964
+ },
2965
+ {
2966
+ "name": "id",
2967
+ "type": "string",
2968
+ "required": false,
2969
+ "description": "按钮 ID, updateButton 时使用"
2970
+ },
2971
+ {
2972
+ "name": "isDivider",
2973
+ "type": "boolean",
2974
+ "required": false,
2975
+ "description": "菜单项分割线,只用在弹出菜单内"
2976
+ },
2977
+ {
2978
+ "name": "isDropdown",
2979
+ "type": "boolean",
2980
+ "required": false,
2981
+ "description": "是否收纳成下拉框"
2982
+ },
2983
+ {
2984
+ "name": "loading",
2985
+ "type": "boolean",
2986
+ "required": false,
2987
+ "description": "设置按钮载入状态"
2988
+ },
2989
+ {
2990
+ "name": "testId",
2991
+ "type": "string",
2992
+ "required": false,
2993
+ "description": "用于测试时定位的 ID"
2994
+ },
2995
+ {
2996
+ "name": "text",
2997
+ "type": "string",
2998
+ "required": true,
2999
+ "description": "按钮名"
3000
+ },
3001
+ {
3002
+ "name": "tooltip",
3003
+ "type": "string",
3004
+ "required": false,
3005
+ "description": "按钮简单的文字提示气泡框"
3006
+ },
3007
+ {
3008
+ "name": "tooltipPlacement",
3009
+ "type": "TooltipPlacement",
3010
+ "required": false,
3011
+ "description": "tooltip 位置"
3012
+ },
3013
+ {
3014
+ "name": "urlTarget",
3015
+ "type": "string",
3016
+ "required": false,
3017
+ "description": "相当于 a 链接的 target 属性,buttonUrl 或 buttonHref 存在时生效"
3018
+ }
3019
+ ],
3020
+ "indexSignature": []
3021
+ },
3022
+ {
3023
+ "name": "DropdownPlacement",
3024
+ "typeParameter": null,
3025
+ "kind": "type",
3026
+ "description": "",
3027
+ "type": "\"bottomRight\" | \"topLeft\" | \"topCenter\" | \"topRight\" | \"bottomLeft\" | \"bottomCenter\""
3028
+ }
3029
+ ]
2245
3030
  }
2246
3031
  },
2247
3032
  {
@@ -2560,7 +3345,157 @@
2560
3345
  }
2561
3346
  ],
2562
3347
  "memo": "### OpenCloseOption\n\n| property | type | required | default | description |\n| -------- | --------- | -------- | ------- | ----------- |\n| noEvent | `boolean` | - | - | 不触发事件 |",
2563
- "interface": []
3348
+ "properties": [
3349
+ {
3350
+ "name": "customTitle",
3351
+ "type": "string",
3352
+ "required": "false",
3353
+ "default": "-",
3354
+ "description": "标题",
3355
+ "group": "basic"
3356
+ },
3357
+ {
3358
+ "name": "loading",
3359
+ "type": "boolean",
3360
+ "required": "false",
3361
+ "default": "-",
3362
+ "description": "是否显示loading效果",
3363
+ "group": "basic"
3364
+ },
3365
+ {
3366
+ "name": "closable",
3367
+ "type": "boolean",
3368
+ "required": "false",
3369
+ "default": "-",
3370
+ "description": "是否显示右上角的关闭按钮",
3371
+ "group": "basic"
3372
+ },
3373
+ {
3374
+ "name": "maskClosable",
3375
+ "type": "boolean",
3376
+ "required": "false",
3377
+ "default": "-",
3378
+ "description": "点击蒙层是否允许关闭",
3379
+ "group": "basic"
3380
+ },
3381
+ {
3382
+ "name": "hasFooter",
3383
+ "type": "boolean",
3384
+ "required": "false",
3385
+ "default": "false",
3386
+ "description": "是否提供 `footer` 插槽",
3387
+ "group": "basic"
3388
+ },
3389
+ {
3390
+ "name": "mask",
3391
+ "type": "boolean",
3392
+ "required": "false",
3393
+ "default": "true",
3394
+ "description": "是否展示遮罩",
3395
+ "group": "ui"
3396
+ },
3397
+ {
3398
+ "name": "width",
3399
+ "type": "number",
3400
+ "required": "false",
3401
+ "default": "-",
3402
+ "description": "宽度",
3403
+ "group": "ui"
3404
+ },
3405
+ {
3406
+ "name": "bodyStyle",
3407
+ "type": "Record<string, any>",
3408
+ "required": "false",
3409
+ "default": "-",
3410
+ "description": "可用于设置 Drawer 内容部分的样式",
3411
+ "group": "ui"
3412
+ },
3413
+ {
3414
+ "name": "drawerStyle",
3415
+ "type": "Record<string, any>",
3416
+ "required": "false",
3417
+ "default": "-",
3418
+ "description": "用于设置 Drawer 弹出层的样式",
3419
+ "group": "ui"
3420
+ },
3421
+ {
3422
+ "name": "headerStyle",
3423
+ "type": "Record<string, any>",
3424
+ "required": "false",
3425
+ "default": "-",
3426
+ "description": "用于设置 Drawer 头部的样式",
3427
+ "group": "ui"
3428
+ },
3429
+ {
3430
+ "name": "isFloat",
3431
+ "type": "boolean",
3432
+ "required": "false",
3433
+ "default": "false",
3434
+ "description": "是否浮层样式,如果设为true,则抽屉边缘会有外边距,圆角和阴影",
3435
+ "group": "ui"
3436
+ },
3437
+ {
3438
+ "name": "configProps",
3439
+ "type": "object",
3440
+ "required": "false",
3441
+ "default": "-",
3442
+ "description": "完全透传给 antd 的 Drawer 属性,详见:[https://ant.design/components/drawer-cn/#API](https://ant.design/components/drawer-cn/#API)",
3443
+ "group": "other"
3444
+ },
3445
+ {
3446
+ "name": "scrollToTopWhenOpen",
3447
+ "type": "boolean",
3448
+ "required": "false",
3449
+ "default": "-",
3450
+ "description": "打开抽屉时内容区是否自动滚动到顶部",
3451
+ "group": "other"
3452
+ }
3453
+ ],
3454
+ "events": [
3455
+ {
3456
+ "type": "general.drawer.close",
3457
+ "detail": "",
3458
+ "description": "构件关闭时所发出的事件, 事件数据为空"
3459
+ },
3460
+ {
3461
+ "type": "general.drawer.open",
3462
+ "detail": "",
3463
+ "description": "构件打开时所发出的事件, 事件数据为空"
3464
+ }
3465
+ ],
3466
+ "methods": [
3467
+ {
3468
+ "name": "bodyScroll",
3469
+ "params": "top: number",
3470
+ "description": "抽屉内部内容上下滚动"
3471
+ },
3472
+ {
3473
+ "name": "close",
3474
+ "params": "option?: OpenCloseOption",
3475
+ "description": "显示抽屉构件"
3476
+ },
3477
+ {
3478
+ "name": "open",
3479
+ "params": "option?: OpenCloseOption",
3480
+ "description": "显示抽屉构件"
3481
+ }
3482
+ ],
3483
+ "interface": [
3484
+ {
3485
+ "name": "OpenCloseOption",
3486
+ "typeParameter": null,
3487
+ "kind": "interface",
3488
+ "children": [
3489
+ {
3490
+ "name": "noEvent",
3491
+ "type": "boolean",
3492
+ "required": false,
3493
+ "description": ""
3494
+ }
3495
+ ],
3496
+ "indexSignature": []
3497
+ }
3498
+ ]
2564
3499
  }
2565
3500
  },
2566
3501
  {
@@ -2622,6 +3557,24 @@
2622
3557
  }
2623
3558
  ],
2624
3559
  "memo": "### Supported Keys\n\n HotKeys 构件可以识别以下修饰符,方便配置:`⇧`, `shift`, `option`, `⌥`, `alt`, `ctrl`, `control`, `command`和 `⌘`.\n\n 以下特殊键可用于配置快捷键:`backspace`, `tab`, `clear`, `enter`, `return`, `esc`, `escape`, `space`, `up`, `down`, `left`, `right`, `home`, `end`, `pageup`, `pagedown`, `del`, `delete` , `f1` 到 `f19`.\n\n 其中:\n\n - `⌘` Command()\n - `⌃` Control\n - `⌥` Option(alt)\n - `⇧` Shift\n - `⇪` Caps Lock(Capital)\n - `↩︎` return/Enter space",
3560
+ "properties": [
3561
+ {
3562
+ "name": "hotkeysConfig",
3563
+ "type": "{key: string,eventName: string}[]",
3564
+ "required": "false",
3565
+ "default": "-",
3566
+ "description": "快捷键配置,支持的 keys 列表如下",
3567
+ "group": "basic"
3568
+ },
3569
+ {
3570
+ "name": "disabled",
3571
+ "type": "boolean",
3572
+ "required": "false",
3573
+ "default": "false",
3574
+ "group": "basic",
3575
+ "description": "是否禁用"
3576
+ }
3577
+ ],
2625
3578
  "interface": []
2626
3579
  }
2627
3580
  },
@@ -2992,7 +3945,240 @@
2992
3945
  }
2993
3946
  ],
2994
3947
  "memo": "### OpenCloseOption\n\n| property | type | required | default | description |\n| -------- | --------- | -------- | ------- | ----------- |\n| noEvent | `boolean` | - | - | 不触发事件 |",
2995
- "interface": []
3948
+ "events": [
3949
+ {
3950
+ "type": "model.after.close",
3951
+ "detail": "-",
3952
+ "description": "当 modal 完全关闭后发出该事件"
3953
+ },
3954
+ {
3955
+ "type": "modal.close",
3956
+ "detail": "-",
3957
+ "description": "关闭 modal 时发出该事件"
3958
+ },
3959
+ {
3960
+ "type": "basic-bricks.general-modal.cancel",
3961
+ "detail": "`Record<string, any>`",
3962
+ "description": "当点击 modal 自带的取消按钮时发出该事件,detail来源为当前的dataSource属性值"
3963
+ },
3964
+ {
3965
+ "type": "basic-bricks.general-modal.confirm",
3966
+ "detail": "`Record<string, any>`",
3967
+ "description": "当点击 modal 自带的确认按钮时发出该事件,detail来源为当前的dataSource属性值"
3968
+ },
3969
+ {
3970
+ "type": "modal.open",
3971
+ "detail": "Record<string, any>",
3972
+ "description": "打开 modal 时发出该事件"
3973
+ }
3974
+ ],
3975
+ "properties": [
3976
+ {
3977
+ "name": "modalTitle",
3978
+ "type": "string",
3979
+ "required": "false",
3980
+ "default": "-",
3981
+ "description": "模态框标题",
3982
+ "group": "basic"
3983
+ },
3984
+ {
3985
+ "name": "titleIcon",
3986
+ "type": "MenuIcon",
3987
+ "required": "false",
3988
+ "default": "-",
3989
+ "description": "标题图标",
3990
+ "group": "basic"
3991
+ },
3992
+ {
3993
+ "name": "titleAlign",
3994
+ "type": "string",
3995
+ "required": "false",
3996
+ "default": "-",
3997
+ "description": "标题对齐方式",
3998
+ "group": "basic"
3999
+ },
4000
+ {
4001
+ "name": "dataSource",
4002
+ "type": "Record<string, any>",
4003
+ "required": "false",
4004
+ "default": "-",
4005
+ "description": "数据来源",
4006
+ "group": "basic"
4007
+ },
4008
+ {
4009
+ "name": "width",
4010
+ "type": "string | number",
4011
+ "required": "false",
4012
+ "default": "-",
4013
+ "description": "模态框宽度",
4014
+ "group": "ui"
4015
+ },
4016
+ {
4017
+ "name": "enableFooterSlot",
4018
+ "type": "boolean",
4019
+ "required": "false",
4020
+ "default": "false",
4021
+ "description": "是否启用 footer 插槽",
4022
+ "group": "ui"
4023
+ },
4024
+ {
4025
+ "name": "footerPosition",
4026
+ "type": "string",
4027
+ "required": "false",
4028
+ "default": "right",
4029
+ "description": "按钮的位置 left | center | right",
4030
+ "group": "ui"
4031
+ },
4032
+ {
4033
+ "name": "isHiddenBodyPadding",
4034
+ "type": "boolean",
4035
+ "required": "false",
4036
+ "default": "true",
4037
+ "description": "是否需要隐藏弹窗内容的padding",
4038
+ "group": "ui"
4039
+ },
4040
+ {
4041
+ "name": "isHiddenHeaderBorder",
4042
+ "type": "boolean",
4043
+ "required": "false",
4044
+ "default": "true",
4045
+ "description": "是否需要隐藏弹窗头部的分割线",
4046
+ "group": "ui"
4047
+ },
4048
+ {
4049
+ "name": "isHiddenFooterColor",
4050
+ "type": "boolean",
4051
+ "required": "false",
4052
+ "default": "true",
4053
+ "description": "是否需要隐藏底部特殊的颜色",
4054
+ "group": "ui"
4055
+ },
4056
+ {
4057
+ "name": "fullscreen",
4058
+ "type": "boolean",
4059
+ "required": false,
4060
+ "default": "false",
4061
+ "description": "全屏模式",
4062
+ "group": "ui"
4063
+ },
4064
+ {
4065
+ "name": "okText",
4066
+ "type": "string",
4067
+ "required": "false",
4068
+ "default": "确认",
4069
+ "description": "确认按钮文字",
4070
+ "group": "buttonAndInteract"
4071
+ },
4072
+ {
4073
+ "name": "okType",
4074
+ "type": "ButtonType",
4075
+ "required": "false",
4076
+ "default": "primary",
4077
+ "description": "模态框确认按钮类型 ButtonType(\"link\" | \"default\" | \"primary\" | \"ghost\" | \"dashed\" | \"danger\")",
4078
+ "group": "buttonAndInteract"
4079
+ },
4080
+ {
4081
+ "name": "okDisabled",
4082
+ "type": "boolean",
4083
+ "required": "false",
4084
+ "default": "false",
4085
+ "description": "是否禁用确认按钮",
4086
+ "group": "buttonAndInteract"
4087
+ },
4088
+ {
4089
+ "name": "closeWhenOk",
4090
+ "type": "boolean",
4091
+ "required": "false",
4092
+ "default": "true",
4093
+ "description": "点击确定时,是否立即关闭模态框,如果设为`false`,则需要自行关闭。",
4094
+ "group": "basic"
4095
+ },
4096
+ {
4097
+ "name": "confirmLoading",
4098
+ "type": "boolean",
4099
+ "required": "false",
4100
+ "default": "false",
4101
+ "description": "确定按钮 loading",
4102
+ "group": "buttonAndInteract"
4103
+ },
4104
+ {
4105
+ "name": "cancelText",
4106
+ "type": "string",
4107
+ "required": "false",
4108
+ "default": "取消",
4109
+ "description": "取消按钮文字",
4110
+ "group": "buttonAndInteract"
4111
+ },
4112
+ {
4113
+ "name": "hideCancelButton",
4114
+ "type": "boolean",
4115
+ "required": "false",
4116
+ "default": "false",
4117
+ "description": "是否隐藏取消按钮",
4118
+ "group": "buttonAndInteract"
4119
+ },
4120
+ {
4121
+ "name": "closeWhenCancel",
4122
+ "type": "boolean",
4123
+ "required": "false",
4124
+ "default": "true",
4125
+ "description": "点击取消时,是否立即关闭模态框,如果设为`false`,则需要自行关闭。",
4126
+ "group": "buttonAndInteract"
4127
+ },
4128
+ {
4129
+ "name": "maskClosable",
4130
+ "type": "boolean",
4131
+ "required": "false",
4132
+ "default": "true",
4133
+ "description": "是否点击背景关闭模态框",
4134
+ "group": "buttonAndInteract"
4135
+ },
4136
+ {
4137
+ "name": "configProps",
4138
+ "type": "object",
4139
+ "required": "false",
4140
+ "default": "-",
4141
+ "description": "完全透传给 antd 的 Modal 属性,详见 [文档](https://ant.design/components/modal-cn#API)",
4142
+ "group": "other"
4143
+ },
4144
+ {
4145
+ "name": "fields",
4146
+ "type": "{modalTitle: string}",
4147
+ "required": "false",
4148
+ "default": "-",
4149
+ "deprecated": true,
4150
+ "description": "`已废弃` 字段映射, 跟 dataSource 一起使用来获得运行时 modalTitle",
4151
+ "group": "other"
4152
+ }
4153
+ ],
4154
+ "methods": [
4155
+ {
4156
+ "name": "close",
4157
+ "params": "`option?: OpenCloseOption`",
4158
+ "description": "关闭模态框"
4159
+ },
4160
+ {
4161
+ "name": "open",
4162
+ "params": "option?: OpenCloseOption",
4163
+ "description": "弹出模态框"
4164
+ }
4165
+ ],
4166
+ "interface": [
4167
+ {
4168
+ "name": "OpenCloseOption",
4169
+ "typeParameter": null,
4170
+ "kind": "interface",
4171
+ "children": [
4172
+ {
4173
+ "name": "noEvent",
4174
+ "type": "boolean",
4175
+ "required": false,
4176
+ "description": ""
4177
+ }
4178
+ ],
4179
+ "indexSignature": []
4180
+ }
4181
+ ]
2996
4182
  }
2997
4183
  },
2998
4184
  {
@@ -3075,6 +4261,75 @@
3075
4261
  }
3076
4262
  ],
3077
4263
  "memo": "",
4264
+ "events": [
4265
+ {
4266
+ "type": "general.notification.click",
4267
+ "detail": "-",
4268
+ "description": "点击通知时触发的回调函数"
4269
+ },
4270
+ {
4271
+ "type": "general.notification.close",
4272
+ "detail": "-",
4273
+ "description": "点击默认关闭按钮时触发的回调函数"
4274
+ }
4275
+ ],
4276
+ "properties": [
4277
+ {
4278
+ "name": "message",
4279
+ "type": "string",
4280
+ "required": "true",
4281
+ "default": "-",
4282
+ "description": "通知提醒标题,必选",
4283
+ "group": "basic"
4284
+ },
4285
+ {
4286
+ "name": "description",
4287
+ "type": "string",
4288
+ "required": "true",
4289
+ "default": "-",
4290
+ "description": "通知提醒内容,必选",
4291
+ "group": "basic"
4292
+ },
4293
+ {
4294
+ "name": "icon",
4295
+ "type": "string",
4296
+ "required": "false",
4297
+ "default": "-",
4298
+ "description": "icon,具体查阅:[react icon](https://3x.ant.design/components/icon-cn/)",
4299
+ "group": "basic"
4300
+ },
4301
+ {
4302
+ "name": "placement",
4303
+ "type": "`topLeft` `topRight` `bottomLeft` `bottomRight`",
4304
+ "required": "false",
4305
+ "default": "topRight",
4306
+ "description": "弹出位置,可选",
4307
+ "group": "ui"
4308
+ },
4309
+ {
4310
+ "name": "duration",
4311
+ "type": "number",
4312
+ "required": "false",
4313
+ "default": "4.5",
4314
+ "description": "默认 4.5 秒后自动关闭,配置为 null 则不自动关闭",
4315
+ "group": "basic"
4316
+ },
4317
+ {
4318
+ "name": "iconStyle",
4319
+ "type": "CSSProperties",
4320
+ "required": "false",
4321
+ "default": "-",
4322
+ "description": "icon css 样式",
4323
+ "group": "ui"
4324
+ }
4325
+ ],
4326
+ "methods": [
4327
+ {
4328
+ "name": "open",
4329
+ "params": "`success` | `error` | `info` | `warning` | `warn` | `open`",
4330
+ "description": "显示通知栏,默认为`open`"
4331
+ }
4332
+ ],
3078
4333
  "interface": []
3079
4334
  }
3080
4335
  },
@@ -3134,6 +4389,42 @@
3134
4389
  }
3135
4390
  ],
3136
4391
  "memo": "",
4392
+ "properties": [
4393
+ {
4394
+ "name": "eventName",
4395
+ "type": "string",
4396
+ "required": "false",
4397
+ "default": "general-timer.timing-event",
4398
+ "description": "定时抛出的事件",
4399
+ "group": "basic"
4400
+ },
4401
+ {
4402
+ "name": "interval",
4403
+ "type": "number",
4404
+ "required": "false",
4405
+ "default": "60000",
4406
+ "description": "定时间隔(单位:ms)",
4407
+ "group": "basic"
4408
+ },
4409
+ {
4410
+ "name": "dataSource",
4411
+ "type": "any",
4412
+ "required": "false",
4413
+ "default": "-",
4414
+ "description": "抛出事件的数据",
4415
+ "group": "basic"
4416
+ }
4417
+ ],
4418
+ "methods": [
4419
+ {
4420
+ "name": "reStartTimer",
4421
+ "description": "重启timer"
4422
+ },
4423
+ {
4424
+ "name": "stopTimer",
4425
+ "description": "停止timer"
4426
+ }
4427
+ ],
3137
4428
  "interface": []
3138
4429
  }
3139
4430
  },
@@ -3249,7 +4540,122 @@
3249
4540
  "slots": null,
3250
4541
  "history": null,
3251
4542
  "memo": "### 响应式布局说明\n\nBootstrap 等 UI 框架是移动优先的设计,它们的响应式为默认匹配小屏幕,并由小到大适配。而 EasyOps 平台以 PC 优先,并由大到小适配。这里我们针对常见桌面显示器大小,分为以下五档(屏幕宽度):\n\n- `xSmall`:<= 1024px (老式投影仪)\n- `small`:<= 1280px (13 寸笔记本)\n- `medium`:<= 1600px (中等显示器)\n- `large`:<= 1920px (大号显示器)\n- 其它:超大显示器\n\n例如以下设置:\n\n```json\n{\n \"columns\": 3,\n \"responsive\": {\n \"medium\": {\n \"columns\": 2\n },\n \"small\": {\n \"columns\": 1\n }\n }\n}\n```\n\n在 `> 1600px` 的屏幕上时将显示为三列,`<= 1600px && > 1280px` 时显示两列,更小的屏幕显示为一列。",
3252
- "interface": []
4543
+ "properties": [
4544
+ {
4545
+ "name": "columns",
4546
+ "type": "number",
4547
+ "required": false,
4548
+ "default": "-",
4549
+ "description": "网格布局列数(各列等宽)"
4550
+ },
4551
+ {
4552
+ "name": "columnSpan",
4553
+ "type": "number",
4554
+ "required": false,
4555
+ "default": "auto",
4556
+ "description": "自己在父级网格中所占列数"
4557
+ },
4558
+ {
4559
+ "name": "rows",
4560
+ "type": "number",
4561
+ "required": false,
4562
+ "default": "1",
4563
+ "description": "网格布局行数,通常不需设置,各行高度由内容决定。设置为 > 1 时,各行高度相同。"
4564
+ },
4565
+ {
4566
+ "name": "rowSpan",
4567
+ "type": "number",
4568
+ "required": false,
4569
+ "default": "1",
4570
+ "description": "自己在父级网格中所占行数"
4571
+ },
4572
+ {
4573
+ "name": "templateColumns",
4574
+ "type": "string",
4575
+ "required": false,
4576
+ "default": "-",
4577
+ "description": "网格布局模板列,即 CSS 的 gridTemplateColumns,优先于 `columns`。"
4578
+ },
4579
+ {
4580
+ "name": "responsive",
4581
+ "type": "ResponsiveSettings",
4582
+ "required": false,
4583
+ "default": "1",
4584
+ "description": "响应式布局设置"
4585
+ }
4586
+ ],
4587
+ "interface": [
4588
+ {
4589
+ "name": "ResponsiveSettings",
4590
+ "typeParameter": null,
4591
+ "kind": "interface",
4592
+ "children": [
4593
+ {
4594
+ "name": "large",
4595
+ "type": "GridSettings",
4596
+ "required": false,
4597
+ "description": ""
4598
+ },
4599
+ {
4600
+ "name": "medium",
4601
+ "type": "GridSettings",
4602
+ "required": false,
4603
+ "description": ""
4604
+ },
4605
+ {
4606
+ "name": "small",
4607
+ "type": "GridSettings",
4608
+ "required": false,
4609
+ "description": ""
4610
+ },
4611
+ {
4612
+ "name": "xSmall",
4613
+ "type": "GridSettings",
4614
+ "required": false,
4615
+ "description": ""
4616
+ }
4617
+ ],
4618
+ "indexSignature": []
4619
+ },
4620
+ {
4621
+ "name": "GridSettings",
4622
+ "typeParameter": null,
4623
+ "kind": "interface",
4624
+ "children": [
4625
+ {
4626
+ "name": "columnSpan",
4627
+ "type": "number",
4628
+ "required": false,
4629
+ "description": ""
4630
+ },
4631
+ {
4632
+ "name": "columns",
4633
+ "type": "number",
4634
+ "required": false,
4635
+ "description": ""
4636
+ },
4637
+ {
4638
+ "name": "rowSpan",
4639
+ "type": "number",
4640
+ "required": false,
4641
+ "description": ""
4642
+ },
4643
+ {
4644
+ "name": "rows",
4645
+ "type": "number",
4646
+ "required": false,
4647
+ "description": ""
4648
+ },
4649
+ {
4650
+ "name": "templateColumns",
4651
+ "type": "string",
4652
+ "required": false,
4653
+ "description": ""
4654
+ }
4655
+ ],
4656
+ "indexSignature": []
4657
+ }
4658
+ ]
3253
4659
  }
3254
4660
  },
3255
4661
  {
@@ -3280,6 +4686,15 @@
3280
4686
  "slots": null,
3281
4687
  "history": null,
3282
4688
  "memo": "### DEMO\n\n ```json\n {\n \"brick\": \"basic-bricks.home-redirect\",\n \"properties\": {\n \"appId\": \"search\" // 目标应用Id\n }\n }\n ```",
4689
+ "properties": [
4690
+ {
4691
+ "name": "appId",
4692
+ "type": "string",
4693
+ "required": "true",
4694
+ "default": "-",
4695
+ "description": "指定的应用 Id"
4696
+ }
4697
+ ],
3283
4698
  "interface": []
3284
4699
  }
3285
4700
  },
@@ -3361,6 +4776,22 @@
3361
4776
  "slots": null,
3362
4777
  "history": null,
3363
4778
  "memo": "",
4779
+ "properties": [
4780
+ {
4781
+ "name": "contentGridGap",
4782
+ "type": "number",
4783
+ "required": "false",
4784
+ "default": "24",
4785
+ "description": "内容区的 gap,内容区固定为 grid 布局"
4786
+ },
4787
+ {
4788
+ "name": "title",
4789
+ "type": "string",
4790
+ "required": "false",
4791
+ "default": "-",
4792
+ "description": "卡片标题"
4793
+ }
4794
+ ],
3364
4795
  "interface": []
3365
4796
  }
3366
4797
  },
@@ -3436,6 +4867,55 @@
3436
4867
  }
3437
4868
  ],
3438
4869
  "memo": "",
4870
+ "properties": [
4871
+ {
4872
+ "name": "useBrick",
4873
+ "type": "UseBrickConf",
4874
+ "required": "true",
4875
+ "default": "[]",
4876
+ "description": "使用的子构件配置,具体查阅[UseBrickConf](/next-docs/docs/micro-app/brick-use-brick)",
4877
+ "group": "basic"
4878
+ },
4879
+ {
4880
+ "name": "data",
4881
+ "type": "`any[]`",
4882
+ "required": "true",
4883
+ "default": "[]",
4884
+ "description": "数据列表",
4885
+ "group": "basic"
4886
+ },
4887
+ {
4888
+ "name": "itemKey",
4889
+ "type": "string",
4890
+ "required": false,
4891
+ "description": "数据项的 key,不设置默认使用 index",
4892
+ "group": "basic"
4893
+ },
4894
+ {
4895
+ "name": "gap",
4896
+ "type": "string | number",
4897
+ "required": false,
4898
+ "default": "\"var(--card-content-gap)\"",
4899
+ "description": "间距(配合extraContainerStyle使用)",
4900
+ "group": "ui"
4901
+ },
4902
+ {
4903
+ "name": "extraContainerStyle",
4904
+ "type": "Record<string, any>",
4905
+ "required": false,
4906
+ "default": "-",
4907
+ "description": "容器本身默认是 grid 布局,可以设置额外的样式。",
4908
+ "group": "ui"
4909
+ },
4910
+ {
4911
+ "name": "containerStyle",
4912
+ "type": "Record<string, any>",
4913
+ "required": false,
4914
+ "default": "-",
4915
+ "description": "自定义容器的样式,容器本身默认是 grid 布局,如果`containerStyle`不为空则覆盖掉容器本身的样式配置",
4916
+ "group": "ui"
4917
+ }
4918
+ ],
3439
4919
  "interface": []
3440
4920
  }
3441
4921
  },
@@ -3490,6 +4970,22 @@
3490
4970
  }
3491
4971
  ],
3492
4972
  "memo": "",
4973
+ "properties": [
4974
+ {
4975
+ "name": "showType",
4976
+ "type": "string",
4977
+ "required": "true",
4978
+ "default": "-",
4979
+ "description": "数据渲染类型,对[构件配置表](magic-brick)中的 selector 字段"
4980
+ },
4981
+ {
4982
+ "name": "data",
4983
+ "type": "any",
4984
+ "required": "true",
4985
+ "default": "-",
4986
+ "description": "数据源,通常情况该构件在一些容器构件中使用,数据源来自于容器构件例如 brick-table 的 rowData"
4987
+ }
4988
+ ],
3493
4989
  "interface": []
3494
4990
  }
3495
4991
  },
@@ -3563,6 +5059,29 @@
3563
5059
  "slots": null,
3564
5060
  "history": null,
3565
5061
  "memo": "> Tips: 因为绝对定位的原因,当前菜单被覆盖,右侧即为效果图,如果需要返回开发者中心,请点击浏览器返回\n```typescript\nexport interface SidebarMenu {\n title: string;\n icon?: MenuIcon;\n link?: LocationDescriptor;\n defaultCollapsed?: boolean;\n menuItems: SidebarMenuItem[];\n}\nexport declare type SidebarMenuItem = SidebarMenuSimpleItem | SidebarMenuGroup;\nexport interface SidebarMenuSimpleItem {\n text: string;\n to: LocationDescriptor;\n icon?: MenuIcon;\n type?: \"default\";\n exact?: boolean;\n activeIncludes?: string[];\n activeExcludes?: string[];\n key?: string;\n}\nexport interface SidebarMenuGroup {\n type: \"group\" | \"subMenu\";\n title: string;\n items: SidebarMenuItem[];\n key?: string;\n}\nexport declare type MenuIcon = AntdIcon | FaIcon | EasyopsIcon;\nexport interface AntdIcon {\n lib: \"antd\";\n type: string;\n theme?: ThemeType;\n}\nexport interface FaIcon {\n lib: \"fa\";\n icon: IconName;\n prefix?: IconPrefix;\n}\nexport interface EasyopsIcon {\n lib: \"easyops\";\n icon: string;\n category?: string;\n}\n```",
5062
+ "properties": [
5063
+ {
5064
+ "name": "menu",
5065
+ "type": "SidebarMenu",
5066
+ "required": "true",
5067
+ "default": "-",
5068
+ "description": "菜单项"
5069
+ },
5070
+ {
5071
+ "name": "subMenu",
5072
+ "type": "SidebarMenu",
5073
+ "required": "true",
5074
+ "default": "-",
5075
+ "description": "二级菜单项"
5076
+ },
5077
+ {
5078
+ "name": "collapsed",
5079
+ "type": "boolean",
5080
+ "required": "true",
5081
+ "default": "-",
5082
+ "description": "是否折叠"
5083
+ }
5084
+ ],
3566
5085
  "interface": []
3567
5086
  }
3568
5087
  },
@@ -3869,6 +5388,71 @@
3869
5388
  }
3870
5389
  ],
3871
5390
  "memo": "",
5391
+ "properties": [
5392
+ {
5393
+ "name": "pageTitle",
5394
+ "type": "string",
5395
+ "required": "-",
5396
+ "default": "-",
5397
+ "description": "设置标题。如果要使用复杂的标题构件,请使用插槽 `titleBar`",
5398
+ "group": "basic"
5399
+ },
5400
+ {
5401
+ "name": "bannerPageTitle",
5402
+ "type": "string",
5403
+ "required": "-",
5404
+ "default": "-",
5405
+ "description": "设置 banner 标题。如果要使用复杂的标题构件,请使用插槽 `bannerTitleBar`",
5406
+ "group": "basic"
5407
+ },
5408
+ {
5409
+ "name": "overflowXAuto",
5410
+ "type": "boolean",
5411
+ "required": "-",
5412
+ "default": "false",
5413
+ "description": "内容区是否需要设置`overflow-x: auto`",
5414
+ "group": "ui"
5415
+ },
5416
+ {
5417
+ "name": "noGap",
5418
+ "type": "boolean",
5419
+ "required": "-",
5420
+ "default": "false",
5421
+ "description": "内容区默认为 grid 布局且有默认的 gap,设为 `true` 则使之没有 gap。",
5422
+ "group": "ui"
5423
+ },
5424
+ {
5425
+ "name": "dashboardMode",
5426
+ "type": "boolean",
5427
+ "required": true,
5428
+ "default": "false",
5429
+ "description": "是否启用大屏模式。",
5430
+ "group": "ui"
5431
+ },
5432
+ {
5433
+ "name": "pageTitleScale",
5434
+ "type": "number",
5435
+ "required": false,
5436
+ "description": "标题栏大小比例,默认为 1,仅用于暗黑大屏模式。",
5437
+ "group": "ui"
5438
+ },
5439
+ {
5440
+ "name": "hideToolbar",
5441
+ "type": "boolean",
5442
+ "required": true,
5443
+ "default": "false",
5444
+ "description": "是否隐藏工具栏(常用语大屏模式)。",
5445
+ "group": "ui"
5446
+ },
5447
+ {
5448
+ "name": "bannerStyle",
5449
+ "type": "CSSProperties",
5450
+ "required": false,
5451
+ "default": "-",
5452
+ "description": "banner 的样式",
5453
+ "group": "ui"
5454
+ }
5455
+ ],
3872
5456
  "interface": []
3873
5457
  }
3874
5458
  },
@@ -4105,6 +5689,22 @@
4105
5689
  "slots": null,
4106
5690
  "history": null,
4107
5691
  "memo": "Tips: 多列布局默认每一列都会有 padding,如果其中某一列不需要则在相应的用户构件 storyboard 内配置 columns-card-no-padding 的类名属性即可,如示例二所示",
5692
+ "properties": [
5693
+ {
5694
+ "name": "gridColumns",
5695
+ "type": "`Array<string | number>`",
5696
+ "required": "false",
5697
+ "default": "-",
5698
+ "description": "配置多列布局时每一列的宽度,可以是具体的像素长度`200px`,也可以是数字`1,2...`等等,表示该列的宽度为相应的比例值,列数要与放入插槽的构件数相符"
5699
+ },
5700
+ {
5701
+ "name": "cardBorder",
5702
+ "type": "boolean",
5703
+ "required": "false",
5704
+ "default": "`true`",
5705
+ "description": "是否显示卡片边框"
5706
+ }
5707
+ ],
4108
5708
  "interface": []
4109
5709
  }
4110
5710
  },
@@ -4149,6 +5749,24 @@
4149
5749
  "slots": null,
4150
5750
  "history": null,
4151
5751
  "memo": "",
5752
+ "properties": [
5753
+ {
5754
+ "name": "pageTitle",
5755
+ "type": "string",
5756
+ "required": "true",
5757
+ "default": "-",
5758
+ "description": "页面标题",
5759
+ "group": "basic"
5760
+ },
5761
+ {
5762
+ "name": "dashboardMode",
5763
+ "type": "boolean",
5764
+ "required": false,
5765
+ "default": "false",
5766
+ "description": "是否以 dashboard 模式显示",
5767
+ "group": "basic"
5768
+ }
5769
+ ],
4152
5770
  "interface": []
4153
5771
  }
4154
5772
  },
@@ -4466,6 +6084,153 @@
4466
6084
  }
4467
6085
  ],
4468
6086
  "memo": "### CustomBrick\n\n| property | type | required | default | description |\n| -------- | ------------ | -------- | ------- | ------------------------ |\n| useBrick | UseBrickConf | ✔️ | - | 自定义构件 |\n| data | any | - | - | 数据,优先级高于整体数据 |\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 | - | - | 属性数据转换来自数据源的哪个字段,不填则为整个数据 |",
6087
+ "properties": [
6088
+ {
6089
+ "name": "displayBrick",
6090
+ "type": "CustomBrick",
6091
+ "required": "true",
6092
+ "default": "-",
6093
+ "description": "展示构件",
6094
+ "group": "basic"
6095
+ },
6096
+ {
6097
+ "name": "popoverBrick",
6098
+ "type": "CustomBrick",
6099
+ "required": "true",
6100
+ "default": "-",
6101
+ "description": "弹出框构件",
6102
+ "group": "basic"
6103
+ },
6104
+ {
6105
+ "name": "popoverIcon",
6106
+ "type": "MenuIcon",
6107
+ "required": "false",
6108
+ "default": "{ lib: \"fa\", icon: \"pencil-alt\", prefix: \"fas\" }",
6109
+ "description": "触发弹出框的 icon [MenuIcon](/next-docs/docs/api-reference/brick-types.menuicon#menuicon-interface)",
6110
+ "group": "ui"
6111
+ },
6112
+ {
6113
+ "name": "popoverContentStyle",
6114
+ "type": "Record<string,any>",
6115
+ "required": "false",
6116
+ "default": "{width:200px}",
6117
+ "description": "popover 内容区域的样式,默认给了 200 的宽度。由于我们的弹出框拥有自定义构件的能力,在第一次点击之前,popover 是不知道所渲染构件的宽高,可能发生错位的问题。可以通过设置宽高来解决问题。注意,根据不同的`placement`需要按需调整宽度/高度。[详见](https://github.com/ant-design/ant-design/issues/3545)",
6118
+ "group": "ui"
6119
+ },
6120
+ {
6121
+ "name": "placement",
6122
+ "type": "top|left|right|bottom|topLeft|topRight|bottomLeft|bottomRight|leftTop|leftBottom|rightTop|rightBottom",
6123
+ "required": "false",
6124
+ "default": "bottom",
6125
+ "description": "气泡框位置。注意设置该属性的时候可能需要调整`popoverContentStyle`。",
6126
+ "group": "ui"
6127
+ },
6128
+ {
6129
+ "name": "showIcon",
6130
+ "type": "\"always\"|\"hover\"|\"never\"",
6131
+ "required": "false",
6132
+ "default": "hover",
6133
+ "description": "在什么时候显示 Icon",
6134
+ "group": "ui"
6135
+ },
6136
+ {
6137
+ "name": "zIndex",
6138
+ "type": "number",
6139
+ "required": "false",
6140
+ "default": "1030",
6141
+ "description": "popover的z轴顺序",
6142
+ "group": "ui"
6143
+ },
6144
+ {
6145
+ "name": "trigger",
6146
+ "type": "ActionType | ActionType[]",
6147
+ "required": "false",
6148
+ "default": "-",
6149
+ "description": "触发方式",
6150
+ "group": "basic"
6151
+ },
6152
+ {
6153
+ "name": "data",
6154
+ "type": "any",
6155
+ "required": "false",
6156
+ "default": "false",
6157
+ "description": "整体数据,如果展示构件和弹出框构件数据都来自于同一个 provider,可以直接配置 data,如果来源不一样,可以分别配置 CustomBrick.data",
6158
+ "group": "basic"
6159
+ },
6160
+ {
6161
+ "name": "triggerByIcon",
6162
+ "type": "hover|click",
6163
+ "required": "false",
6164
+ "default": "click",
6165
+ "description": "触发行为",
6166
+ "group": "basic"
6167
+ },
6168
+ {
6169
+ "name": "visible",
6170
+ "type": "{useBrick:UseBrickConf;data?:any}",
6171
+ "required": "false",
6172
+ "default": "false",
6173
+ "description": "弹出框是否可见",
6174
+ "group": "ui"
6175
+ },
6176
+ {
6177
+ "name": "showPopoverBg",
6178
+ "type": "boolean",
6179
+ "required": "false",
6180
+ "default": "true",
6181
+ "description": "是否显示 popover 的默认背景",
6182
+ "group": "ui"
6183
+ },
6184
+ {
6185
+ "name": "highlighted",
6186
+ "type": "boolean",
6187
+ "required": "false",
6188
+ "default": "false",
6189
+ "description": "是否高亮,由[general-graph](developers/brick-book/brick/graph.general-graph)构件设置。",
6190
+ "group": "ui"
6191
+ },
6192
+ {
6193
+ "name": "related",
6194
+ "type": "boolean",
6195
+ "required": "false",
6196
+ "default": "false",
6197
+ "description": "是否被关联,由[general-graph](developers/brick-book/brick/graph.general-graph)构件设置。",
6198
+ "group": "ui"
6199
+ },
6200
+ {
6201
+ "name": "faded",
6202
+ "type": "boolean",
6203
+ "required": "false",
6204
+ "default": "false",
6205
+ "description": "是否弱化,由[general-graph](developers/brick-book/brick/graph.general-graph)构件设置。",
6206
+ "group": "ui"
6207
+ },
6208
+ {
6209
+ "name": "transferGraphAttrs",
6210
+ "type": "boolean",
6211
+ "required": "false",
6212
+ "default": "false",
6213
+ "description": "是否透传拓扑视图的高亮相关属性给子展示构件。由于该构件常用于[general-graph](developers/brick-book/brick/graph.general-graph)构件,故特别增设该属性。开启之后将会透传highlighted(高亮节点)/related(关联节点)/faded(淡化节点)三个属性给子展示构件,以实现高亮功能。",
6214
+ "group": "ui"
6215
+ }
6216
+ ],
6217
+ "events": [
6218
+ {
6219
+ "type": "item.mouse.enter",
6220
+ "detail": "any",
6221
+ "description": "鼠标移动到元素上发出的事件,事件详情为用户设置的 data"
6222
+ },
6223
+ {
6224
+ "type": "item.mouse.leave",
6225
+ "detail": "any",
6226
+ "description": "鼠标离开元素发出的事件,事件详情为用户设置的 data"
6227
+ },
6228
+ {
6229
+ "type": "visible.change",
6230
+ "detail": "{visible:boolean}",
6231
+ "description": "弹出框`是否可见`变化触发的事件"
6232
+ }
6233
+ ],
4469
6234
  "interface": []
4470
6235
  }
4471
6236
  },
@@ -4505,6 +6270,50 @@
4505
6270
  "slots": null,
4506
6271
  "history": null,
4507
6272
  "memo": "",
6273
+ "properties": [
6274
+ {
6275
+ "name": "prefixTitle",
6276
+ "type": "string",
6277
+ "required": "true",
6278
+ "default": "-",
6279
+ "description": "打印保存的 pdf 文件前缀"
6280
+ },
6281
+ {
6282
+ "name": "right",
6283
+ "type": "string",
6284
+ "required": "false",
6285
+ "default": "-",
6286
+ "description": "fixed 布局下,按钮的位置"
6287
+ },
6288
+ {
6289
+ "name": "bottom",
6290
+ "type": "string",
6291
+ "required": "false",
6292
+ "default": "-",
6293
+ "description": "fixed 布局下,按钮的位置"
6294
+ },
6295
+ {
6296
+ "name": "color",
6297
+ "type": "string",
6298
+ "required": "false",
6299
+ "default": "-",
6300
+ "description": "按钮图标颜色"
6301
+ },
6302
+ {
6303
+ "name": "border",
6304
+ "type": "string",
6305
+ "required": "false",
6306
+ "default": "-",
6307
+ "description": "按钮边框"
6308
+ },
6309
+ {
6310
+ "name": "backgroundColor",
6311
+ "type": "string",
6312
+ "required": "false",
6313
+ "default": "-",
6314
+ "description": "按钮的背景"
6315
+ }
6316
+ ],
4508
6317
  "interface": []
4509
6318
  }
4510
6319
  },
@@ -4539,6 +6348,29 @@
4539
6348
  }
4540
6349
  ],
4541
6350
  "memo": "### DEMO\n```json\n{\n \"brick\": \"basic-bricks.redirect-to\",\n \"properties\": {\n \"href\": \"\" // 目标url\n }\n}\n```\n如果没数据则跳转到指引页面\n\n```json\n{\n \"brick\": \"basic-bricks.redirect-to\",\n \"properties\": {\n \"href\": \"${APP.homepage}/guide\",\n \"href2\": \"${APP.homepage}/list\"\n },\n \"lifeCycle\": {\n \"useResolves\": [\n {\n \"provider\": \"xxxxx\",\n \"transform\": {\n \"useHref2\": \"@{list.length}\"\n }\n }\n ]\n }\n}\n```\n>Tips: 新增 href2 用来解决如下场景:如果有数据则跳转到列表页面,如果没数据则跳转到提示新建页面",
6351
+ "properties": [
6352
+ {
6353
+ "name": "href",
6354
+ "type": "string",
6355
+ "required": "true",
6356
+ "default": "-",
6357
+ "description": "重定向的 url"
6358
+ },
6359
+ {
6360
+ "name": "href2",
6361
+ "type": "string",
6362
+ "required": "false",
6363
+ "default": "-",
6364
+ "description": "重定向的 url2"
6365
+ },
6366
+ {
6367
+ "name": "useHref2",
6368
+ "type": "boolean",
6369
+ "required": "true",
6370
+ "default": "-",
6371
+ "description": "是否选用 href2 作为最终的跳转链接"
6372
+ }
6373
+ ],
4542
6374
  "interface": []
4543
6375
  }
4544
6376
  },
@@ -4740,6 +6572,60 @@
4740
6572
  }
4741
6573
  ],
4742
6574
  "memo": ">`sendNotify`使用场景\n>\n> 在编排的时候,如果想要动态根据某个条件来决定是否做某个事情,可以:\n>\n> 1. 在事件或`useResolve`中通过`properties`给`script-brick`的`data`设定标记位,注意不能用`execute`,因为`execute`不改变内部的 data 变量\n> 2. 在`script-brick`根据所需绑定的`data.true`的事件或`data.false`事件\n> 3. 执行`sendNotify`,则会根据`data`发送`data.true`或`data.false`事件,从而执行不同的绑定行为",
6575
+ "properties": [
6576
+ {
6577
+ "name": "data",
6578
+ "type": "any",
6579
+ "required": "false",
6580
+ "default": "-",
6581
+ "description": "可通过 useResolve 来更新 data 字段并执行,具体见第 2 个示例"
6582
+ },
6583
+ {
6584
+ "name": "fun",
6585
+ "type": "string",
6586
+ "required": "true",
6587
+ "default": "-",
6588
+ "description": "自定义函数,入参为`data`,注意要`return`,如`return {'a': data.split('.')};\"`"
6589
+ },
6590
+ {
6591
+ "name": "multiple",
6592
+ "type": "boolean",
6593
+ "required": "false",
6594
+ "default": "-",
6595
+ "description": "目标构件是否为多个,target 有值时生效"
6596
+ },
6597
+ {
6598
+ "name": "target",
6599
+ "type": "string",
6600
+ "required": "false",
6601
+ "default": "-",
6602
+ "description": "目标构件,格式为`css selector`,如果不在这边填,也可以通过事件来给其他构件赋值"
6603
+ },
6604
+ {
6605
+ "name": "transform",
6606
+ "type": "`GeneralTransform`",
6607
+ "required": "false",
6608
+ "default": "-",
6609
+ "description": "属性数据转换配置,请参考[Transform 数据转换](http://docs.developers.easyops.cn/docs/brick-next/transform),当 target 有值时,可直接在此处做数据的转换,注意,如果`target`有值,`transform`也要填"
6610
+ }
6611
+ ],
6612
+ "events": [
6613
+ {
6614
+ "type": "data.false",
6615
+ "detail": "any",
6616
+ "description": "自定义函数`fun`返回的值"
6617
+ },
6618
+ {
6619
+ "type": "data.true",
6620
+ "detail": "any",
6621
+ "description": "自定义函数`fun`返回的值"
6622
+ },
6623
+ {
6624
+ "type": "script.execute",
6625
+ "detail": "any",
6626
+ "description": "自定义函数`fun`返回的值"
6627
+ }
6628
+ ],
4743
6629
  "interface": []
4744
6630
  }
4745
6631
  },
@@ -4959,6 +6845,22 @@
4959
6845
  "slots": null,
4960
6846
  "history": null,
4961
6847
  "memo": "> Tips: 通用子菜单构件,相关配置项同 Storyboard.routes.menu.sidebarMenu,暂时不支持 icon",
6848
+ "properties": [
6849
+ {
6850
+ "name": "dataSource",
6851
+ "type": "[SidebarMenu](http://developers.162.d.easyops.local/micro-app/storyboard-routes-menu-sidebarmenu.html)",
6852
+ "required": "true",
6853
+ "default": "-",
6854
+ "description": "数据源"
6855
+ },
6856
+ {
6857
+ "name": "topOperationConf",
6858
+ "type": "{ useBrick: UseBrickConf }",
6859
+ "required": "false",
6860
+ "default": "-",
6861
+ "description": "菜单顶部操作按钮"
6862
+ }
6863
+ ],
4962
6864
  "interface": []
4963
6865
  }
4964
6866
  },
@@ -5170,6 +7072,113 @@
5170
7072
  }
5171
7073
  ],
5172
7074
  "memo": "### Interface\n\n```typescript\nexport declare type MenuIcon = AntdIcon | FaIcon | EasyopsIcon;\n\nexport interface AntdIcon {\n lib: \"antd\";\n type: string;\n theme?: ThemeType;\n}\nexport interface FaIcon {\n lib: \"fa\";\n icon: IconName;\n prefix?: IconPrefix;\n}\nexport interface EasyopsIcon {\n lib: \"easyops\";\n icon: string;\n category?: string;\n}\n\nexport interface SubMenuFilterSimpleItem {\n title: string;\n key: string;\n type?: \"item\";\n icon: MenuIcon;\n}\n\nexport interface SubMenuFilterGroup {\n type: \"group\" | \"subMenu\";\n title: string;\n items: SubMenuFilterSimpleItem[];\n key?: string;\n}\n\nexport type SubMenuFilterItem = SubMenuFilterSimpleItem | SubMenuFilterGroup;\n\nexport interface SubMenuFilterProps {\n defaultSelectedKeys: string[];\n defaultOpenKeys: string[];\n selectable: boolean;\n multiple: boolean;\n suffixBrick?: { useBrick: UseBrickConf };\n menuItems: SubMenuFilterItem[];\n placeholder?: string;\n unsearchable: boolean;\n onSelect: (menuItem: SubMenuFilterItem[]) => void;\n onSearch: (query: string) => void;\n}\n```",
7075
+ "properties": [
7076
+ {
7077
+ "name": "menuItems",
7078
+ "type": "SubMenuFilterItem[]",
7079
+ "required": "-",
7080
+ "default": "-",
7081
+ "description": "菜单项",
7082
+ "group": "basic"
7083
+ },
7084
+ {
7085
+ "name": "suffixBrick",
7086
+ "type": "{useBrick:UseBrickConf}",
7087
+ "required": "false",
7088
+ "default": "-",
7089
+ "description": "列表项 extra 位置(右边),相关文档[UseBrickConf](/next-docs/docs/api-reference/brick-types.usebrickconf)",
7090
+ "group": "other"
7091
+ },
7092
+ {
7093
+ "name": "unsearchable",
7094
+ "type": "boolean",
7095
+ "required": "false",
7096
+ "default": "false",
7097
+ "description": "是否展示搜索框",
7098
+ "group": "basic"
7099
+ },
7100
+ {
7101
+ "name": "placeholder",
7102
+ "type": "string",
7103
+ "required": "false",
7104
+ "default": "-",
7105
+ "description": "搜索框 placeholder",
7106
+ "group": "basic"
7107
+ },
7108
+ {
7109
+ "name": "defaultSelectedKeys",
7110
+ "type": "string[]",
7111
+ "required": "false",
7112
+ "default": "-",
7113
+ "description": "初始选中的菜单项 key 数组",
7114
+ "group": "basic"
7115
+ },
7116
+ {
7117
+ "name": "defaultOpenKeys",
7118
+ "type": "string[]",
7119
+ "required": "false",
7120
+ "default": "-",
7121
+ "description": "初始展开的 SubMenu 菜单项 key 数组",
7122
+ "group": "basic"
7123
+ },
7124
+ {
7125
+ "name": "selectable",
7126
+ "type": "boolean",
7127
+ "required": "false",
7128
+ "default": "true",
7129
+ "description": "是否允许选中",
7130
+ "group": "basic"
7131
+ },
7132
+ {
7133
+ "name": "multiple",
7134
+ "type": "boolean",
7135
+ "required": "false",
7136
+ "default": "false",
7137
+ "description": "是否多选",
7138
+ "group": "basic"
7139
+ },
7140
+ {
7141
+ "name": "inlineIndent",
7142
+ "type": "number",
7143
+ "required": "false",
7144
+ "default": "24",
7145
+ "description": "菜单缩进宽度",
7146
+ "group": "ui"
7147
+ },
7148
+ {
7149
+ "name": "transparentBackground",
7150
+ "type": "boolean",
7151
+ "required": "false",
7152
+ "default": "false",
7153
+ "description": "是否采用透明背景样式",
7154
+ "group": "ui"
7155
+ },
7156
+ {
7157
+ "name": "accordion",
7158
+ "type": "boolean",
7159
+ "required": "false",
7160
+ "default": "false",
7161
+ "description": "手风琴模式",
7162
+ "group": "basic"
7163
+ }
7164
+ ],
7165
+ "events": [
7166
+ {
7167
+ "type": "menu.click",
7168
+ "detail": "SubMenuFilterItem[]",
7169
+ "description": "-"
7170
+ },
7171
+ {
7172
+ "type": "menu.search",
7173
+ "detail": "string",
7174
+ "description": "搜索 query"
7175
+ },
7176
+ {
7177
+ "type": "menu.select",
7178
+ "detail": "SubMenuFilterItem[]",
7179
+ "description": "-"
7180
+ }
7181
+ ],
5173
7182
  "interface": []
5174
7183
  }
5175
7184
  },
@@ -5256,6 +7265,42 @@
5256
7265
  }
5257
7266
  ],
5258
7267
  "memo": "",
7268
+ "properties": [
7269
+ {
7270
+ "name": "source",
7271
+ "type": "object",
7272
+ "required": "true",
7273
+ "default": "-",
7274
+ "description": "数据来源的构件的字典,key 为数据的字段名,value 为来源构件的 css selector"
7275
+ },
7276
+ {
7277
+ "name": "target",
7278
+ "type": "string",
7279
+ "required": "true",
7280
+ "default": "-",
7281
+ "description": "目标构件的 css selector"
7282
+ },
7283
+ {
7284
+ "name": "transform",
7285
+ "type": "GeneralTransform",
7286
+ "required": "true",
7287
+ "default": "-",
7288
+ "description": "属性数据转换配置,请参考[Transform 数据转换](http://docs.developers.easyops.cn/docs/brick-next/transform)"
7289
+ },
7290
+ {
7291
+ "name": "multiple",
7292
+ "type": "boolean",
7293
+ "required": "false",
7294
+ "default": "`false`",
7295
+ "description": "目标构件是否为多个"
7296
+ }
7297
+ ],
7298
+ "methods": [
7299
+ {
7300
+ "name": "execute",
7301
+ "description": "执行转换"
7302
+ }
7303
+ ],
5259
7304
  "interface": []
5260
7305
  }
5261
7306
  },
@@ -5340,6 +7385,31 @@
5340
7385
  "description": " 右侧工具栏插槽"
5341
7386
  }
5342
7387
  ],
7388
+ "properties": [
7389
+ {
7390
+ "name": "logoUrl",
7391
+ "type": "string",
7392
+ "required": "false",
7393
+ "default": "-",
7394
+ "description": "log 图片",
7395
+ "group": "basic"
7396
+ },
7397
+ {
7398
+ "name": "headerBackgroundColor",
7399
+ "type": "string",
7400
+ "required": "false",
7401
+ "default": "-",
7402
+ "description": "构件背景颜色",
7403
+ "group": "basic"
7404
+ }
7405
+ ],
7406
+ "events": [
7407
+ {
7408
+ "type": "logo.click",
7409
+ "detail": "`-`",
7410
+ "description": "点击logo时触发"
7411
+ }
7412
+ ],
5343
7413
  "interface": []
5344
7414
  }
5345
7415
  },
@@ -5419,7 +7489,108 @@
5419
7489
  }
5420
7490
  ],
5421
7491
  "dockind": "brick",
5422
- "interface": []
7492
+ "events": [
7493
+ {
7494
+ "type": "anchor.change",
7495
+ "detail": "{ currentActiveLink: string }",
7496
+ "description": "锚点改变事件"
7497
+ },
7498
+ {
7499
+ "type": "anchor.click",
7500
+ "detail": "{ title: string; href: string }",
7501
+ "description": "锚点点击事件"
7502
+ }
7503
+ ],
7504
+ "properties": [
7505
+ {
7506
+ "name": "anchorList",
7507
+ "type": "`AnchorListType[]`",
7508
+ "required": "true",
7509
+ "default": "-",
7510
+ "description": "锚点链接的list,会根据list的结构渲染出对应的锚点排布",
7511
+ "group": "basic"
7512
+ },
7513
+ {
7514
+ "name": "configProps",
7515
+ "type": "`AnchorProps`",
7516
+ "required": "false",
7517
+ "default": "-",
7518
+ "description": "锚点的具体参数,这里offsetTop设置了默认为`56`,其他参数可参考[antd](https://ant.design/docs/react/use-in-typescript-cn#Anchor-Props)",
7519
+ "group": "basic"
7520
+ },
7521
+ {
7522
+ "name": "type",
7523
+ "type": "`\"default\" | \"radio\"`",
7524
+ "required": "false",
7525
+ "default": "default",
7526
+ "description": "锚点的类型 , `radio` 的类型不支持 `anchorList`属性有`children`,否则会样式有问题",
7527
+ "group": "basic"
7528
+ },
7529
+ {
7530
+ "name": "extraBrick",
7531
+ "type": "`{ useBrick: UseBrickConf }`",
7532
+ "required": "false",
7533
+ "default": "-",
7534
+ "description": "右上角有操作区",
7535
+ "group": "basic"
7536
+ },
7537
+ {
7538
+ "name": "disabledJump",
7539
+ "type": "boolean",
7540
+ "required": "false",
7541
+ "default": "false",
7542
+ "description": "禁用默认跳转事件",
7543
+ "group": "basic"
7544
+ },
7545
+ {
7546
+ "name": "initOffset",
7547
+ "type": "number",
7548
+ "required": "false",
7549
+ "default": "",
7550
+ "description": "页面初始化时希望额外向上滚动的距离,例如在target有较大padding但是希望内容显示在上方时可设置。",
7551
+ "group": "ui"
7552
+ }
7553
+ ],
7554
+ "interface": [
7555
+ {
7556
+ "name": "AnchorListType",
7557
+ "typeParameter": null,
7558
+ "kind": "interface",
7559
+ "extendedTypes": [
7560
+ {
7561
+ "type": "reference",
7562
+ "name": "AnchorLinkProps"
7563
+ }
7564
+ ],
7565
+ "children": [
7566
+ {
7567
+ "name": "children",
7568
+ "type": "AnchorListType[]",
7569
+ "required": false,
7570
+ "description": ""
7571
+ },
7572
+ {
7573
+ "name": "href",
7574
+ "type": "string",
7575
+ "required": true,
7576
+ "description": ""
7577
+ },
7578
+ {
7579
+ "name": "target",
7580
+ "type": "string",
7581
+ "required": false,
7582
+ "description": ""
7583
+ },
7584
+ {
7585
+ "name": "title",
7586
+ "type": "string",
7587
+ "required": true,
7588
+ "description": ""
7589
+ }
7590
+ ],
7591
+ "indexSignature": []
7592
+ }
7593
+ ]
5423
7594
  }
5424
7595
  },
5425
7596
  {
@@ -5473,6 +7644,88 @@
5473
7644
  }
5474
7645
  ],
5475
7646
  "dockind": "brick",
7647
+ "properties": [
7648
+ {
7649
+ "name": "mainTitle",
7650
+ "type": "`string`",
7651
+ "required": "true",
7652
+ "default": "",
7653
+ "description": "标题",
7654
+ "group": "basic"
7655
+ },
7656
+ {
7657
+ "name": "description",
7658
+ "type": "`string`",
7659
+ "required": "false",
7660
+ "default": "",
7661
+ "description": "描述",
7662
+ "group": "basic"
7663
+ },
7664
+ {
7665
+ "name": "subTitle",
7666
+ "type": "`string`",
7667
+ "required": "",
7668
+ "default": "",
7669
+ "description": "副标题",
7670
+ "group": "basic"
7671
+ },
7672
+ {
7673
+ "name": "url",
7674
+ "type": "`string`",
7675
+ "required": "false",
7676
+ "default": "",
7677
+ "description": "链接,点击标题时跳转",
7678
+ "group": "basic"
7679
+ },
7680
+ {
7681
+ "name": "target",
7682
+ "type": "`string`",
7683
+ "required": "false",
7684
+ "default": "",
7685
+ "description": "title跳转 target,例如可以设置成 _blank",
7686
+ "group": "basic"
7687
+ },
7688
+ {
7689
+ "name": "descPrefixBrick",
7690
+ "type": "`{useBrick: UseBrickConf }`",
7691
+ "required": "false",
7692
+ "default": "",
7693
+ "description": "可以在描述前添加前缀",
7694
+ "group": "other"
7695
+ },
7696
+ {
7697
+ "name": "titleSuffixBrick",
7698
+ "type": "`{useBrick: UseBrickConf }",
7699
+ "required": "false",
7700
+ "default": "",
7701
+ "description": "可以在标题后添加后缀",
7702
+ "group": "other"
7703
+ },
7704
+ {
7705
+ "name": "descSuffixBrick",
7706
+ "type": "`{useBrick: UseBrickConf }`",
7707
+ "required": "false",
7708
+ "default": "",
7709
+ "description": "可以在描述后面添加后缀",
7710
+ "group": "other"
7711
+ },
7712
+ {
7713
+ "name": "dataSource",
7714
+ "type": "` Record<string, any>`",
7715
+ "required": "false",
7716
+ "default": "",
7717
+ "description": "数据源",
7718
+ "group": "other"
7719
+ },
7720
+ {
7721
+ "name": "fields",
7722
+ "type": "` {mainTitle?: string; subTitle?: string; description?: string;}`",
7723
+ "required": "false",
7724
+ "default": "",
7725
+ "description": "字段映射, 跟 dataSource 一起使用来获得运行时 mainTitle、 description",
7726
+ "group": "other"
7727
+ }
7728
+ ],
5476
7729
  "interface": []
5477
7730
  }
5478
7731
  },
@@ -5623,6 +7876,50 @@
5623
7876
  }
5624
7877
  ],
5625
7878
  "dockind": "brick",
7879
+ "properties": [
7880
+ {
7881
+ "name": "flexDirection",
7882
+ "type": "string",
7883
+ "required": false,
7884
+ "description": "定义[flex-direction]:设置主轴方向",
7885
+ "group": "basic"
7886
+ },
7887
+ {
7888
+ "name": "justifyContent",
7889
+ "type": "string",
7890
+ "required": false,
7891
+ "description": "定义[justify-content]:设置主轴上子元素的排列方式",
7892
+ "group": "basic"
7893
+ },
7894
+ {
7895
+ "name": "alignItems",
7896
+ "type": "string",
7897
+ "required": false,
7898
+ "description": "定义[align-items]:设置侧轴上的子元素排列方式(单行)",
7899
+ "group": "basic"
7900
+ },
7901
+ {
7902
+ "name": "alignContent",
7903
+ "type": "string",
7904
+ "required": false,
7905
+ "description": "定义[align-content]:设置侧轴上的子元素排列方式(多行)",
7906
+ "group": "basic"
7907
+ },
7908
+ {
7909
+ "name": "flexWrap",
7910
+ "type": "string",
7911
+ "required": false,
7912
+ "description": "定义[flex-wrap]:设置换行方式",
7913
+ "group": "basic"
7914
+ },
7915
+ {
7916
+ "name": "gap",
7917
+ "type": "string",
7918
+ "required": false,
7919
+ "description": "定义[gap]:设置元素间隙",
7920
+ "group": "basic"
7921
+ }
7922
+ ],
5626
7923
  "interface": []
5627
7924
  }
5628
7925
  },
@@ -5711,6 +8008,13 @@
5711
8008
  }
5712
8009
  ],
5713
8010
  "dockind": "brick",
8011
+ "methods": [
8012
+ {
8013
+ "name": "trigger",
8014
+ "params": "detail: unknown",
8015
+ "description": "触发一次事件,传递的参数为事件详情。"
8016
+ }
8017
+ ],
5714
8018
  "interface": []
5715
8019
  }
5716
8020
  }