@next-bricks/basic-bricks 1.201.0 → 1.203.0

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,71 +226,6 @@
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
- ],
294
229
  "interface": []
295
230
  }
296
231
  },
@@ -466,50 +401,6 @@
466
401
  }
467
402
  ],
468
403
  "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
- ],
513
404
  "interface": []
514
405
  }
515
406
  },
@@ -590,41 +481,6 @@
590
481
  }
591
482
  ],
592
483
  "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
- ],
628
484
  "interface": []
629
485
  }
630
486
  },
@@ -669,28 +525,6 @@
669
525
  "slots": null,
670
526
  "history": null,
671
527
  "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
- ],
694
528
  "interface": []
695
529
  }
696
530
  },
@@ -818,72 +652,6 @@
818
652
  }
819
653
  ],
820
654
  "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
- ],
887
655
  "interface": []
888
656
  }
889
657
  },
@@ -1046,205 +814,7 @@
1046
814
  }
1047
815
  ],
1048
816
  "memo": "注意,因为按钮是有 margin 的,在`type=link` 时候也一样会有,所以在表格里面放置点击链接的时候,请选用[链接](developers/brick-book/brick/presentational-bricks.brick-link)",
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
- ]
817
+ "interface": []
1248
818
  }
1249
819
  },
1250
820
  {
@@ -1698,114 +1268,7 @@
1698
1268
  "change": "新增属性 `fillVertical`"
1699
1269
  }
1700
1270
  ],
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
- ]
1271
+ "interface": []
1809
1272
  }
1810
1273
  },
1811
1274
  {
@@ -2778,255 +2241,7 @@
2778
2241
  }
2779
2242
  ],
2780
2243
  "memo": "",
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
- ]
2244
+ "interface": []
3030
2245
  }
3031
2246
  },
3032
2247
  {
@@ -3345,157 +2560,7 @@
3345
2560
  }
3346
2561
  ],
3347
2562
  "memo": "### OpenCloseOption\n\n| property | type | required | default | description |\n| -------- | --------- | -------- | ------- | ----------- |\n| noEvent | `boolean` | - | - | 不触发事件 |",
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
- ]
2563
+ "interface": []
3499
2564
  }
3500
2565
  },
3501
2566
  {
@@ -3557,24 +2622,6 @@
3557
2622
  }
3558
2623
  ],
3559
2624
  "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
- ],
3578
2625
  "interface": []
3579
2626
  }
3580
2627
  },
@@ -3945,240 +2992,7 @@
3945
2992
  }
3946
2993
  ],
3947
2994
  "memo": "### OpenCloseOption\n\n| property | type | required | default | description |\n| -------- | --------- | -------- | ------- | ----------- |\n| noEvent | `boolean` | - | - | 不触发事件 |",
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
- ]
2995
+ "interface": []
4182
2996
  }
4183
2997
  },
4184
2998
  {
@@ -4261,75 +3075,6 @@
4261
3075
  }
4262
3076
  ],
4263
3077
  "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
- ],
4333
3078
  "interface": []
4334
3079
  }
4335
3080
  },
@@ -4389,42 +3134,6 @@
4389
3134
  }
4390
3135
  ],
4391
3136
  "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
- ],
4428
3137
  "interface": []
4429
3138
  }
4430
3139
  },
@@ -4540,122 +3249,7 @@
4540
3249
  "slots": null,
4541
3250
  "history": null,
4542
3251
  "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` 时显示两列,更小的屏幕显示为一列。",
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
- ]
3252
+ "interface": []
4659
3253
  }
4660
3254
  },
4661
3255
  {
@@ -4686,15 +3280,6 @@
4686
3280
  "slots": null,
4687
3281
  "history": null,
4688
3282
  "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
- ],
4698
3283
  "interface": []
4699
3284
  }
4700
3285
  },
@@ -4777,22 +3362,6 @@
4777
3362
  "slots": null,
4778
3363
  "history": null,
4779
3364
  "memo": "",
4780
- "properties": [
4781
- {
4782
- "name": "contentGridGap",
4783
- "type": "number",
4784
- "required": "false",
4785
- "default": "24",
4786
- "description": "内容区的 gap,内容区固定为 grid 布局"
4787
- },
4788
- {
4789
- "name": "title",
4790
- "type": "string",
4791
- "required": "false",
4792
- "default": "-",
4793
- "description": "卡片标题"
4794
- }
4795
- ],
4796
3365
  "interface": []
