@next-bricks/advanced 0.51.2 → 0.51.4

package/dist/manifest.json

@@ -177,7 +177,7 @@
         },
         {
           "name": "scrollConfigs",
-          "description": "",
+          "description": "表格是否可滚动，也可以指定滚动区域的宽、高，配置项。详见 [scroll](https://ant.design/components/table-cn/#scroll)",
           "default": "{ x: true }",
           "attribute": false,
           "type": "TableProps<unknown>[\"scroll\"]"
@@ -264,6 +264,7 @@
           "name": "page.update",
           "description": "页码变化,pagePath 可在 fields.page 中设置，默认为 page",
           "detail": {
+            "description": "{ page: 当前页码, pageSize: 每页条数 }",
             "type": "Record<string, number>"
           }
         },
@@ -271,6 +272,7 @@
           "name": "filter.update",
           "description": "每页条数变化 ,pagePath 可在 fields.page 中设置,pageSizePath 可在 fields.pageSize 中设置，默认为 pageSize",
           "detail": {
+            "description": "{ page: 当前页码, pageSize: 每页条数 }",
             "type": "Record<string, number>"
           }
         },
@@ -278,6 +280,7 @@
           "name": "select.update",
           "description": "勾选框变化，detail 中为所选的行数据",
           "detail": {
+            "description": "选中的行数据数组",
             "type": "Record<string, any>[]"
           }
         },
@@ -285,6 +288,7 @@
           "name": "select.row.keys.update",
           "description": "勾选框变化，detail 中为所选的行key集合",
           "detail": {
+            "description": "选中的行 key 集合",
             "type": "string[]"
           }
         },
@@ -292,28 +296,32 @@
           "name": "sort.update",
           "description": "排序变化，detail 中的 sort 为对应排序列的 key/dataIndex，order 为升序/降序",
           "detail": {
-            "type": "{\n    sort: string;\n    order: string | number;\n  }"
+            "description": "{ sort: 排序列的 key/dataIndex, order: 升序/降序 }",
+            "type": "SortUpdateEventDetail"
           }
         },
         {
           "name": "row.expand",
           "description": "点击展开图标时触发的事件，事件详情中`expanded`为是否展开，`record`被点击的行信息",
           "detail": {
-            "type": "{\n    expanded: boolean;\n    record: Record<string, any>;\n  }"
+            "description": "{ expanded: 是否展开, record: 被点击的行数据 }",
+            "type": "RowExpandEventDetail"
           }
         },
         {
           "name": "expand.rows.change",
           "description": "展开的行变化时触发的事件，事件详情为当前展开的所有行的`rowKey`集合",
           "detail": {
-            "type": "{\n    expandedRows: React.Key[];\n  }"
+            "description": "{ expandedRows: 当前展开的所有行的 rowKey 集合 }",
+            "type": "ExpandRowsChangeEventDetail"
           }
         },
         {
           "name": "row.drag",
           "description": "表格行拖拽结束发生的事件，事件详情为拖拽后重新排序的所有行数据",
           "detail": {
-            "type": "{\n    data: Record<string, any>[];\n  }"
+            "description": "{ data: 拖拽后重新排序的所有行数据 }",
+            "type": "RowDragEventDetail"
           }
         }
       ],
@@ -324,6 +332,7 @@
           "params": [
             {
               "name": "event",
+              "description": "搜索事件，event.detail.q 为搜索关键词",
               "type": "CustomEvent"
             }
           ],
