king-design-analyzer 1.1.0 → 2.0.1

package/components/affix.json

@@ -1,178 +1,178 @@
 {
-    "id": "affix",
-    "name": "Affix",
-    "displayName": "图钉",
-    "category": "navigation",
-    "description": "将页面元素固定在可视窗口的某个位置。常用于侧边菜单、侧边导航等。",
-    "importStatement": "import { Affix } from '@king-design/vue';",
-    "props": [
+  "id": "affix",
+  "name": "Affix",
+  "displayName": "图钉",
+  "category": "navigation",
+  "description": "将页面元素固定在可视窗口的某个位置。常用于侧边菜单、侧边导航等。",
+  "importStatement": "import { Affix } from '@king-design/vue';",
+  "props": [
+    {
+      "name": "top",
+      "description": "距离窗口顶部的偏移量，设置为 undefined 则不生效",
+      "type": {
+        "raw": "number",
+        "kind": "number"
+      },
+      "required": false,
+      "default": "undefined",
+      "usageExample": "<Affix :top=\"100\"></Affix>"
+    },
+    {
+      "name": "bottom",
+      "description": "距离窗口底部的偏移量，设置为 undefined 则不生效",
+      "type": {
+        "raw": "number",
+        "kind": "number"
+      },
+      "required": false,
+      "default": "undefined",
+      "usageExample": "<Affix :bottom=\"50\"></Affix>"
+    },
+    {
+      "name": "shouldFix",
+      "description": "自定义是否需要固定的函数，返回 boolean",
+      "type": {
+        "raw": "Function",
+        "kind": "function"
+      },
+      "required": false,
+      "default": "undefined",
+      "usageExample": "<Affix :shouldFix=\"checkFix\"></Affix>"
+    },
+    {
+      "name": "exclude",
+      "description": "自定义排除固定的函数，返回 boolean 表示不固定",
+      "type": {
+        "raw": "Function",
+        "kind": "function"
+      },
+      "required": false,
+      "default": "undefined",
+      "usageExample": "<Affix :exclude=\"checkExclude\"></Affix>"
+    },
+    {
+      "name": "disabled",
+      "description": "是否禁用固定功能",
+      "type": {
+        "raw": "boolean",
+        "kind": "boolean"
+      },
+      "required": false,
+      "default": "false",
+      "usageExample": "<Affix disabled></Affix>"
+    }
+  ],
+  "events": [
+    {
+      "name": "change",
+      "description": "固定状态改变时触发",
+      "params": [
         {
-            "name": "top",
-            "description": "距离窗口顶部的偏移量，设置为 undefined 则不生效",
-            "type": {
-                "raw": "number",
-                "kind": "number"
-            },
-            "required": false,
-            "default": "undefined",
-            "usageExample": "<Affix :top=\"100\">"
-        },
-        {
-            "name": "bottom",
-            "description": "距离窗口底部的偏移量，设置为 undefined 则不生效",
-            "type": {
-                "raw": "number",
-                "kind": "number"
-            },
-            "required": false,
-            "default": "undefined",
-            "usageExample": "<Affix :bottom=\"50\">"
-        },
-        {
-            "name": "shouldFix",
-            "description": "自定义是否需要固定的函数，返回 boolean",
-            "type": {
-                "raw": "Function",
-                "kind": "function"
-            },
-            "required": false,
-            "default": "undefined",
-            "usageExample": "<Affix :shouldFix=\"checkFix\">"
-        },
-        {
-            "name": "exclude",
-            "description": "自定义排除固定的函数，返回 boolean 表示不固定",
-            "type": {
-                "raw": "Function",
-                "kind": "function"
-            },
-            "required": false,
-            "default": "undefined",
-            "usageExample": "<Affix :exclude=\"checkExclude\">"
-        },
-        {
-            "name": "disabled",
-            "description": "是否禁用固定功能",
-            "type": {
-                "raw": "boolean",
-                "kind": "boolean"
-            },
-            "required": false,
-            "default": "false",
-            "usageExample": "<Affix disabled>"
-        }
-    ],
-    "events": [
-        {
-            "name": "change",
-            "description": "固定状态改变时触发",
-            "params": [
-                {
-                    "name": "isFixed",
-                    "type": "boolean",
-                    "description": "当前是否处于固定状态"
-                }
-            ],
-            "usageExample": "<Affix @change=\"handleChange\">"
-        }
-    ],
-    "methods": [],
-    "slots": [
-        {
-            "name": "default",
-            "description": "需要被固定的元素",
-            "vueTemplate": "#default",
-            "usageExample": "<Affix><Button>Fixed Button</Button></Affix>"
-        }
-    ],
-    "examples": [
-        {
-            "id": "affix_top",
-            "title": "固定在顶部",
-            "description": "设置 distance-top",
-            "difficulty": "easy",
-            "code": "<script setup lang=\"ts\">\nimport { Affix, Button } from '@king-design/vue';\n</script>\n<template>\n  <Affix :top=\"10\">\n    <Button type=\"primary\">距离顶部 10px 固定</Button>\n  </Affix>\n</template>",
-            "tags": [
-                "top",
-                "basic"
-            ],
-            "usedProps": [
-                "top"
-            ],
-            "usedEvents": [],
-            "usedSlots": [
-                "default"
-            ],
-            "usedMethods": [],
-            "scenario": "将导航或工具栏固定在页面顶部"
-        },
-        {
-            "id": "affix_bottom",
-            "title": "固定在底部",
-            "description": "设置 distance-bottom",
-            "difficulty": "easy",
-            "code": "<script setup lang=\"ts\">\nimport { Affix, Button } from '@king-design/vue';\n</script>\n<template>\n  <Affix :bottom=\"10\">\n    <Button type=\"primary\">距离底部 10px 固定</Button>\n  </Affix>\n</template>",
-            "tags": [
-                "bottom",
-                "basic"
-            ],
-            "usedProps": [
-                "bottom"
-            ],
-            "usedEvents": [],
-            "usedSlots": [
-                "default"
-            ],
-            "usedMethods": [],
-            "scenario": "将帮助按钮或操作栏固定在页面底部"
-        },
-        {
-            "id": "affix_change",
-            "title": "监听状态改变",
-            "description": "监听 change 事件获取固定状态",
-            "difficulty": "medium",
-            "code": "<script setup lang=\"ts\">\nimport { Affix, Button } from '@king-design/vue';\n\nconst onChange = (isFixed: boolean) => {\n  console.log('Fixed state:', isFixed);\n};\n</script>\n<template>\n  <Affix :top=\"100\" @change=\"onChange\">\n    <Button>滚动页面触发固定</Button>\n  </Affix>\n</template>",
-            "tags": [
-                "event",
-                "change"
-            ],
-            "usedProps": [
-                "top"
-            ],
-            "usedEvents": [
-                "change"
-            ],
-            "usedSlots": [
-                "default"
-            ],
-            "usedMethods": [],
-            "scenario": "根据固定状态改变样式"
-        }
-    ],
-    "commonMistakes": [
-        {
-            "id": "affix_container_scroll",
-            "description": "父容器滚动问题",
-            "wrongCode": "<div style=\"overflow: auto; height: 200px;\">\n  <Affix :top=\"10\">...</Affix>\n</div>",
-            "correctCode": "<!-- Affix 默认基于 window 滚动，如果需要在特定容器内滚动固定，Affix实现可能不支持或需要特殊配置，通常 Affix基于 window -->",
-            "explanation": "Affix 一般是基于 window 滚动的，如果放在有 overflow 滚动的这容器内，可能 won't work expectedly。目前组件文档未明确支持 target 容器，需注意。",
-            "relatedProps": []
+          "name": "isFixed",
+          "type": "boolean",
+          "description": "当前是否处于固定状态"
         }
-    ],
-    "searchKeywords": [
-        "图钉",
-        "affix",
-        "fix",
-        "sticky",
-        "固定",
-        "顶部",
-        "底部"
-    ],
-    "useCases": [
-        "侧边导航栏固定",
-        "顶部工具栏固定",
-        "底部操作栏固定",
-        "悬浮按钮"
-    ],
-    "relatedComponents": []
-}
+      ],
+      "usageExample": "<Affix @change=\"handleChange\"></Affix>"
+    }
+  ],
+  "methods": [],
+  "slots": [
+    {
+      "name": "default",
+      "description": "需要被固定的元素",
+      "vueTemplate": "#default",
+      "usageExample": "<Affix><Button>Fixed Button</Button></Affix>"
+    }
+  ],
+  "examples": [
+    {
+      "id": "affix_top",
+      "title": "固定在顶部",
+      "description": "设置 distance-top",
+      "difficulty": "easy",
+      "code": "<script setup lang=\"ts\">\nimport { Affix, Button } from '@king-design/vue';\n</script>\n<template>\n  <Affix :top=\"10\">\n    <Button type=\"primary\">距离顶部 10px 固定</Button>\n  </Affix>\n</template>",
+      "tags": [
+        "top",
+        "basic"
+      ],
+      "usedProps": [
+        "top"
+      ],
+      "usedEvents": [],
+      "usedSlots": [
+        "default"
+      ],
+      "usedMethods": [],
+      "scenario": "将导航或工具栏固定在页面顶部"
+    },
+    {
+      "id": "affix_bottom",
+      "title": "固定在底部",
+      "description": "设置 distance-bottom",
+      "difficulty": "easy",
+      "code": "<script setup lang=\"ts\">\nimport { Affix, Button } from '@king-design/vue';\n</script>\n<template>\n  <Affix :bottom=\"10\">\n    <Button type=\"primary\">距离底部 10px 固定</Button>\n  </Affix>\n</template>",
+      "tags": [
+        "bottom",
+        "basic"
+      ],
+      "usedProps": [
+        "bottom"
+      ],
+      "usedEvents": [],
+      "usedSlots": [
+        "default"
+      ],
+      "usedMethods": [],
+      "scenario": "将帮助按钮或操作栏固定在页面底部"
+    },
+    {
+      "id": "affix_change",
+      "title": "监听状态改变",
+      "description": "监听 change 事件获取固定状态",
+      "difficulty": "medium",
+      "code": "<script setup lang=\"ts\">\nimport { Affix, Button } from '@king-design/vue';\n\nconst onChange = (isFixed: boolean) => {\n  console.log('Fixed state:', isFixed);\n};\n</script>\n<template>\n  <Affix :top=\"100\" @change=\"onChange\">\n    <Button>滚动页面触发固定</Button>\n  </Affix>\n</template>",
+      "tags": [
+        "event",
+        "change"
+      ],
+      "usedProps": [
+        "top"
+      ],
+      "usedEvents": [
+        "change"
+      ],
+      "usedSlots": [
+        "default"
+      ],
+      "usedMethods": [],
+      "scenario": "根据固定状态改变样式"
+    }
+  ],
+  "commonMistakes": [
+    {
+      "id": "affix_container_scroll",
+      "description": "父容器滚动问题",
+      "wrongCode": "<div style=\"overflow: auto; height: 200px;\">\n  <Affix :top=\"10\">...</Affix>\n</div>",
+      "correctCode": "<!-- Affix 默认基于 window 滚动，如果需要在特定容器内滚动固定，Affix实现可能不支持或需要特殊配置，通常 Affix基于 window -->",
+      "explanation": "Affix 一般是基于 window 滚动的，如果放在有 overflow 滚动的这容器内，可能 won't work expectedly。目前组件文档未明确支持 target 容器，需注意。",
+      "relatedProps": []
+    }
+  ],
+  "searchKeywords": [
+    "图钉",
+    "affix",
+    "fix",
+    "sticky",
+    "固定",
+    "顶部",
+    "底部"
+  ],
+  "useCases": [
+    "侧边导航栏固定",
+    "顶部工具栏固定",
+    "底部操作栏固定",
+    "悬浮按钮"
+  ],
+  "relatedComponents": []
+}