4797
3366
  }
4798
3367
  },
@@ -4868,55 +3437,6 @@
4868
3437
  }
4869
3438
  ],
4870
3439
  "memo": "",
4871
- "properties": [
4872
- {
4873
- "name": "useBrick",
4874
- "type": "UseBrickConf",
4875
- "required": "true",
4876
- "default": "[]",
4877
- "description": "使用的子构件配置,具体查阅[UseBrickConf](/next-docs/docs/micro-app/brick-use-brick)",
4878
- "group": "basic"
4879
- },
4880
- {
4881
- "name": "data",
4882
- "type": "`any[]`",
4883
- "required": "true",
4884
- "default": "[]",
4885
- "description": "数据列表",
4886
- "group": "basic"
4887
- },
4888
- {
4889
- "name": "itemKey",
4890
- "type": "string",
4891
- "required": false,
4892
- "description": "数据项的 key,不设置默认使用 index",
4893
- "group": "basic"
4894
- },
4895
- {
4896
- "name": "gap",
4897
- "type": "string | number",
4898
- "required": false,
4899
- "default": "\"var(--card-content-gap)\"",
4900
- "description": "间距(配合extraContainerStyle使用)",
4901
- "group": "ui"
4902
- },
4903
- {
4904
- "name": "extraContainerStyle",
4905
- "type": "Record<string, any>",
4906
- "required": false,
4907
- "default": "-",
4908
- "description": "容器本身默认是 grid 布局,可以设置额外的样式。",
4909
- "group": "ui"
4910
- },
4911
- {
4912
- "name": "containerStyle",
4913
- "type": "Record<string, any>",
4914
- "required": false,
4915
- "default": "-",
4916
- "description": "自定义容器的样式,容器本身默认是 grid 布局,如果`containerStyle`不为空则覆盖掉容器本身的样式配置",
4917
- "group": "ui"
4918
- }
4919
- ],
4920
3440
  "interface": []
4921
3441
  }
4922
3442
  },
@@ -4971,22 +3491,6 @@
4971
3491
  }
4972
3492
  ],
4973
3493
  "memo": "",
4974
- "properties": [
4975
- {
4976
- "name": "showType",
4977
- "type": "string",
4978
- "required": "true",
4979
- "default": "-",
4980
- "description": "数据渲染类型,对[构件配置表](magic-brick)中的 selector 字段"
4981
- },
4982
- {
4983
- "name": "data",
4984
- "type": "any",
4985
- "required": "true",
4986
- "default": "-",
4987
- "description": "数据源,通常情况该构件在一些容器构件中使用,数据源来自于容器构件例如 brick-table 的 rowData"
4988
- }
4989
- ],
4990
3494
  "interface": []
4991
3495
  }
4992
3496
  },
@@ -5061,29 +3565,6 @@
5061
3565
  "slots": null,
5062
3566
  "history": null,
5063
3567
  "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```",
5064
- "properties": [
5065
- {
5066
- "name": "menu",
5067
- "type": "SidebarMenu",
5068
- "required": "true",
5069
- "default": "-",
5070
- "description": "菜单项"
5071
- },
5072
- {
5073
- "name": "subMenu",
5074
- "type": "SidebarMenu",
5075
- "required": "true",
5076
- "default": "-",
5077
- "description": "二级菜单项"
5078
- },
5079
- {
5080
- "name": "collapsed",
5081
- "type": "boolean",
5082
- "required": "true",
5083
- "default": "-",
5084
- "description": "是否折叠"
5085
- }
5086
- ],
5087
3568
  "interface": []
5088
3569
  }
5089
3570
  },
@@ -5390,71 +3871,6 @@
5390
3871
  }
5391
3872
  ],
5392
3873
  "memo": "",