@@ -352,85 +361,103 @@
       "properties": [
         {
           "name": "name",
+          "description": "表单字段名",
           "type": "string"
         },
         {
           "name": "label",
+          "description": "表单字段标签",
           "type": "string"
         },
         {
           "name": "required",
+          "description": "是否为必填项",
           "type": "boolean"
         },
         {
           "name": "options",
+          "description": "可选项数据源",
           "attribute": false,
           "type": "AntdCascaderProps[\"options\"]"
         },
         {
           "name": "fieldNames",
+          "description": "自定义字段名，指定 label、value、children 对应的字段",
+          "default": "{\n    label: \"label\",\n    value: \"value\",\n    children: \"children\",\n  }",
           "attribute": false,
-          "type": "AntdCascaderProps[\"fieldNames\"]",
-          "default": "{\n    label: \"label\",\n    value: \"value\",\n    children: \"children\",\n  }"
+          "type": "AntdCascaderProps[\"fieldNames\"]"
         },
         {
           "name": "value",
+          "description": "当前选中的值",
           "attribute": false,
           "type": "AntdCascaderProps[\"value\"]"
         },
         {
           "name": "placeholder",
+          "description": "输入框占位文本",
           "type": "string"
         },
         {
           "name": "multiple",
+          "description": "是否支持多选",
           "type": "boolean"
         },
         {
           "name": "disabled",
+          "description": "是否禁用",
           "type": "boolean"
         },
         {
           "name": "allowClear",
-          "type": "boolean",
-          "default": "true"
+          "description": "是否支持清除",
+          "default": "true",
+          "type": "boolean"
         },
         {
           "name": "showSearch",
-          "type": "boolean",
-          "default": "true"
+          "description": "是否支持搜索，开启后可通过输入关键字过滤选项",
+          "default": "true",
+          "type": "boolean"
         },
         {
           "name": "suffixIcon",
+          "description": "自定义下拉箭头图标",
           "attribute": false,
           "type": "GeneralIconProps"
         },
         {
           "name": "expandTrigger",
-          "type": "AntdCascaderProps[\"expandTrigger\"]",
-          "default": "\"click\""
+          "description": "次级菜单的展开方式，可选 click 或 hover",
+          "default": "\"click\"",
+          "type": "AntdCascaderProps[\"expandTrigger\"]"
         },
         {
           "name": "popupPlacement",
-          "type": "AntdCascaderProps[\"placement\"]",
-          "default": "\"bottomLeft\""
+          "description": "浮层预设位置，可选 bottomLeft、bottomRight、topLeft、topRight",
+          "default": "\"bottomLeft\"",
+          "type": "AntdCascaderProps[\"placement\"]"
         },
         {
           "name": "size",
+          "description": "输入框大小，可选 large、middle、small",
           "type": "AntdCascaderProps[\"size\"]"
         },
         {
           "name": "limit",
-          "type": "number",
-          "default": "50"
+          "description": "搜索结果的最大条数，0 表示不限制",
+          "default": "50",
+          "type": "number"
         },
         {
           "name": "maxTagCount",
+          "description": "多选模式下最多显示的 tag 数量，设为 responsive 时会自适应宽度",
           "attribute": false,
           "type": "number | \"responsive\""
         },
         {
           "name": "cascaderStyle",
+          "description": "级联选择器的内联样式",
           "attribute": false,
           "type": "CSSProperties"
         }
@@ -440,8 +467,8 @@
           "name": "cascader.change",
           "description": "",
           "detail": {
-            "description": "{ value: AntdCascaderProps[\"value\"], selectedOptions: DefaultOptionType[] | DefaultOptionType[][] }",
-            "type": "{\n    value: AntdCascaderProps[\"value\"];\n    selectedOptions: DefaultOptionType[] | DefaultOptionType[][];\n  }"
+            "description": "{ value: 选择的值, selectedOptions: 选择的值所对应的 options }",
+            "type": "CascaderChangeEventDetail"
           }
         }
       ],
@@ -468,7 +495,7 @@
         },
         {
           "name": "cell",
-          "description": "单元格",
+          "description": "单元格统一配置，可配置 useBrick 自定义渲染所有单元格及表头",
           "attribute": false,
           "type": "CellConfig"
         },
@@ -599,7 +626,7 @@
           "description": "page 或 pageSize 改变的回调",
           "detail": {
             "description": "改变后的页码及每页条数",
-            "type": "{ page: number; pageSize: number }"
+            "type": "PageOrPageSizeChangeEventDetail"
           }
         },
         {
@@ -608,7 +635,7 @@
           "deprecated": "统一用 `page.change` 事件",
           "detail": {
             "description": "改变后的页码及每页条数",
-            "type": "{\n    page: number;\n    pageSize: number;\n  }"
+            "type": "PageOrPageSizeChangeEventDetail"
           }
         },
         {
@@ -632,7 +659,7 @@
           "description": "行选中项发生变化时的回调",
           "detail": {
             "description": "改变后的 rowKey 及行数据",
-            "type": "{\n    keys: (string | number)[];\n    rows: RecordType[];\n    info: { type: RowSelectMethod };\n  }"
+            "type": "RowSelectEventDetail"
           }
         },
         {
@@ -648,7 +675,7 @@
           "description": "点击展开图标时触发",
           "detail": {
             "description": "当前行的展开情况及数据",
-            "type": "{\n    expanded: boolean;\n    record: RecordType;\n  }"
+            "type": "RowExpandEventDetail"
           }
         },
         {
@@ -664,7 +691,7 @@
           "description": "表格行拖拽结束发生的事件",
           "detail": {
             "description": "重新排序的行数据、拖拽的行数据、放下位置的行数据",
-            "type": "{\n    list: RecordType[];\n    active: RecordType;\n    over: RecordType;\n  }"
+            "type": "RowDragEventDetail"
           }
         }
       ],