package/components/az.json

@@ -1,86 +1,86 @@
 {
-    "id": "az",
-    "name": "AZ",
-    "displayName": "可用区选择",
-    "category": "form",
-    "description": "可用区（Availability Zone）选择组件。",
-    "importStatement": "import { AZ } from '@ksyun-internal/versatile';",
-    "props": [
+  "id": "az",
+  "name": "AZ",
+  "displayName": "可用区选择",
+  "category": "form",
+  "description": "可用区（Availability Zone）选择组件。",
+  "importStatement": "import { AZ } from '@ksyun-internal/versatile';",
+  "props": [
+    {
+      "name": "modelValue",
+      "description": "选中的可用区编码",
+      "type": {
+        "raw": "string",
+        "kind": "string"
+      },
+      "required": false,
+      "usageExample": "<AZ v-model=\"azCode\" />"
+    },
+    {
+      "name": "regionCode",
+      "description": "所属地域编码",
+      "type": {
+        "raw": "string",
+        "kind": "string"
+      },
+      "required": false,
+      "usageExample": "<AZ regionCode=\"cn-beijing-6\" />"
+    },
+    {
+      "name": "packages",
+      "description": "可用区配置列表（通常从Region组件联动获取，或通过API获取）",
+      "type": {
+        "raw": "AZ[]",
+        "kind": "array"
+      },
+      "required": false,
+      "usageExample": "<AZ :packages=\"packages\" />"
+    },
+    {
+      "name": "showLearnMore",
+      "description": "是否显示了解更多",
+      "type": {
+        "raw": "boolean",
+        "kind": "boolean"
+      },
+      "required": false,
+      "default": "true"
+    },
+    {
+      "name": "learnMoreUrl",
+      "description": "了解更多链接ID",
+      "type": {
+        "raw": "number",
+        "kind": "number"
+      },
+      "required": false
+    }
+  ],
+  "events": [
+    {
+      "name": "change",
+      "vueEventName": "update:modelValue",
+      "description": "可用区改变时触发",
+      "payload": [
         {
-            "name": "modelValue",
-            "description": "选中的可用区编码",
-            "type": {
-                "raw": "string",
-                "kind": "string"
-            },
-            "required": false,
-            "usageExample": "<AZ v-model=\"azCode\" />"
-        },
-        {
-            "name": "regionCode",
-            "description": "所属地域编码",
-            "type": {
-                "raw": "string",
-                "kind": "string"
-            },
-            "required": false,
-            "usageExample": "<AZ regionCode=\"cn-beijing-6\" />"
-        },
-        {
-            "name": "packages",
-            "description": "可用区配置列表（通常从Region组件联动获取，或通过API获取）",
-            "type": {
-                "raw": "AZ[]",
-                "kind": "array"
-            },
-            "required": false,
-            "usageExample": "<AZ :packages=\"packages\" />"
-        },
-        {
-            "name": "showLearnMore",
-            "description": "是否显示了解更多",
-            "type": {
-                "raw": "boolean",
-                "kind": "boolean"
-            },
-            "required": false,
-            "default": "true"
-        },
-        {
-            "name": "learnMoreUrl",
-            "description": "了解更多链接ID",
-            "type": {
-                "raw": "number",
-                "kind": "number"
-            },
-            "required": false
-        }
-    ],
-    "events": [
-        {
-            "name": "change",
-            "vueEventName": "update:modelValue",
-            "description": "可用区改变时触发",
-            "payload": [
-                {
-                    "name": "value",
-                    "type": "string",
-                    "description": "新的AZCode"
-                }
-            ],
-            "usageExample": "<AZ @update:modelValue=\"v => console.log(v)\" />",
-            "handlerExample": "(val) => { console.log(val); }"
+          "name": "value",
+          "type": "string",
+          "description": "新的AZCode"
         }
-    ],
-    "methods": [],
-    "examples": [],
-    "searchKeywords": [
-        "az",
-        "zone",
-        "可用区",
-        "机房"
-    ],
-    "useCases": [
-        "购买页选择可用区"
-    ]
-}
+      ],
+      "usageExample": "<AZ @update:modelValue=\"v => console.log(v)\" /></AZ>",
+      "handlerExample": "(val) => { console.log(val); }"
+    }
+  ],
+  "methods": [],
+  "examples": [],
+  "searchKeywords": [
+    "az",
+    "zone",
+    "可用区",
+    "机房"
+  ],
+  "useCases": [
+    "购买页选择可用区"
+  ]
+}