5393
- "properties": [
5394
- {
5395
- "name": "pageTitle",
5396
- "type": "string",
5397
- "required": "-",
5398
- "default": "-",
5399
- "description": "设置标题。如果要使用复杂的标题构件,请使用插槽 `titleBar`",
5400
- "group": "basic"
5401
- },
5402
- {
5403
- "name": "bannerPageTitle",
5404
- "type": "string",
5405
- "required": "-",
5406
- "default": "-",
5407
- "description": "设置 banner 标题。如果要使用复杂的标题构件,请使用插槽 `bannerTitleBar`",
5408
- "group": "basic"
5409
- },
5410
- {
5411
- "name": "overflowXAuto",
5412
- "type": "boolean",
5413
- "required": "-",
5414
- "default": "false",
5415
- "description": "内容区是否需要设置`overflow-x: auto`",
5416
- "group": "ui"
5417
- },
5418
- {
5419
- "name": "noGap",
5420
- "type": "boolean",
5421
- "required": "-",
5422
- "default": "false",
5423
- "description": "内容区默认为 grid 布局且有默认的 gap,设为 `true` 则使之没有 gap。",
5424
- "group": "ui"
5425
- },
5426
- {
5427
- "name": "dashboardMode",
5428
- "type": "boolean",
5429
- "required": true,
5430
- "default": "false",
5431
- "description": "是否启用大屏模式。",
5432
- "group": "ui"
5433
- },
5434
- {
5435
- "name": "pageTitleScale",
5436
- "type": "number",
5437
- "required": false,
5438
- "description": "标题栏大小比例,默认为 1,仅用于暗黑大屏模式。",
5439
- "group": "ui"
5440
- },
5441
- {
5442
- "name": "hideToolbar",
5443
- "type": "boolean",
5444
- "required": true,
5445
- "default": "false",
5446
- "description": "是否隐藏工具栏(常用语大屏模式)。",
5447
- "group": "ui"
5448
- },
5449
- {
5450
- "name": "bannerStyle",
5451
- "type": "CSSProperties",
5452
- "required": false,
5453
- "default": "-",
5454
- "description": "banner 的样式",
5455
- "group": "ui"
5456
- }
5457
- ],
5458
3874
  "interface": []
5459
3875
  }
5460
3876
  },
@@ -5692,22 +4108,6 @@
5692
4108
  "slots": null,
5693
4109
  "history": null,
5694
4110
  "memo": "Tips: 多列布局默认每一列都会有 padding,如果其中某一列不需要则在相应的用户构件 storyboard 内配置 columns-card-no-padding 的类名属性即可,如示例二所示",
5695
- "properties": [
5696
- {
5697
- "name": "gridColumns",
5698
- "type": "`Array<string | number>`",
5699
- "required": "false",
5700
- "default": "-",
5701
- "description": "配置多列布局时每一列的宽度,可以是具体的像素长度`200px`,也可以是数字`1,2...`等等,表示该列的宽度为相应的比例值,列数要与放入插槽的构件数相符"
5702
- },
5703
- {
5704
- "name": "cardBorder",
5705
- "type": "boolean",
5706
- "required": "false",
5707
- "default": "`true`",
5708
- "description": "是否显示卡片边框"
5709
- }
5710
- ],
5711
4111
  "interface": []
5712
4112
  }
5713
4113
  },
@@ -5752,24 +4152,6 @@
5752
4152
  "slots": null,
5753
4153
  "history": null,
5754
4154
  "memo": "",
5755
- "properties": [
5756
- {
5757
- "name": "pageTitle",
5758
- "type": "string",
5759
- "required": "true",
5760
- "default": "-",
5761
- "description": "页面标题",
5762
- "group": "basic"
5763
- },
5764
- {
5765
- "name": "dashboardMode",
5766
- "type": "boolean",
5767
- "required": false,
5768
- "default": "false",
5769
- "description": "是否以 dashboard 模式显示",
5770
- "group": "basic"
5771
- }
5772
- ],
5773
4155
  "interface": []
5774
4156
  }
5775
4157
  },
@@ -6087,153 +4469,6 @@
6087
4469
  }
6088
4470
  ],
6089
4471
  "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 | - | - | 属性数据转换来自数据源的哪个字段,不填则为整个数据 |",