@@ -675,6 +702,7 @@
           "params": [
             {
               "name": "params",
+              "description": "搜索参数，q 为搜索关键词",
               "type": "{ q: string }"
             }
           ],
@@ -691,19 +719,23 @@
       "properties": [
         {
           "name": "cardTitle",
+          "description": "编辑模式下左侧卡片列表面板的标题",
           "type": "string"
         },
         {
           "name": "isEdit",
+          "description": "是否进入编辑模式，编辑模式下可拖拽调整布局并显示卡片选择面板",
           "type": "boolean"
         },
         {
           "name": "layouts",
+          "description": "当前布局配置，每项对应一个卡片的位置与大小",
           "attribute": false,
           "type": "Layout[]"
         },
         {
           "name": "componentList",
+          "description": "组件列表，每项包含 key、title、useBrick 和 position 信息",
           "attribute": false,
           "type": "Item[]"
         }
@@ -711,19 +743,25 @@
       "events": [
         {
           "name": "change",
+          "description": "",
           "detail": {
+            "description": "当前布局配置数组",
             "type": "Layout[]"
           }
         },
         {
           "name": "save",
+          "description": "",
           "detail": {
+            "description": "保存时的布局配置数组",
             "type": "Layout[]"
           }
         },
         {
           "name": "cancel",
+          "description": "",
           "detail": {
+            "description": "-",
             "type": "void"
           }
         },
@@ -731,7 +769,7 @@
           "name": "action.click",
           "description": "操作点击事件",
           "detail": {
-            "description": "{\naction: SimpleAction;\nlayouts: Layout[];\n}",
+            "description": "{ action: 点击的操作项, layouts: 当前布局配置数组 }",
             "type": "{\n    action: SimpleAction;\n    layouts: Layout[];\n  }"
           }
         }
@@ -743,88 +781,105 @@
           "params": [
             {
               "name": "layouts",
+              "description": "新的布局配置数组",
               "type": "Layout[]"
             }
-          ]
+          ],
+          "description": "设置布局配置",
+          "returns": {}
         }
       ],
       "parts": [],
