@next-bricks/basic-bricks 1.181.0 → 1.182.2

package/dist/stories.json

@@ -272,7 +272,9 @@
         },
         {
           "name": "selectable",
-          "type": "boolean"
+          "type": "boolean",
+          "required": true,
+          "default": "true"
         }
       ],
       "interface": []
@@ -455,36 +457,42 @@
         {
           "name": "gridAreas",
           "type": "Record<string, (string | number)[]>",
+          "required": true,
           "description": "以键值对形式定义多个 [grid-area](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-area)",
           "group": "basic"
         },
         {
           "name": "gridTemplateAreas",
           "type": "string[][]",
+          "required": true,
           "description": "定义 [grid-template-areas](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-areas)",
           "group": "basic"
         },
         {
           "name": "gridTemplateColumns",
           "type": "string | string[]",
+          "required": true,
           "description": "定义 [grid-template-columns](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-columns)",
           "group": "basic"
         },
         {
           "name": "gridTemplateRows",
           "type": "string | string[]",
+          "required": true,
           "description": "定义 [grid-template-rows](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-rows)",
           "group": "basic"
         },
         {
           "name": "containerStyle",
           "type": "CSSProperties",
+          "required": true,
           "description": "定义网格容器的样式",
           "group": "ui"
         },
         {
           "name": "styleByAreas",
           "type": "Record<string, CSSProperties>",
+          "required": true,
           "description": "定义网格内各区域的样式",
           "group": "ui"
         }
@@ -743,19 +751,23 @@
       "properties": [
         {
           "name": "useBrick",
-          "type": "UseBrickConf"
+          "type": "UseBrickConf",
+          "required": true
         },
         {
           "name": "foldName",
-          "type": "string"
+          "type": "string",
+          "required": true
         },
         {
           "name": "foldStyle",
-          "type": "Record<string, string>"
+          "type": "Record<string, string>",
+          "required": true
         },
         {
           "name": "defaultShow",
-          "type": "boolean"
+          "type": "boolean",
+          "required": false
         }
       ],
       "interface": []
@@ -1804,6 +1816,7 @@
         {
           "name": "hasFooter",
           "type": "boolean",
+          "required": true,
           "group": "basic"
         },
         {
@@ -1837,7 +1850,7 @@
           "children": [
             {
               "name": "configProps",
-              "type": "ButtonProps & object",
+              "type": "ButtonProps & { icon?: string; }",
               "required": true,
               "description": ""
             },
@@ -2952,6 +2965,7 @@
       "methods": [
         {
           "name": "updateButton",
+          "params": "id: string btn: Partial<CustomButton>",
           "description": "更新按钮"
         }
       ],
@@ -3500,8 +3514,8 @@
         {
           "name": "isFloat",
           "type": "boolean",
-          "default": "false",
           "required": "false",
+          "default": "false",
           "description": "是否浮层样式，如果设为true,则抽屉边缘会有外边距，圆角和阴影",
           "group": "ui"
         },
@@ -3537,14 +3551,17 @@
       "methods": [
         {
           "name": "bodyScroll",
+          "params": "top: number",
           "description": "抽屉内部内容上下滚动"
         },
         {
           "name": "close",
+          "params": "option?: OpenCloseOption",
           "description": "显示抽屉构件"
         },
         {
           "name": "open",
+          "params": "option?: OpenCloseOption",
           "description": "显示抽屉构件"
         }
       ],
@@ -3553,6 +3570,7 @@
           "name": "ICustomSwitchConfig",
           "typeParameter": null,
           "kind": "interface",
+          "description": "文字和图标只会显示其中一个，优先显示图标，文字最多显示4个字符。",
           "children": [
             {
               "name": "closeIcon",
@@ -3586,6 +3604,20 @@
             }
           ],
           "indexSignature": []
+        },
+        {
+          "name": "OpenCloseOption",
+          "typeParameter": null,
+          "kind": "interface",
+          "children": [
+            {
+              "name": "noEvent",
+              "type": "boolean",
+              "required": false,
+              "description": ""
+            }
+          ],
+          "indexSignature": []
         }
       ]
     }
@@ -4056,6 +4088,7 @@
         },
         {
           "type": "modal.open",
+          "detail": "Record<string, any>",
           "description": "打开 modal 时发出该事件"
         }
       ],
@@ -4143,6 +4176,7 @@
         {
           "name": "fullscreen",
           "type": "boolean",
+          "required": false,
           "default": "false",
           "description": "全屏模式",
           "group": "ui"
@@ -4230,9 +4264,9 @@
         {
           "name": "fields",
           "type": "{modalTitle: string}",
-          "deprecated": true,
           "required": "false",
           "default": "-",
+          "deprecated": true,
           "description": "`已废弃` 字段映射, 跟 dataSource 一起使用来获得运行时 modalTitle",
           "group": "other"
         }
@@ -4245,10 +4279,26 @@
         },
         {
           "name": "open",
+          "params": "option?: OpenCloseOption",
           "description": "弹出模态框"
         }
       ],
