@next-bricks/basic-bricks 1.179.6 → 1.179.9

package/dist/stories.json

@@ -1121,7 +1121,7 @@
       "events": [
         {
           "type": "general.button.click",
-          "detail": "`any`",
+          "detail": "`Record<string, any>`",
           "description": "按钮被点击时触发, detail 为 dataSource 数据"
         }
       ],
@@ -1139,8 +1139,8 @@
           "type": "MenuIcon",
           "required": "false",
           "default": "-",
-          "description": "按钮 icon，支持[icon 图标库](developers/icon)，可直接复制图标图标的配置（antd、fa 及 easyops 三种库都支持），也可只取 icon 字段的值（仅支持 antd 库）。配置{ \"lib\": \"antd\", \"icon\": \"edit\" }与 \"edit\"等价",
-          "group": "basic"
+          "description": "按钮 icon，支持的 [icon 图标库](developers/icon) 和 [MenuIcon配置](/next-docs/docs/api-reference/brick-types.menuicon#menuicon-interface)，另外如果是 antd 图标库可以直接引用图标名称配置 { \"lib\": \"antd\", \"icon\": \"edit\" }与 \"edit\"等价",
+          "group": "ui"
         },
         {
           "name": "buttonUrl",
@@ -1163,14 +1163,14 @@
           "type": "string",
           "required": "false",
           "default": "-",
-          "description": "跳转的 target，例如可以设置为\"\\_blank\"",
+          "description": "跳转的 target，例如可以设置为\"_blank\"",
           "group": "basic"
         },
         {
           "name": "dataSource",
-          "type": "any",
+          "type": "Record<string, any>",
           "required": "false",
-          "default": "`{}`",
+          "default": "{}",
           "description": "替代之前 detail 属性，用法相同。暂存的数据在事件传出时使用",
           "group": "basic"
         },
@@ -1178,7 +1178,7 @@
           "name": "disabled",
           "type": "boolean",
           "required": "false",
-          "default": "`false`",
+          "default": "false",
           "description": "是否禁用按钮",
           "group": "basic"
         },
@@ -1186,8 +1186,9 @@
           "name": "loading",
           "type": "boolean",
           "required": "false",