6090
- "properties": [
6091
- {
6092
- "name": "displayBrick",
6093
- "type": "CustomBrick",
6094
- "required": "true",
6095
- "default": "-",
6096
- "description": "展示构件",
6097
- "group": "basic"
6098
- },
6099
- {
6100
- "name": "popoverBrick",
6101
- "type": "CustomBrick",
6102
- "required": "true",
6103
- "default": "-",
6104
- "description": "弹出框构件",
6105
- "group": "basic"
6106
- },
6107
- {
6108
- "name": "popoverIcon",
6109
- "type": "MenuIcon",
6110
- "required": "false",
6111
- "default": "{ lib: \"fa\", icon: \"pencil-alt\", prefix: \"fas\" }",
6112
- "description": "触发弹出框的 icon [MenuIcon](/next-docs/docs/api-reference/brick-types.menuicon#menuicon-interface)",
6113
- "group": "ui"
6114
- },
6115
- {
6116
- "name": "popoverContentStyle",
6117
- "type": "Record<string,any>",
6118
- "required": "false",
6119
- "default": "{width:200px}",
6120
- "description": "popover 内容区域的样式,默认给了 200 的宽度。由于我们的弹出框拥有自定义构件的能力,在第一次点击之前,popover 是不知道所渲染构件的宽高,可能发生错位的问题。可以通过设置宽高来解决问题。注意,根据不同的`placement`需要按需调整宽度/高度。[详见](https://github.com/ant-design/ant-design/issues/3545)",
6121
- "group": "ui"
6122
- },
6123
- {
6124
- "name": "placement",
6125
- "type": "top|left|right|bottom|topLeft|topRight|bottomLeft|bottomRight|leftTop|leftBottom|rightTop|rightBottom",
6126
- "required": "false",
6127
- "default": "bottom",
6128
- "description": "气泡框位置。注意设置该属性的时候可能需要调整`popoverContentStyle`。",
6129
- "group": "ui"
6130
- },
6131
- {
6132
- "name": "showIcon",
6133
- "type": "\"always\"|\"hover\"|\"never\"",
6134
- "required": "false",
6135
- "default": "hover",
6136
- "description": "在什么时候显示 Icon",
6137
- "group": "ui"
6138
- },
6139
- {
6140
- "name": "zIndex",
6141
- "type": "number",
6142
- "required": "false",
6143
- "default": "1030",
6144
- "description": "popover的z轴顺序",
6145
- "group": "ui"
6146
- },
6147
- {
6148
- "name": "trigger",
6149
- "type": "ActionType | ActionType[]",
6150
- "required": "false",
6151
- "default": "-",
6152
- "description": "触发方式",
6153
- "group": "basic"
6154
- },
6155
- {
6156
- "name": "data",
6157
- "type": "any",
6158
- "required": "false",
6159
- "default": "false",
6160
- "description": "整体数据,如果展示构件和弹出框构件数据都来自于同一个 provider,可以直接配置 data,如果来源不一样,可以分别配置 CustomBrick.data",
6161
- "group": "basic"
6162
- },
6163
- {
6164
- "name": "triggerByIcon",
6165
- "type": "hover|click",
6166
- "required": "false",
6167
- "default": "click",
6168
- "description": "触发行为",
6169
- "group": "basic"
6170
- },
6171
- {
6172
- "name": "visible",
6173
- "type": "{useBrick:UseBrickConf;data?:any}",
6174
- "required": "false",
6175
- "default": "false",
6176
- "description": "弹出框是否可见",
6177
- "group": "ui"
6178
- },
6179
- {
6180
- "name": "showPopoverBg",
6181
- "type": "boolean",
6182
- "required": "false",
6183
- "default": "true",
6184
- "description": "是否显示 popover 的默认背景",
6185
- "group": "ui"
6186
- },
6187
- {
6188
- "name": "highlighted",
6189
- "type": "boolean",
6190
- "required": "false",
6191
- "default": "false",
6192
- "description": "是否高亮,由[general-graph](developers/brick-book/brick/graph.general-graph)构件设置。",
6193
- "group": "ui"
6194
- },
6195
- {
6196
- "name": "related",
6197
- "type": "boolean",
6198
- "required": "false",
6199
- "default": "false",
6200
- "description": "是否被关联,由[general-graph](developers/brick-book/brick/graph.general-graph)构件设置。",
6201
- "group": "ui"
6202
- },
6203
- {
6204
- "name": "faded",
6205
- "type": "boolean",
6206
- "required": "false",
6207
- "default": "false",
6208
- "description": "是否弱化,由[general-graph](developers/brick-book/brick/graph.general-graph)构件设置。",
6209
- "group": "ui"
6210
- },
6211
- {
6212
- "name": "transferGraphAttrs",
6213
- "type": "boolean",
6214
- "required": "false",
6215
- "default": "false",
6216
- "description": "是否透传拓扑视图的高亮相关属性给子展示构件。由于该构件常用于[general-graph](developers/brick-book/brick/graph.general-graph)构件,故特别增设该属性。开启之后将会透传highlighted(高亮节点)/related(关联节点)/faded(淡化节点)三个属性给子展示构件,以实现高亮功能。",
6217
- "group": "ui"
6218
- }
6219
- ],
6220
- "events": [
6221
- {
6222
- "type": "item.mouse.enter",
6223
- "detail": "any",
6224
- "description": "鼠标移动到元素上发出的事件,事件详情为用户设置的 data"
6225
- },
6226
- {
6227
- "type": "item.mouse.leave",
6228
- "detail": "any",
6229
- "description": "鼠标离开元素发出的事件,事件详情为用户设置的 data"
6230
- },
6231
- {
6232
- "type": "visible.change",
6233
- "detail": "{visible:boolean}",
6234
- "description": "弹出框`是否可见`变化触发的事件"
6235
- }
6236
- ],
6237
4472
  "interface": []
