king-design-analyzer 2.1.9 → 2.2.1

package/components/transfer.json

@@ -190,6 +190,25 @@
       "payload": [],
       "usageExample": "<Transfer @remove=\"handleRemove\"></Transfer>",
       "handlerExample": "const handleRemove = () => {\n  console.log('数据已移回左侧');\n};"
+    },
+    {
+      "name": "page",
+      "vueEventName": "@page",
+      "description": "启用分页时，左右面板任一侧翻页后触发。",
+      "payload": [
+        {
+          "name": "model",
+          "type": "'left' | 'right'",
+          "description": "触发翻页的面板标识，`left` 表示候选列表，`right` 表示已选列表。"
+        },
+        {
+          "name": "data",
+          "type": "PaginationChangeData",
+          "description": "当前分页变更数据，通常包含页码和每页数量。"
+        }
+      ],
+      "usageExample": "<Transfer :pagination=\"true\" @page=\"handlePage\"></Transfer>",
+      "handlerExample": "const handlePage = (model: 'left' | 'right', data: { value: number; limit: number }) => {\n  console.log(model, data.value, data.limit);\n};"
     }
   ],
   "methods": [
@@ -202,11 +221,11 @@
     {
       "name": "getCheckedData",
       "description": "获取勾选的节点数据",
-      "arguments": [
+      "params": [
         {
-          "name": "type",
+          "name": "model",
           "type": "'left' | 'right'",
-          "description": "指定获取左侧或右侧的勾选数据"
+          "description": "指定读取左侧候选列表或右侧已选列表中的勾选数据。"
         }
       ],
       "returnType": "TransferDataItem[]",
@@ -217,22 +236,69 @@
     {
       "name": "header",
       "description": "自定义整个头部内容",
-      "params": "(type: 'left' | 'right') => Children"
+      "bindingType": "single",
+      "slotProps": [
+        {
+          "name": "type",
+          "type": "'left' | 'right'",
+          "description": "当前面板标识，`left` 表示候选列表，`right` 表示已选列表。"
+        }
+      ],
+      "vueTemplate": "#header=\"type\"",
+      "usageExample": "<Transfer :data=\"data\">\n  <template #header=\"type\">\n    <span>{{ type === 'left' ? '待选列表' : '已选列表' }}</span>\n  </template>\n</Transfer>"
     },
     {
       "name": "filter",
       "description": "自定义检索内容",
-      "params": "(type: 'left' | 'right') => Children"
+      "bindingType": "single",
+      "slotProps": [
+        {
+          "name": "type",
+          "type": "'left' | 'right'",
+          "description": "当前面板标识，`left` 表示候选列表，`right` 表示已选列表。"
+        }
+      ],
+      "vueTemplate": "#filter=\"type\"",
+      "usageExample": "<Transfer :data=\"data\">\n  <template #filter=\"type\">\n    <span>{{ type === 'left' ? '搜索左侧' : '搜索右侧' }}</span>\n  </template>\n</Transfer>"
     },
     {
       "name": "list",
       "description": "自定义整个列表内容",
-      "params": "(type: 'left' | 'right') => Children"
+      "bindingType": "single",
+      "slotProps": [
+        {
+          "name": "type",
+          "type": "'left' | 'right'",
+          "description": "当前面板标识，`left` 表示候选列表，`right` 表示已选列表。"
+        }
+      ],
+      "vueTemplate": "#list=\"type\"",
+      "usageExample": "<Transfer :data=\"data\">\n  <template #list=\"type\">\n    <div>当前面板: {{ type }}</div>\n  </template>\n</Transfer>"
     },
     {
       "name": "label",
-      "description": "自定义每一项的渲染函数，类似于label属性",
-      "params": "(data: TransferDataItem, key: string, type: 'left' | 'right') => Children"
+      "description": "自定义每一项的渲染函数，类似于 label 属性",
+      "bindingType": "array",
+      "slotProps": [
+        {
+          "name": "data",
+          "type": "TransferDataItem",
+          "description": "当前列表项数据",
+          "destructuringExample": "[data]"
+        },
+        {
+          "name": "key",
+          "type": "string | number",
+          "description": "当前列表项在当前面板中的索引或标识"
+        },
+        {
+          "name": "type",
+          "type": "'left' | 'right'",
+          "description": "当前面板标识，`left` 表示候选列表，`right` 表示已选列表。"
+        }
+      ],
+      "vueTemplate": "#label=\"[data, key, type]\"",
+      "usageExample": "<Transfer :data=\"data\">\n  <template #label=\"[data, key, type]\">\n    <span>{{ data.label }} - {{ type }} - {{ key }}</span>\n  </template>\n</Transfer>"
     }
   ],
   "typeDefinitions": [
@@ -240,6 +306,11 @@
       "name": "TransferDataItem",
       "definition": "type TransferDataItem = {\n  key: string | number\n  label?: string\n  disabled?: boolean\n  [key: string]: any\n}",
       "description": "穿梭框数据项类型"
+    },
+    {
+      "name": "PaginationChangeData",
+      "definition": "type PaginationChangeData = {\n  value: number\n  limit: number\n}",
+      "description": "分页变更数据类型，表示当前页码和每页条数。"
     }
   ],
   "examples": [

package/components/tree.json

@@ -231,11 +231,13 @@
     {
       "name": "getCheckedData",
       "description": "获取勾选的节点数据",
-      "arguments": [
+      "params": [
         {
           "name": "leafOnly",
           "type": "boolean",
-          "description": "是否只返回叶子节点，默认 false"
+          "description": "是否只返回叶子节点；传 `true` 时会过滤掉父级节点。",
+          "optional": true,
+          "default": "false"
         }
       ],
       "returnType": "TreeDataItem[]",
@@ -250,7 +252,7 @@
     {
       "name": "expand",
       "description": "展开指定节点",
-      "arguments": [
+      "params": [
         {
           "name": "key",
           "type": "K",
@@ -263,7 +265,7 @@
     {
       "name": "shrink",
       "description": "收起指定节点",
-      "arguments": [
+      "params": [
         {
           "name": "key",
           "type": "K",
@@ -289,7 +291,28 @@
   "slots": [
     {
       "name": "label",
-      "description": "自定义节点渲染内容"
+      "description": "自定义节点渲染内容",
+      "bindingType": "array",
+      "slotProps": [
+        {
+          "name": "data",
+          "type": "TreeDataItem",
+          "description": "当前节点对应的数据项",
+          "destructuringExample": "[data]"
+        },
+        {
+          "name": "node",
+          "type": "TreeNode",
+          "description": "当前树节点实例"
+        },
+        {
+          "name": "index",
+          "type": "number",
+          "description": "当前节点在同级中的索引"
+        }
+      ],
+      "vueTemplate": "#label=\"[data, node, index]\"",
+      "usageExample": "<Tree :data=\"treeData\">\n  <template #label=\"[data, node]\">\n    <span>{{ data.label }}</span>\n    <em v-if=\"node.isLeaf\">叶子</em>\n  </template>\n</Tree>"
     }
   ],
   "typeDefinitions": [