king-design-analyzer 2.1.9 → 2.2.1

package/components/notification.json

@@ -0,0 +1,351 @@
+{
+    "id": "notification",
+    "name": "Notification",
+    "displayName": "通知提醒",
+    "category": "feedback",
+    "description": "全局通知组件，用于展示可停留、可关闭的系统级通知信息。支持不同语义类型、展示位置、自定义图标和点击回调，适合成功反馈、系统公告和后台异步任务提醒。",
+    "importStatement": "import { Notification } from '@king-design/vue';",
+    "props": [
+        {
+            "name": "title",
+            "description": "通知标题内容",
+            "type": {
+                "raw": "Children",
+                "kind": "custom"
+            },
+            "required": false,
+            "default": "undefined",
+            "usageExample": "Notification.notice({ title: '部署完成' })"
+        },
+        {
+            "name": "content",
+            "description": "通知正文内容",
+            "type": {
+                "raw": "Children",
+                "kind": "custom"
+            },
+            "required": false,
+            "default": "undefined",
+            "usageExample": "Notification.notice({ content: '实例已经创建成功' })"
+        },
+        {
+            "name": "duration",
+            "description": "通知自动关闭时间，单位 ms；传入 0 表示不自动关闭",
+            "type": {
+                "raw": "number",
+                "kind": "number"
+            },
+            "required": false,
+            "default": "5000",
+            "usageExample": "Notification.info({ title: '处理中', duration: 0 })"
+        },
+        {
+            "name": "type",
+            "description": "通知类型",
+            "type": {
+                "raw": "\"info\" | \"error\" | \"success\" | \"warning\" | \"\"",
+                "kind": "union",
+                "unionTypes": [
+                    "info",
+                    "error",
+                    "success",
+                    "warning",
+                    ""
+                ]
+            },
+            "required": false,
+            "default": "\"info\"",
+            "allowedValues": [
+                {
+                    "value": "info",
+                    "label": "普通提示",
+                    "isDefault": true
+                },
+                {
+                    "value": "success",
+                    "label": "成功通知"
+                },
+                {
+                    "value": "warning",
+                    "label": "警告通知"
+                },
+                {
+                    "value": "error",
+                    "label": "错误通知"
+                },
+                {
+                    "value": "",
+                    "label": "无类型样式"
+                }
+            ],
+            "usageExample": "Notification.success({ title: '发布成功' })"
+        },
+        {
+            "name": "closable",
+            "description": "是否显示关闭按钮",
+            "type": {
+                "raw": "boolean",
+                "kind": "boolean"
+            },
+            "required": false,
+            "default": "true",
+            "usageExample": "Notification.notice({ title: '系统公告', closable: false })"
+        },
+        {
+            "name": "icon",
+            "description": "自定义通知图标",
+            "type": {
+                "raw": "string | VNode",
+                "kind": "union"
+            },
+            "required": false,
+            "default": "undefined",
+            "usageExample": "Notification.notice({ title: '自定义图标', icon: 'k-icon-info' })"
+        },
+        {
+            "name": "position",
+            "description": "通知展示位置",
+            "type": {
+                "raw": "\"topRight\" | \"topLeft\" | \"bottomRight\" | \"bottomLeft\" | \"top\" | \"bottom\"",
+                "kind": "union",
+                "unionTypes": [
+                    "topRight",
+                    "topLeft",
+                    "bottomRight",
+                    "bottomLeft",
+                    "top",
+                    "bottom"
+                ]
+            },
+            "required": false,
+            "default": "\"topRight\"",
+            "allowedValues": [
+                {
+                    "value": "topRight",
+                    "label": "右上角",
+                    "isDefault": true
+                },
+                {
+                    "value": "topLeft",
+                    "label": "左上角"
+                },
+                {
+                    "value": "bottomRight",
+                    "label": "右下角"
+                },
+                {
+                    "value": "bottomLeft",
+                    "label": "左下角"
+                },
+                {
+                    "value": "top",
+                    "label": "顶部居中"
+                },
+                {
+                    "value": "bottom",
+                    "label": "底部居中"
+                }
+            ],
+            "usageExample": "Notification.info({ title: '左下角通知', position: 'bottomLeft' })"
+        },
+        {
+            "name": "className",
+            "description": "自定义通知根节点类名",
+            "type": {
+                "raw": "string",
+                "kind": "string"
+            },
+            "required": false,
+            "default": "undefined",
+            "usageExample": "Notification.notice({ title: '自定义样式', className: 'my-notification' })"
+        },
+        {
+            "name": "onClick",
+            "description": "点击通知主体时触发的回调",
+            "type": {
+                "raw": "(e: MouseEvent) => void",
+                "kind": "function"
+            },
+            "required": false,
+            "default": "undefined",
+            "usageExample": "Notification.notice({ title: '查看详情', onClick: () => console.log('clicked') })"
+        },
+        {
+            "name": "onClose",
+            "description": "通知关闭后触发的回调",
+            "type": {
+                "raw": "() => void",
+                "kind": "function"
+            },
+            "required": false,
+            "default": "undefined",
+            "usageExample": "Notification.notice({ title: '关闭回调', onClose: () => console.log('closed') })"
+        }
+    ],
+    "events": [],
+    "slots": [],
+    "methods": [
+        {
+            "name": "notice",
+            "description": "展示一条通知并返回唯一 ID",
+            "params": [
+                {
+                    "name": "props",
+                    "type": "Partial<NotificationProps>",
+                    "description": "通知配置对象"
+                }
+            ],
+            "returnType": "number",
+            "usageExample": "const id = Notification.notice({ title: '部署完成', content: '实例已创建完成' });"
+        },
+        {
+            "name": "close",
+            "description": "关闭指定 ID 的通知",
+            "params": [
+                {
+                    "name": "id",
+                    "type": "number",
+                    "description": "由 notice 返回的通知 ID"
+                }
+            ],
+            "returnType": "void",
+            "usageExample": "Notification.close(id);"
+        },
+        {
+            "name": "info",
+            "description": "展示普通类型通知",
+            "params": [
+                {
+                    "name": "props",
+                    "type": "Partial<NotificationProps>",
+                    "description": "通知配置对象"
+                }
+            ],
+            "returnType": "number",
+            "usageExample": "Notification.info({ title: '普通提醒', content: '这是一条信息通知' });"
+        },
+        {
+            "name": "success",
+            "description": "展示成功类型通知",
+            "params": [
+                {
+                    "name": "props",
+                    "type": "Partial<NotificationProps>",
+                    "description": "通知配置对象"
+                }
+            ],
+            "returnType": "number",
+            "usageExample": "Notification.success({ title: '保存成功', content: '配置已更新' });"
+        },
+        {
+            "name": "warning",
+            "description": "展示警告类型通知",
+            "params": [
+                {
+                    "name": "props",
+                    "type": "Partial<NotificationProps>",
+                    "description": "通知配置对象"
+                }
+            ],
+            "returnType": "number",
+            "usageExample": "Notification.warning({ title: '余额不足', content: '请尽快续费' });"
+        },
+        {
+            "name": "error",
+            "description": "展示错误类型通知",
+            "params": [
+                {
+                    "name": "props",
+                    "type": "Partial<NotificationProps>",
+                    "description": "通知配置对象"
+                }
+            ],
+            "returnType": "number",
+            "usageExample": "Notification.error({ title: '提交失败', content: '请稍后重试' });"
+        }
+    ],
+    "examples": [
+        {
+            "id": "notification_basic",
+            "title": "基础通知",
+            "description": "点击按钮展示基础通知。",
+            "difficulty": "easy",
+            "code": "<script setup lang=\"ts\">\nimport { Button, Notification } from '@king-design/vue';\n\nconst openNotification = () => {\n  Notification.notice({\n    title: 'Hello, King Design',\n    content: '这是一条基础通知',\n  });\n};\n</script>\n<template>\n  <Button @click=\"openNotification\">打开通知</Button>\n</template>",
+            "tags": [
+                "basic",
+                "notice"
+            ],
+            "usedProps": [],
+            "usedEvents": [],
+            "usedMethods": [
+                "notice"
+            ],
+            "scenario": "在页面操作完成后展示全局反馈。"
+        },
+        {
+            "id": "notification_types",
+            "title": "不同类型",
+            "description": "按语义展示不同类型的通知。",
+            "difficulty": "easy",
+            "code": "<script setup lang=\"ts\">\nimport { Button, Notification } from '@king-design/vue';\n</script>\n<template>\n  <div style=\"display: flex; gap: 8px; flex-wrap: wrap;\">\n    <Button @click=\"Notification.info({ title: '普通提醒', content: '这是一条信息通知' })\">Info</Button>\n    <Button @click=\"Notification.success({ title: '发布成功', content: '版本已上线' })\">Success</Button>\n    <Button @click=\"Notification.warning({ title: '容量不足', content: '请及时清理磁盘' })\">Warning</Button>\n    <Button @click=\"Notification.error({ title: '同步失败', content: '网络连接异常' })\">Error</Button>\n  </div>\n</template>",
+            "tags": [
+                "type",
+                "semantic"
+            ],
+            "usedProps": [
+                "type"
+            ],
+            "usedEvents": [],
+            "usedMethods": [
+                "info",
+                "success",
+                "warning",
+                "error"
+            ],
+            "scenario": "根据业务结果展示不同语义反馈。"
+        },
+        {
+            "id": "notification_position",
+            "title": "位置与常驻",
+            "description": "控制通知位置并让通知常驻直到手动关闭。",
+            "difficulty": "medium",
+            "code": "<script setup lang=\"ts\">\nimport { Button, Notification } from '@king-design/vue';\n\nconst openPinned = () => {\n  Notification.notice({\n    title: '系统公告',\n    content: '该通知位于底部且不会自动关闭',\n    position: 'bottom',\n    duration: 0,\n  });\n};\n</script>\n<template>\n  <Button @click=\"openPinned\">打开常驻通知</Button>\n</template>",
+            "tags": [
+                "position",
+                "duration"
+            ],
+            "usedProps": [
+                "position",
+                "duration"
+            ],
+            "usedEvents": [],
+            "usedMethods": [
+                "notice"
+            ],
+            "scenario": "展示需要用户明确感知和手动关闭的通知。"
+        }
+    ],
+    "searchKeywords": [
+        "notification",
+        "通知",
+        "提醒",
+        "全局通知",
+        "notice"
+    ],
+    "useCases": [
+        "系统公告提醒",
+        "异步任务完成通知",
+        "操作成功或失败反馈"
+    ],
+    "typeDefinitions": [
+        {
+            "name": "NotificationPosition",
+            "definition": "type NotificationPosition = 'topRight' | 'topLeft' | 'bottomRight' | 'bottomLeft' | 'top' | 'bottom'",
+            "description": "通知可展示的位置。"
+        }
+    ],
+    "relatedComponents": [
+        "Message",
+        "Dialog"
+    ]
+}