6238
4473
  }
6239
4474
  },
@@ -6274,50 +4509,6 @@
6274
4509
  "slots": null,
6275
4510
  "history": null,
6276
4511
  "memo": "",
6277
- "properties": [
6278
- {
6279
- "name": "prefixTitle",
6280
- "type": "string",
6281
- "required": "true",
6282
- "default": "-",
6283
- "description": "打印保存的 pdf 文件前缀"
6284
- },
6285
- {
6286
- "name": "right",
6287
- "type": "string",
6288
- "required": "false",
6289
- "default": "-",
6290
- "description": "fixed 布局下,按钮的位置"
6291
- },
6292
- {
6293
- "name": "bottom",
6294
- "type": "string",
6295
- "required": "false",
6296
- "default": "-",
6297
- "description": "fixed 布局下,按钮的位置"
6298
- },
6299
- {
6300
- "name": "color",
6301
- "type": "string",
6302
- "required": "false",
6303
- "default": "-",
6304
- "description": "按钮图标颜色"
6305
- },
6306
- {
6307
- "name": "border",
6308
- "type": "string",
6309
- "required": "false",
6310
- "default": "-",
6311
- "description": "按钮边框"
6312
- },
6313
- {
6314
- "name": "backgroundColor",
6315
- "type": "string",
6316
- "required": "false",
6317
- "default": "-",
6318
- "description": "按钮的背景"
6319
- }
6320
- ],
6321
4512
  "interface": []
6322
4513
  }
6323
4514
  },
@@ -6353,29 +4544,6 @@
6353
4544
  }
6354
4545
  ],
6355
4546
  "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 用来解决如下场景:如果有数据则跳转到列表页面,如果没数据则跳转到提示新建页面",
6356
- "properties": [
6357
- {
6358
- "name": "href",
6359
- "type": "string",
6360
- "required": "true",
6361
- "default": "-",
6362
- "description": "重定向的 url"
6363
- },
6364
- {
6365
- "name": "href2",
6366
- "type": "string",
6367
- "required": "false",
6368
- "default": "-",
6369
- "description": "重定向的 url2"
6370
- },
6371
- {
6372
- "name": "useHref2",
6373
- "type": "boolean",
6374
- "required": "true",
6375
- "default": "-",
6376
- "description": "是否选用 href2 作为最终的跳转链接"
6377
- }
6378
- ],
6379
4547
  "interface": []
6380
4548
  }
6381
4549
  },
@@ -6578,60 +4746,6 @@
6578
4746
  }
6579
4747
  ],
6580
4748
  "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`事件,从而执行不同的绑定行为",