-      "description": "工作台布局",
-      "deprecated": "Please use eo-workbench-layout-v2 which support global styles instead"
+      "description": "工作台布局（拖拽式卡片布局，支持编辑模式）",
+      "deprecated": "Please use eo-workbench-layout-v2 which support global styles instead",
+      "category": "layout"
     },
     {
       "name": "eo-workbench-layout-v2",
       "properties": [
         {
           "name": "cardTitle",
+          "description": "编辑模式下左侧卡片列表面板的标题",
           "type": "string"
         },
         {
           "name": "isEdit",
+          "description": "是否进入编辑模式，编辑模式下可拖拽调整布局并显示卡片选择面板",
           "type": "boolean"
         },
         {
           "name": "layouts",
+          "description": "当前布局配置，每项对应一个卡片的位置与大小及样式信息",
           "attribute": false,
           "type": "ExtraLayout[]"
         },
         {
           "name": "toolbarBricks",
+          "description": "编辑模式下工具栏区域的自定义构件",
           "attribute": false,
           "type": "{ useBrick: UseSingleBrickConf[] }"
         },
         {
           "name": "componentList",
+          "description": "组件列表，每项包含 key、title、useBrick 和 position 信息",
           "attribute": false,
           "type": "WorkbenchComponent[]"
         },
         {
           "name": "customDefaultCardConfigMap",
-          "description": "自定义卡片默认配置, 用于覆盖默认卡片配置",
+          "description": "自定义卡片默认配置，用于覆盖默认卡片样式配置",
           "attribute": false,
           "type": "Record<string, CardStyleConfig>"
         },
         {
           "name": "showSettingButton",
-          "description": "description: 用于设置页面样式和布局的按钮",
+          "description": "是否显示设置按钮，用于触发页面样式和布局设置",
           "type": "boolean"
         },
         {
           "name": "gap",
-          "description": "description: 卡片间隔",
+          "description": "卡片之间的间距（px）",
           "type": "number"
         }
       ],
       "events": [
         {
           "name": "change",
+          "description": "",
           "detail": {
+            "description": "当前布局配置数组",
             "type": "ExtraLayout[]"
           }
         },
         {
           "name": "save",
+          "description": "",
           "detail": {
+            "description": "保存时的布局配置数组",
             "type": "ExtraLayout[]"
           }
         },
         {
           "name": "cancel",
+          "description": "",
           "detail": {
+            "description": "-",
             "type": "void"
           }
         },
         {
           "name": "setting",
+          "description": "",
           "detail": {
+            "description": "-",
             "type": "void"
           }
         },
         {
           "name": "action.click",
-          "description": "操作点击事件",
+          "description": "",
           "detail": {
-            "description": "{\naction: SimpleAction;\nlayouts: Layout[];\n}",
+            "description": "{ action: 点击的操作项, layouts: 当前布局配置数组 }",
             "type": "{\n    action: SimpleAction;\n    layouts: Layout[];\n  }"
           }
         }
@@ -836,13 +891,17 @@
           "params": [
             {
               "name": "layouts",
+              "description": "新的布局配置数组",
               "type": "Layout[]"
             }
-          ]
+          ],
+          "description": "设置布局配置",
+          "returns": {}
         }
       ],
       "parts": [],