package/components/pagination.json

@@ -438,6 +438,18 @@
     "文章列表分页",
     "商品列表分页"
   ],
+  "typeDefinitions": [
+    {
+      "name": "PaginationChangePayload",
+      "definition": "type PaginationChangePayload = {\\n  value: number\\n  limit: number\\n}",
+      "description": "分页 change 事件返回的数据结构，包含当前页码和每页条数。"
+    },
+    {
+      "name": "PaginationSize",
+      "definition": "type PaginationSize = 'large' | 'default' | 'small' | 'mini'",
+      "description": "分页器尺寸枚举，用于适配不同密度的列表页面。"
+    }
+  ],
   "relatedComponents": [
     "Table"
   ]

package/components/paginationplus.json

@@ -5,6 +5,17 @@
     "category": "navigation",
     "description": "集成选中统计和操作的分页组件，继承自 Pagination。",
     "importStatement": "import { PaginationPlus } from '@ksyun-internal/versatile';",
+    "inherits": [
+        {
+            "component": "Pagination",
+            "include": [
+                "props"
+            ],
+            "exclude": [
+                "value"
+            ]
+        }
+    ],
     "props": [
         {
             "name": "modelValue",
@@ -66,9 +77,25 @@
         "pagination",
         "page",
         "paging",
-        "分页"
+        "分页",
+        "增强分页",
+        "选中统计分页",
+        "列表底部分页"
     ],
     "useCases": [
-        "列表页分页控制"
+        "列表页分页控制",
+        "批量勾选后的分页统计",
+        "带选中数量提示的资源列表分页"
+    ],
+    "typeDefinitions": [
+        {
+            "name": "PaginationPlusChange",
+            "definition": "type PaginationPlusChange = {\\n  page: number\\n  limit: number\\n}",
+            "description": "增强分页 change 事件返回的数据结构。"
+        }
+    ],
+    "relatedComponents": [
+        "Pagination",
+        "ProTable"
     ]
-}
+}