6581
- "properties": [
6582
- {
6583
- "name": "data",
6584
- "type": "any",
6585
- "required": "false",
6586
- "default": "-",
6587
- "description": "可通过 useResolve 来更新 data 字段并执行,具体见第 2 个示例"
6588
- },
6589
- {
6590
- "name": "fun",
6591
- "type": "string",
6592
- "required": "true",
6593
- "default": "-",
6594
- "description": "自定义函数,入参为`data`,注意要`return`,如`return {'a': data.split('.')};\"`"
6595
- },
6596
- {
6597
- "name": "multiple",
6598
- "type": "boolean",
6599
- "required": "false",
6600
- "default": "-",
6601
- "description": "目标构件是否为多个,target 有值时生效"
6602
- },
6603
- {
6604
- "name": "target",
6605
- "type": "string",
6606
- "required": "false",
6607
- "default": "-",
6608
- "description": "目标构件,格式为`css selector`,如果不在这边填,也可以通过事件来给其他构件赋值"
6609
- },
6610
- {
6611
- "name": "transform",
6612
- "type": "`GeneralTransform`",
6613
- "required": "false",
6614
- "default": "-",
6615
- "description": "属性数据转换配置,请参考[Transform 数据转换](http://docs.developers.easyops.cn/docs/brick-next/transform),当 target 有值时,可直接在此处做数据的转换,注意,如果`target`有值,`transform`也要填"
6616
- }
6617
- ],
6618
- "events": [
6619
- {
6620
- "type": "data.false",
6621
- "detail": "any",
6622
- "description": "自定义函数`fun`返回的值"
6623
- },
6624
- {
6625
- "type": "data.true",
6626
- "detail": "any",
6627
- "description": "自定义函数`fun`返回的值"
6628
- },
6629
- {
6630
- "type": "script.execute",
6631
- "detail": "any",
6632
- "description": "自定义函数`fun`返回的值"
6633
- }
6634
- ],
6635
4749
  "interface": []
6636
4750
  }
6637
4751
  },
@@ -6852,15 +4966,6 @@
6852
4966
  "slots": null,
6853
4967
  "history": null,
6854
4968
  "memo": "> Tips: 通用子菜单构件,相关配置项同 Storyboard.routes.menu.sidebarMenu,暂时不支持 icon",
6855
- "properties": [
6856
- {
6857
- "name": "dataSource",
6858
- "type": "[SidebarMenu](http://developers.162.d.easyops.local/micro-app/storyboard-routes-menu-sidebarmenu.html)",
6859
- "required": "true",
6860
- "default": "-",
6861
- "description": "数据源"
6862
- }
6863
- ],
6864
4969
  "interface": []
6865
4970
  }
6866
4971
  },
@@ -7072,113 +5177,6 @@
7072
5177
  }
7073
5178
  ],
7074
5179
  "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
- ],
7182
5180
  "interface": []
7183
5181
  }
7184
5182
  },
@@ -7266,42 +5264,6 @@
7266
5264
  }
7267
5265
  ],
7268
5266
  "memo": "",
7269
- "properties": [
7270
- {
7271
- "name": "source",
7272
- "type": "object",
7273
- "required": "true",
7274
- "default": "-",
7275
- "description": "数据来源的构件的字典,key 为数据的字段名,value 为来源构件的 css selector"
7276
- },
7277
- {
7278
- "name": "target",
7279
- "type": "string",
7280
- "required": "true",
7281
- "default": "-",
7282
- "description": "目标构件的 css selector"
7283
- },
7284
- {
7285
- "name": "transform",
7286
- "type": "GeneralTransform",
7287
- "required": "true",
7288
- "default": "-",
7289
- "description": "属性数据转换配置,请参考[Transform 数据转换](http://docs.developers.easyops.cn/docs/brick-next/transform)"
7290
- },
7291
- {
7292
- "name": "multiple",
7293
- "type": "boolean",
7294
- "required": "false",
7295
- "default": "`false`",
7296
- "description": "目标构件是否为多个"
7297
- }
7298
- ],
7299
- "methods": [
7300
- {
7301
- "name": "execute",
7302
- "description": "执行转换"
7303
- }
7304
- ],
7305
5267
  "interface": []
7306
5268
  }
7307
5269
  },
@@ -7386,31 +5348,6 @@
7386
5348
  "description": " 右侧工具栏插槽"
7387
5349
  }
7388
5350
  ],