-          "default": "`false`",
-          "description": "按钮加载动画"
+          "default": "false",
+          "description": "按钮加载动画",
+          "group": "ui"
         },
         {
           "name": "buttonType",
@@ -1195,15 +1196,15 @@
           "required": "false",
           "default": "-",
           "description": "按钮类型  ButtonType(`\"link\" | \"default\" | \"primary\" | \"ghost\" | \"dashed\" | \"danger\" | \"icon\"|\"text\"`)",
-          "group": "basic"
+          "group": "ui"
         },
         {
           "name": "buttonDanger",
           "type": "boolean",
           "required": "false",
-          "default": "`false`",
+          "default": "false",
           "description": "设置危险按钮",
-          "group": "basic"
+          "group": "ui"
         },
         {
           "name": "buttonShape",
@@ -1211,7 +1212,7 @@
           "required": "false",
           "default": "-",
           "description": "按钮形状，支持圆形、椭圆形，不设置为默认方形",
-          "group": "basic"
+          "group": "ui"
         },
         {
           "name": "buttonSize",
@@ -1219,7 +1220,7 @@
           "required": "false",
           "default": "-",
           "description": "按钮大小，支持大、小，不设置为默认中",
-          "group": "basic"
+          "group": "ui"
         },
         {
           "name": "tooltip",
@@ -1249,17 +1250,17 @@
           "name": "fadedText",
           "type": "boolean",
           "required": "false",
-          "default": "`false`",
+          "default": "false",
           "description": "淡化按钮文字，按钮类型为 text 时可以设置。默认 `false` 文字按钮颜色和平台的字体颜色一样，在一些希望弱化文字颜色的场景下可以设置为 `true`。",
-          "group": "advanced"
+          "group": "ui"
         },
         {
           "name": "disableAfterClick",
           "type": "boolean",
           "required": "false",
-          "default": "`false`",
+          "default": "false",
           "description": "点击按钮后自动禁用",
-          "group": "advanced"
+          "group": "basic"
         },
         {
           "name": "buttonProps",
@@ -1267,7 +1268,15 @@
           "required": "-",
           "default": "-",
           "description": "完全透传给 antd 的 Button 属性",
-          "group": "advanced"
+          "group": "basic"
+        },
+        {
+          "name": "buttonStyle",
+          "type": "React.CSSProperties",
+          "required": "-",
+          "default": "-",
+          "description": "适用于按钮某些场景下，需要自定义一些样式",
+          "group": "ui"
         },
         {
           "name": "detail",
@@ -1276,15 +1285,7 @@
           "default": "{}",
           "deprecated": true,
           "description": "[已废弃]按钮点击事件传出的内容。当用于列表类构件，例如 `brick-table` 中，可通过传入传入 `detail` 来识别不通的行进行操作处理。",
-          "group": "advanced"
-        },
-        {
-          "name": "buttonStyle",
-          "type": "React.CSSProperties",
-          "required": "-",
-          "default": "-",
-          "description": "适用于按钮某些场景下，需要自定义一些样式",
-          "group": "advanced"
+          "group": "basic"
         }
       ],
       "interface": [
@@ -1549,7 +1550,7 @@
       {
         "description": {
           "title": "使用footer插槽",
-          "message": "适用于多表单使用，具体场景请参考http://192.168.100.162/next/resource-events/alert-config/inhibition-rule/create"
+          "message": "适用于多表单使用，具体场景请参考 [#1](http://192.168.100.162/next/resource-events/alert-config/inhibition-rule/create)"
         },
         "brick": "forms.general-form",
         "properties": {
@@ -1769,7 +1770,16 @@
           "change": "新增属性 `fillVertical`"
         }
       ],
-      "memo": "```typescript\n export interface OperationButton {\n    // to listen for\n    id: string;\n    eventName: string;\n    configProps: ButtonProps;\n    text?: string;\n   needData?: boolean;\n  }\n  ```",
+      "groupI18N": {
+        "basic": {
+          "en": "Basic",
+          "zh": "常用"
+        },
+        "ui": {
+          "en": "UI",
+          "zh": "外观"
+        }
+      },
       "properties": [
         {
           "name": "cardTitle",
@@ -1785,7 +1795,7 @@
           "required": "false",
           "default": "false",
           "description": "设置该属性后，设置卡片高度为 100%，卡片高度会自动撑满父容器",
-          "group": "basic"
+          "group": "ui"
         },
         {
           "name": "verticalCenter",
@@ -1793,7 +1803,7 @@
           "required": "false",
           "default": "false",
           "description": "设置该属性后，卡片内容区的元素自动垂直居中",
-          "group": "basic"
+          "group": "ui"
         },
         {
           "name": "hasExtraSlot",
@@ -1806,7 +1816,7 @@
         {
           "name": "hasFooter",
           "type": "boolean",
-          "group": "advanced"
+          "group": "basic"
         },
         {
           "name": "isFixedFooter",
@@ -1814,24 +1824,68 @@
           "required": "false",
           "default": "true",
           "description": "footer滚动到窗口外时，是否需要将footer固定在窗口底部",
-          "group": "advanced"
+          "group": "basic"
         },
         {
-          "name": "configProps",
-          "type": "map",
+          "name": "operationButtons",
+          "type": "OperationButton[]",
           "required": "false",
           "default": "-",
-          "description": "完全透传给 antd 的 Card 属性，详见：[https://ant.design/components/card-cn/#Card](https://ant.design/components/card-cn/#Card)"
+          "description": "右上角的操作按钮列表，可自定义指定该按钮的名字，按钮点击后发出的事件等"
         },
         {
-          "name": "operationButtons",
-          "type": "OperationButton[]",
+          "name": "configProps",
+          "type": "map",
           "required": "false",
           "default": "-",
-          "description": "右上角的操作按钮列表，可自定义指定该按钮的名字，并配置该按钮点击后发出的事件，在 storyboard 去监听该事件传给目标"
+          "description": "完全透传给 antd 的 Card 属性，详见：[Card](https://ant.design/components/card-cn/#Card)"
         }
       ],
-      "interface": []
+      "interface": [
+        {
+          "name": "OperationButton",
+          "typeParameter": null,
+          "kind": "interface",
+          "children": [
+            {
+              "name": "configProps",
+              "type": "ButtonProps & object",
+              "required": true,
+              "description": ""
+            },
+            {
+              "name": "eventName",
+              "type": "string",
+              "required": true,
+              "description": ""
+            },
+            {
+              "name": "id",
+              "type": "string",
+              "required": true,
+              "description": ""
+            },
+            {
+              "name": "needData",
+              "type": "boolean",
+              "required": false,
+              "description": ""
+            },
+            {
+              "name": "text",
+              "type": "string",
+              "required": false,
+              "description": ""
+            },
+            {
+              "name": "tooltip",
+              "type": "string",
+              "required": false,
+              "description": ""
+            }
+          ]
+        }
+      ]
     }
   },
   {
@@ -4555,7 +4609,7 @@
       "author": "steve",
       "slots": null,
       "history": null,
-      "memo": "### interface\n```typescript\n  interface ResponsiveSettings {\n  large?: GridSettings;\n  medium?: GridSettings;\n  small?: GridSettings;\n  xSmall?: GridSettings;\n  }\n\n interface GridSettings {\n columns?: number;\n rows?: number;\n columnSpan?: number;\n rowSpan?: number;\n }\n```\n### 响应式布局说明\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` 时显示两列，更小的屏幕显示为一列。",
+      "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` 时显示两列，更小的屏幕显示为一列。",
       "properties": [
         {
           "name": "columns",
@@ -4594,7 +4648,76 @@
           "description": "响应式布局设置"
         }
       ],
-      "interface": []
+      "interface": [
+        {
+          "name": "ResponsiveSettings",
+          "typeParameter": null,
+          "kind": "interface",
+          "children": [
+            {
+              "name": "large",
+              "type": "GridSettings",
+              "required": false,
+              "description": ""
+            },
+            {
+              "name": "medium",
+              "type": "GridSettings",
+              "required": false,
+              "description": ""
+            },
+            {
+              "name": "small",
+              "type": "GridSettings",
+              "required": false,
+              "description": ""
+            },
+            {
+              "name": "xSmall",
+              "type": "GridSettings",
+              "required": false,
+              "description": ""
+            }
+          ]
+        },
+        {
+          "name": "GridSettings",
+          "typeParameter": null,
+          "kind": "interface",
+          "children": [
+            {
+              "name": "columnSpan",
+              "type": "number",
+              "required": false,
+              "description": ""
+            },
+            {
+              "name": "columns",
+              "type": "number",
+              "required": false,
+              "description": ""
+            },
+            {
+              "name": "rowSpan",
+              "type": "number",
+              "required": false,
+              "description": ""
+            },
+            {
+              "name": "rows",
+              "type": "number",
+              "required": false,
+              "description": ""
+            },
+            {
+              "name": "templateColumns",
+              "type": "string",
+              "required": false,
+              "description": ""
+            }
+          ]
+        }
+      ]
     }
   },
   {
@@ -5328,6 +5451,16 @@
           "change": "新增 bannerPageTitle、bannerStyle 属性，banner、bannerTitleBar、bannerToolbar 插槽"
         }
       ],