-      "interface": []
+      "interface": [
+        {
+          "name": "OpenCloseOption",
+          "typeParameter": null,
+          "kind": "interface",
+          "children": [
+            {
+              "name": "noEvent",
+              "type": "boolean",
+              "required": false,
+              "description": ""
+            }
+          ],
+          "indexSignature": []
+        }
+      ]
     }
   },
   {
@@ -4385,7 +4435,7 @@
         },
         {
           "name": "iconStyle",
-          "type": "[React.CSSProperties](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/e434515761b36830c3e58a970abf5186f005adac/types/react/index.d.ts#L794)",
+          "type": "CSSProperties",
           "required": "false",
           "default": "-",
           "description": "icon css 样式",
@@ -4612,36 +4662,42 @@
         {
           "name": "columns",
           "type": "number",
+          "required": false,
           "default": "-",
           "description": "网格布局列数（各列等宽）"
         },
         {
           "name": "columnSpan",
           "type": "number",
+          "required": false,
           "default": "auto",
           "description": "自己在父级网格中所占列数"
         },
         {
           "name": "rows",
           "type": "number",
+          "required": false,
           "default": "1",
           "description": "网格布局行数，通常不需设置，各行高度由内容决定。设置为 > 1 时，各行高度相同。"
         },
         {
           "name": "rowSpan",
           "type": "number",
+          "required": false,
           "default": "1",
           "description": "自己在父级网格中所占行数"
         },
         {
           "name": "templateColumns",
           "type": "string",
+          "required": false,
           "default": "-",
           "description": "网格布局模板列，即 CSS 的 gridTemplateColumns，优先于 `columns`。"
         },
         {
           "name": "responsive",
           "type": "ResponsiveSettings",
+          "required": false,
           "default": "1",
           "description": "响应式布局设置"
         }
@@ -4842,14 +4898,14 @@
         {
           "name": "contentGridGap",
           "type": "number",
-          "required": "no",
+          "required": "false",
           "default": "24",
           "description": "内容区的 gap，内容区固定为 grid 布局"
         },
         {
           "name": "title",
           "type": "string",
-          "required": "no",
+          "required": "false",
           "default": "-",
           "description": "卡片标题"
         }
@@ -4950,6 +5006,7 @@
         {
           "name": "gap",
           "type": "string | number",
+          "required": false,
           "default": "\"var(--card-content-gap)\"",
           "description": "间距(配合extraContainerStyle使用)",
           "group": "ui"
@@ -4957,6 +5014,7 @@
         {
           "name": "extraContainerStyle",
           "type": "Record<string, any>",
+          "required": false,
           "default": "-",
           "description": "容器本身默认是 grid 布局，可以设置额外的样式。",
           "group": "ui"
@@ -4964,6 +5022,7 @@
         {
           "name": "containerStyle",
           "type": "Record<string, any>",
+          "required": false,
           "default": "-",
           "description": "自定义容器的样式，容器本身默认是 grid 布局，如果`containerStyle`不为空则覆盖掉容器本身的样式配置",
           "group": "ui"
@@ -5478,6 +5537,7 @@
         {
           "name": "dashboardMode",
           "type": "boolean",
+          "required": true,
           "default": "false",
           "description": "是否启用大屏模式。",
           "group": "ui"
@@ -5485,12 +5545,14 @@
         {
           "name": "pageTitleScale",
           "type": "number",
+          "required": false,
           "description": "标题栏大小比例，默认为 1，仅用于暗黑大屏模式。",
           "group": "ui"
         },
         {
           "name": "hideToolbar",
           "type": "boolean",
+          "required": true,
           "default": "false",
           "description": "是否隐藏工具栏（常用语大屏模式）。",
           "group": "ui"
@@ -5498,6 +5560,7 @@
         {
           "name": "bannerStyle",
           "type": "CSSProperties",
+          "required": false,
           "default": "-",
           "description": "banner 的样式",
           "group": "ui"
@@ -5812,6 +5875,7 @@
         {
           "name": "dashboardMode",
           "type": "boolean",
+          "required": false,
           "default": "false",
           "description": "是否以 dashboard 模式显示",
           "group": "basic"
@@ -7573,8 +7637,8 @@
         {
           "name": "disabledJump",
           "type": "boolean",
-          "default": "false",
           "required": "false",
+          "default": "false",
           "description": "禁用默认跳转事件"
         }
       ],
@@ -7839,26 +7903,31 @@
         {
           "name": "flexDirection",
           "type": "string",
+          "required": false,
           "description": "定义[flex-direction]:设置主轴方向"
         },
         {
           "name": "justifyContent",
           "type": "string",
+          "required": false,
           "description": "定义[justify-content]:设置主轴上子元素的排列方式"
         },
         {
           "name": "alignItems",
           "type": "string",
+          "required": false,
           "description": "定义[align-items]:设置侧轴上的子元素排列方式（单行）"
         },
         {
           "name": "alignContent",
           "type": "string",
+          "required": false,
           "description": "定义[align-content]:设置侧轴上的子元素排列方式（多行）"
         },
         {
           "name": "flexWrap",
           "type": "string",
+          "required": false,
           "description": "定义[flex-wrap]:设置换行方式"
         }
       ],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@next-bricks/basic-bricks",
-  "version": "1.181.0",
+  "version": "1.182.2",
   "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": "8dcc3cbbfdd646830ec9a74fcd52fb28c0b66b9e"
+  "gitHead": "d528e5fe6f82aed0db9e186c12e1a53838478730"
 }