7389
- "properties": [
7390
- {
7391
- "name": "logoUrl",
7392
- "type": "string",
7393
- "required": "false",
7394
- "default": "-",
7395
- "description": "log 图片",
7396
- "group": "basic"
7397
- },
7398
- {
7399
- "name": "headerBackgroundColor",
7400
- "type": "string",
7401
- "required": "false",
7402
- "default": "-",
7403
- "description": "构件背景颜色",
7404
- "group": "basic"
7405
- }
7406
- ],
7407
- "events": [
7408
- {
7409
- "type": "logo.click",
7410
- "detail": "`-`",
7411
- "description": "点击logo时触发"
7412
- }
7413
- ],
7414
5351
  "interface": []
7415
5352
  }
7416
5353
  },
@@ -7490,108 +5427,7 @@
7490
5427
  }
7491
5428
  ],
7492
5429
  "dockind": "brick",
7493
- "events": [
7494
- {
7495
- "type": "anchor.change",
7496
- "detail": "{ currentActiveLink: string }",
7497
- "description": "锚点改变事件"
7498
- },
7499
- {
7500
- "type": "anchor.click",
7501
- "detail": "{ title: string; href: string }",
7502
- "description": "锚点点击事件"
7503
- }
7504
- ],
7505
- "properties": [
7506
- {
7507
- "name": "anchorList",
7508
- "type": "`AnchorListType[]`",
7509
- "required": "true",
7510
- "default": "-",
7511
- "description": "锚点链接的list,会根据list的结构渲染出对应的锚点排布",
7512
- "group": "basic"
7513
- },
7514
- {
7515
- "name": "configProps",
7516
- "type": "`AnchorProps`",
7517
- "required": "false",
7518
- "default": "-",
7519
- "description": "锚点的具体参数,这里offsetTop设置了默认为`56`,其他参数可参考[antd](https://ant.design/docs/react/use-in-typescript-cn#Anchor-Props)",
7520
- "group": "basic"
7521
- },
7522
- {
7523
- "name": "type",
7524
- "type": "`\"default\" | \"radio\"`",
7525
- "required": "false",
7526
- "default": "default",
7527
- "description": "锚点的类型 , `radio` 的类型不支持 `anchorList`属性有`children`,否则会样式有问题",
7528
- "group": "basic"
7529
- },
7530
- {
7531
- "name": "extraBrick",
7532
- "type": "`{ useBrick: UseBrickConf }`",
7533
- "required": "false",
7534
- "default": "-",
7535
- "description": "右上角有操作区",
7536
- "group": "basic"
7537
- },
7538
- {
7539
- "name": "disabledJump",
7540
- "type": "boolean",
7541
- "required": "false",
7542
- "default": "false",
7543
- "description": "禁用默认跳转事件",
7544
- "group": "basic"
7545
- },
7546
- {
7547
- "name": "initOffset",
7548
- "type": "number",
7549
- "required": "false",
7550
- "default": "",
7551
- "description": "页面初始化时希望额外向上滚动的距离,例如在target有较大padding但是希望内容显示在上方时可设置。",
7552
- "group": "ui"
7553
- }
7554
- ],
7555
- "interface": [
7556
- {
7557
- "name": "AnchorListType",
7558
- "typeParameter": null,
7559
- "kind": "interface",
7560
- "extendedTypes": [
7561
- {
7562
- "type": "reference",
7563
- "name": "AnchorLinkProps"
7564
- }
7565
- ],
7566
- "children": [
7567
- {
7568
- "name": "children",
7569
- "type": "AnchorListType[]",
7570
- "required": false,
7571
- "description": ""
7572
- },
7573
- {
7574
- "name": "href",
7575
- "type": "string",
7576
- "required": true,
7577
- "description": ""
7578
- },
7579
- {
7580
- "name": "target",
7581
- "type": "string",
7582
- "required": false,
7583
- "description": ""
7584
- },
7585
- {
7586
- "name": "title",
7587
- "type": "string",
7588
- "required": true,
7589
- "description": ""
7590
- }
7591
- ],
7592
- "indexSignature": []
7593
- }
7594
- ]
5430
+ "interface": []
7595
5431
  }
7596
5432
  },
7597
5433
  {
@@ -7645,88 +5481,6 @@
7645
5481
  }
7646
5482
  ],
7647
5483
  "dockind": "brick",