+      "groupI18N": {
+        "basic": {
+          "zh": "常用",
+          "en": "Basic"
+        },
+        "ui": {
+          "zh": "外观",
+          "en": "UI"
+        }
+      },
       "memo": "",
       "properties": [
         {
@@ -5338,86 +5471,56 @@
           "description": "设置标题。如果要使用复杂的标题构件，请使用插槽 `titleBar`",
           "group": "basic"
         },
+        {
+          "name": "bannerPageTitle",
+          "type": "string",
+          "required": "-",
+          "default": "-",
+          "description": "设置 banner 标题。如果要使用复杂的标题构件，请使用插槽 `bannerTitleBar`",
+          "group": "basic"
+        },
         {
           "name": "overflowXAuto",
           "type": "boolean",
           "required": "-",
-          "default": "`false`",
+          "default": "false",
           "description": "内容区是否需要设置`overflow-x: auto`",
-          "group": "basic"
+          "group": "ui"
         },
         {
           "name": "noGap",
           "type": "boolean",
           "required": "-",
-          "default": "`false`",
+          "default": "false",
           "description": "内容区默认为 grid 布局且有默认的 gap，设为 `true` 则使之没有 gap。",
-          "group": "basic"
+          "group": "ui"
         },
         {
           "name": "dashboardMode",
           "type": "boolean",
-          "default": "`false`",
+          "default": "false",
           "description": "是否启用大屏模式。",
-          "group": "basic"
+          "group": "ui"
+        },
+        {
+          "name": "pageTitleScale",
+          "type": "number",
+          "description": "标题栏大小比例，默认为 1，仅用于暗黑大屏模式。",
+          "group": "ui"
         },
         {
           "name": "hideToolbar",
           "type": "boolean",
-          "default": "`false`",
+          "default": "false",
           "description": "是否隐藏工具栏（常用语大屏模式）。",
-          "group": "basic"
-        },
-        {
-          "name": "bannerPageTitle",
-          "type": "string",
-          "required": "-",
-          "default": "-",
-          "description": "设置 banner 标题。如果要使用复杂的标题构件，请使用插槽 `bannerTitleBar`",
-          "group": "advanced"
+          "group": "ui"
         },
         {
           "name": "bannerStyle",
           "type": "CSSProperties",
           "default": "-",
           "description": "banner 的样式",
-          "group": "advanced"
-        },
-        {
-          "name": "hasSubMenu",
-          "type": "boolean",
-          "group": "advanced"
-        },
-        {
-          "name": "hasTitleBar",
-          "type": "boolean",
-          "group": "advanced"
-        },
-        {
-          "name": "hasToolbar",
-          "type": "boolean",
-          "group": "advanced"
-        },
-        {
-          "name": "hasBanner",
-          "type": "boolean",
-          "group": "advanced"
-        },
-        {
-          "name": "hasBannerTitleBar",
-          "type": "boolean",
-          "group": "advanced"
-        },
-        {
-          "name": "hasBannerToolbar",
-          "type": "boolean",
-          "group": "advanced"
-        },
-        {
-          "name": "pageTitleScale",
-          "type": "number",
-          "description": "标题栏大小比例，默认为 1，仅用于暗黑大屏模式。",
-          "group": "advanced"
+          "group": "ui"
         }
       ],
       "interface": []

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@next-bricks/basic-bricks",
-  "version": "1.179.6",
+  "version": "1.179.9",
   "description": "> TODO: description",
   "homepage": "https://github.com/easyops-cn/next-basics/tree/master/bricks/basic-bricks",
   "license": "GPL-3.0",
@@ -39,5 +39,5 @@
     "immutability-helper": "^3.1.1"
   },
   "sideEffects": true,
-  "gitHead": "77827e88044adc541963a1ae3b6edb5a71ac0d51"
+  "gitHead": "13e7bcee639a97612e1227b7ffb5287c78cbe522"
 }