package/components/password.json

@@ -0,0 +1,121 @@
+{
+    "id": "password",
+    "name": "Password",
+    "displayName": "密码输入",
+    "category": "form",
+    "description": "面向密码录入的业务输入组件，内置校验能力和错误提示展示，适合实例登录密码、数据库密码等安全场景。",
+    "importStatement": "import { Password } from '@ksyun-internal/versatile';",
+    "props": [
+        {
+            "name": "modelValue",
+            "description": "当前密码值",
+            "type": {
+                "raw": "string",
+                "kind": "string"
+            },
+            "required": false
+        },
+        {
+            "name": "validate",
+            "description": "自定义校验函数或校验规则",
+            "type": {
+                "raw": "string | Function",
+                "kind": "union"
+            },
+            "required": false
+        },
+        {
+            "name": "errorMessage",
+            "description": "校验失败时的错误提示文案",
+            "type": {
+                "raw": "string",
+                "kind": "string"
+            },
+            "required": false
+        }
+    ],
+    "events": [
+        {
+            "name": "update:modelValue",
+            "vueEventName": "@update:modelValue",
+            "description": "密码内容变化时触发，可与父级表单或强度校验逻辑联动。",
+            "params": [
+                {
+                    "name": "value",
+                    "type": "string",
+                    "description": "当前输入的密码值。",
+                    "optional": true
+                }
+            ]
+        }
+    ],
+    "slots": [],
+    "methods": [],
+    "examples": [
+        {
+            "id": "password_login",
+            "title": "实例登录密码录入",
+            "description": "结合 validate 和错误提示控制密码输入质量。",
+            "difficulty": "easy",
+            "code": "<script setup lang=\"ts\">\nimport { ref } from 'vue';\nimport { Password } from '@ksyun-internal/versatile';\n\nconst password = ref('');\nconst validate = (value: string) => /^(?=.*[A-Z])(?=.*\\d).{8,}$/.test(value);\n</script>\n\n<template>\n  <Password\n    v-model=\"password\"\n    :validate=\"validate\"\n    error-message=\"至少 8 位，且必须包含大写字母和数字\"\n  />\n</template>",
+            "tags": [
+                "password",
+                "security"
+            ],
+            "usedProps": [
+                "modelValue",
+                "validate",
+                "errorMessage"
+            ],
+            "usedEvents": [
+                "update:modelValue"
+            ],
+            "usedMethods": [],
+            "scenario": "在创建实例或重置密码时录入并校验登录密码。"
+        },
+        {
+            "id": "password_db_rule",
+            "title": "数据库密码规则校验",
+            "description": "通过自定义规则约束数据库密码长度和复杂度。",
+            "difficulty": "medium",
+            "code": "<script setup lang=\"ts\">\nimport { ref } from 'vue';\nimport { Password } from '@ksyun-internal/versatile';\n\nconst password = ref('');\nconst validate = (value: string) => value.length >= 12 && /[A-Z]/.test(value) && /\\d/.test(value);\n</script>\n\n<template>\n  <Password\n    v-model=\"password\"\n    :validate=\"validate\"\n    error-message=\"至少 12 位，并包含大写字母和数字\"\n  />\n</template>",
+            "tags": [
+                "password",
+                "database"
+            ],
+            "usedProps": [
+                "modelValue",
+                "validate",
+                "errorMessage"
+            ],
+            "usedEvents": [
+                "update:modelValue"
+            ],
+            "usedMethods": [],
+            "scenario": "在数据库创建页中校验更严格的密码复杂度要求。"
+        }
+    ],
+    "searchKeywords": [
+        "password",
+        "password input",
+        "密码输入",
+        "密码校验",
+        "数据库密码",
+        "登录密码"
+    ],
+    "useCases": [
+        "账号凭证录入",
+        "新建实例密码配置",
+        "数据库密码复杂度校验"
+    ],
+    "typeDefinitions": [
+        {
+            "name": "PasswordRule",
+            "definition": "type PasswordRule = RegExp | string",
+            "description": "密码校验规则类型，可传正则表达式或规则描述文本。"
+        }
+    ],
+    "relatedComponents": [
+        "Input"
+    ]
+}