-      "description": "工作台布局V2, 未使用shadow dom"
+      "description": "工作台布局 V2，支持拖拽式卡片布局与全局样式（不使用 shadow DOM）",
+      "category": "layout"
     },
     {
       "name": "eo-tree",
@@ -937,104 +996,126 @@
       "properties": [
         {
           "name": "name",
+          "description": "表单字段名",
           "type": "string"
         },
         {
           "name": "label",
+          "description": "表单字段标签",
           "type": "string"
         },
         {
           "name": "required",
+          "description": "是否为必填项",
           "type": "boolean"
         },
         {
           "name": "treeData",
+          "description": "树形数据源",
           "attribute": false,
           "type": "AntdTreeSelectProps[\"treeData\"]"
         },
         {
           "name": "treeDefaultExpandAll",
+          "description": "是否默认展开所有树节点",
           "type": "boolean"
         },
         {
           "name": "treeExpandedKeys",
+          "description": "受控展开的树节点 key 集合",
           "attribute": false,
           "type": "string[]"
         },
         {
           "name": "fieldNames",
+          "description": "自定义字段名，指定 label、value、children 对应的字段",
           "attribute": false,
           "type": "AntdTreeSelectProps[\"fieldNames\"]"
         },
         {
           "name": "value",
+          "description": "当前选中的值",
           "attribute": false,
           "type": "AntdTreeSelectProps[\"value\"]"
         },
         {
           "name": "placeholder",
+          "description": "输入框占位文本",
           "type": "string"
         },
         {
           "name": "multiple",
+          "description": "是否支持多选",
           "type": "boolean"
         },
         {
           "name": "disabled",
+          "description": "是否禁用",
           "type": "boolean"
         },
         {
           "name": "checkable",
+          "description": "是否支持勾选树节点（开启后自动开启 multiple 模式）",
           "type": "boolean"
         },
         {
           "name": "allowClear",
-          "type": "boolean",
-          "default": "true"
+          "description": "是否支持清除",
+          "default": "true",
+          "type": "boolean"
         },
         {
           "name": "loading",
-          "type": "boolean",
-          "default": "false"
+          "description": "是否显示加载中状态",
+          "default": "false",
+          "type": "boolean"
         },
         {
           "name": "filterTreeNode",
+          "description": "自定义树节点过滤函数",
           "attribute": false,
           "type": "AntdTreeSelectProps[\"filterTreeNode\"]"
         },
         {
           "name": "showSearch",
-          "type": "boolean",
-          "default": "true"
+          "description": "是否支持搜索，开启后可通过输入关键字过滤树节点",
+          "default": "true",
+          "type": "boolean"
         },
         {
           "name": "suffixIcon",
+          "description": "自定义下拉箭头图标",
           "attribute": false,
           "type": "GeneralIconProps"
         },
         {
           "name": "popupPlacement",
-          "type": "AntdTreeSelectProps[\"placement\"]",
-          "default": "\"bottomLeft\""
+          "description": "浮层预设位置，可选 bottomLeft、bottomRight、topLeft、topRight",
+          "default": "\"bottomLeft\"",
+          "type": "AntdTreeSelectProps[\"placement\"]"
         },
         {
           "name": "size",
+          "description": "输入框大小，可选 large、middle、small",
           "type": "AntdTreeSelectProps[\"size\"]"
         },
         {
           "name": "maxTagCount",
+          "description": "多选模式下最多显示的 tag 数量，设为 responsive 时会自适应宽度",
           "attribute": false,
           "type": "number | \"responsive\""
         },
         {
           "name": "dropdownStyle",
+          "description": "下拉框的样式",
           "attribute": false,
           "type": "CSSProperties"
         },
         {
           "name": "popupMatchSelectWidth",
-          "type": "boolean",
-          "default": "true"
+          "description": "下拉菜单的宽度是否与选择框相同",
+          "default": "true",
+          "type": "boolean"
         }
       ],
       "events": [
@@ -1042,25 +1123,31 @@
           "name": "change",
           "description": "",
           "detail": {
-            "description": "{ value: AntdTreeSelectProps[\"value\"], selectedOptions: DefaultOptionType[] | DefaultOptionType[][] }",
+            "description": "{ value: 选择的值 }",
             "type": "{\n    value: AntdTreeSelectProps[\"value\"];\n  }"
           }
         },
         {
           "name": "search",
+          "description": "",
           "detail": {
+            "description": "搜索关键词",
             "type": "string"
           }
         },
         {
           "name": "select",
+          "description": "",
           "detail": {
+            "description": "{ value: 选中的节点值 }",
             "type": "{ value: AntdTreeSelectProps[\"value\"] }"
           }
         },
         {
           "name": "expand",
+          "description": "",
           "detail": {
+            "description": "{ keys: 展开的节点 key 数组 }",
             "type": "{ keys: React.Key[] }"
           }
         }
@@ -1068,7 +1155,7 @@
       "slots": [],
       "methods": [],
       "parts": [],
-      "description": "树选择器",
+      "description": "树选择器，支持从树形数据中单选或多选节点",
       "category": "form-input-basic"
     },
     {
@@ -1076,13 +1163,13 @@
       "properties": [
         {
           "name": "label",
-          "description": "文案",
+          "description": "显示的文本内容，超出时以省略号截断",
           "default": null,
           "type": "string"
         },
         {
           "name": "lineClamp",
-          "description": "省略行数",
+          "description": "省略的行数，超过该行数后显示省略号，设为 0 表示不省略",
           "default": "1",
           "type": "number"
         }
@@ -1091,25 +1178,30 @@
       "slots": [],
       "methods": [],
       "parts": [],
-      "description": "超出宽度鼠标悬浮显示tooltip\n构件 `eo-text-tooltip`"
+      "description": "文本超出显示区域时，鼠标悬浮显示完整内容的 Tooltip",
+      "category": "display"
     },
     {
       "name": "advanced.pdf-viewer",
       "properties": [
         {
           "name": "url",
+          "description": "PDF 文件的访问地址",
           "type": "string"
         },
         {
           "name": "page",
+          "description": "初始显示的页码（从 1 开始），内部会自动转换为从 0 开始的索引",
           "type": "number"
         },
         {
           "name": "search",
+          "description": "文档加载后自动高亮的搜索关键字",
           "type": "string"
         },
         {
           "name": "viewerStyle",
+          "description": "查看器容器的内联样式，常用于设置高度（如 { height: \"500px\" }）",
           "attribute": false,
           "type": "React.CSSProperties"
         }
@@ -1118,7 +1210,8 @@
       "slots": [],
       "methods": [],
       "parts": [],
-      "description": "构件 `advanced.pdf-viewer`"
+      "description": "PDF 文件预览器，支持分页跳转和关键字高亮搜索",
+      "category": "display"
     }
   ],
   "providers": [