7648
- "properties": [
7649
- {
7650
- "name": "mainTitle",
7651
- "type": "`string`",
7652
- "required": "true",
7653
- "default": "",
7654
- "description": "标题",
7655
- "group": "basic"
7656
- },
7657
- {
7658
- "name": "description",
7659
- "type": "`string`",
7660
- "required": "false",
7661
- "default": "",
7662
- "description": "描述",
7663
- "group": "basic"
7664
- },
7665
- {
7666
- "name": "subTitle",
7667
- "type": "`string`",
7668
- "required": "",
7669
- "default": "",
7670
- "description": "副标题",
7671
- "group": "basic"
7672
- },
7673
- {
7674
- "name": "url",
7675
- "type": "`string`",
7676
- "required": "false",
7677
- "default": "",
7678
- "description": "链接,点击标题时跳转",
7679
- "group": "basic"
7680
- },
7681
- {
7682
- "name": "target",
7683
- "type": "`string`",
7684
- "required": "false",
7685
- "default": "",
7686
- "description": "title跳转 target,例如可以设置成 _blank",
7687
- "group": "basic"
7688
- },
7689
- {
7690
- "name": "descPrefixBrick",
7691
- "type": "`{useBrick: UseBrickConf }`",
7692
- "required": "false",
7693
- "default": "",
7694
- "description": "可以在描述前添加前缀",
7695
- "group": "other"
7696
- },
7697
- {
7698
- "name": "titleSuffixBrick",
7699
- "type": "`{useBrick: UseBrickConf }",
7700
- "required": "false",
7701
- "default": "",
7702
- "description": "可以在标题后添加后缀",
7703
- "group": "other"
7704
- },
7705
- {
7706
- "name": "descSuffixBrick",
7707
- "type": "`{useBrick: UseBrickConf }`",
7708
- "required": "false",
7709
- "default": "",
7710
- "description": "可以在描述后面添加后缀",
7711
- "group": "other"
7712
- },
7713
- {
7714
- "name": "dataSource",
7715
- "type": "` Record<string, any>`",
7716
- "required": "false",
7717
- "default": "",
7718
- "description": "数据源",
7719
- "group": "other"
7720
- },
7721
- {
7722
- "name": "fields",
7723
- "type": "` {mainTitle?: string; subTitle?: string; description?: string;}`",
7724
- "required": "false",
7725
- "default": "",
7726
- "description": "字段映射, 跟 dataSource 一起使用来获得运行时 mainTitle、 description",
7727
- "group": "other"
7728
- }
7729
- ],
7730
5484
  "interface": []
7731
5485
  }
7732
5486
  },
@@ -7877,50 +5631,6 @@
7877
5631
  }
7878
5632
  ],
7879
5633
  "dockind": "brick",
7880
- "properties": [
7881
- {
7882
- "name": "flexDirection",
7883
- "type": "string",
7884
- "required": false,
7885
- "description": "定义[flex-direction]:设置主轴方向",
7886
- "group": "basic"
7887
- },
7888
- {
7889
- "name": "justifyContent",
7890
- "type": "string",
7891
- "required": false,
7892
- "description": "定义[justify-content]:设置主轴上子元素的排列方式",
7893
- "group": "basic"
7894
- },
7895
- {
7896
- "name": "alignItems",
7897
- "type": "string",
7898
- "required": false,
7899
- "description": "定义[align-items]:设置侧轴上的子元素排列方式(单行)",
7900
- "group": "basic"
7901
- },
7902
- {
7903
- "name": "alignContent",
7904
- "type": "string",
7905
- "required": false,
7906
- "description": "定义[align-content]:设置侧轴上的子元素排列方式(多行)",
7907
- "group": "basic"
7908
- },
7909
- {
7910
- "name": "flexWrap",
7911
- "type": "string",
7912
- "required": false,
7913
- "description": "定义[flex-wrap]:设置换行方式",
7914
- "group": "basic"
7915
- },
7916
- {
7917
- "name": "gap",
7918
- "type": "string",
7919
- "required": false,
7920
- "description": "定义[gap]:设置元素间隙",
7921
- "group": "basic"
7922
- }
7923
- ],
7924
5634
  "interface": []
7925
5635
  }
7926
5636
  }