@blueking/bkui-knowledge 0.0.1-beta.1

package/knowledge/component-apis/form.json

@@ -0,0 +1,56 @@
+{
+  "name": "bk-form",
+  "description": "表单组件，用于数据收集和验证",
+  "version": "3.0",
+
+  "props": {
+    "model": {
+      "type": "object",
+      "default": "{}",
+      "description": "表单数据对象"
+    },
+    "rules": {
+      "type": "object",
+      "default": "{}",
+      "description": "表单验证规则"
+    },
+    "labelWidth": {
+      "type": "string | number",
+      "default": "150",
+      "description": "标签宽度"
+    },
+    "labelPosition": {
+      "type": "'left' | 'right' | 'top'",
+      "default": "right",
+      "description": "标签位置"
+    },
+    "formType": {
+      "type": "'horizontal' | 'vertical'",
+      "default": "horizontal",
+      "description": "表单布局类型"
+    }
+  },
+
+  "slots": {
+    "default": {
+      "description": "表单内容，放置 bk-form-item"
+    }
+  },
+
+  "methods": {
+    "validate": "() => Promise<boolean> - 验证整个表单",
+    "clearValidate": "(fields?: string[]) => void - 清除验证状态",
+    "resetFields": "() => void - 重置表单"
+  },
+
+  "relatedComponents": {
+    "bk-form-item": {
+      "props": {
+        "label": "string - 标签文本",
+        "property": "string - 字段名 (用于验证)",
+        "required": "boolean - 是否必填",
+        "rules": "array - 单独的验证规则"
+      }
+    }
+  }
+}

package/knowledge/component-apis/image.json

@@ -0,0 +1,73 @@
+{
+  "name": "bk-image",
+  "description": "图片组件",
+  "version": "3.0",
+
+  "props": {
+    "src": {
+      "type": "string",
+      "default": "''",
+      "description": "图片地址"
+    },
+    "fallback": {
+      "type": "string",
+      "default": "''",
+      "description": "加载失败时的图片"
+    },
+    "placeholder": {
+      "type": "any",
+      "default": "undefined",
+      "description": "加载中占位内容"
+    },
+    "fit": {
+      "type": "'fill' | 'contain' | 'cover' | 'none' | 'scale-down'",
+      "default": "fill",
+      "description": "图片适应方式"
+    },
+    "lazy": {
+      "type": "boolean",
+      "default": "false",
+      "description": "是否懒加载"
+    },
+    "urlList": {
+      "type": "array",
+      "default": "[]",
+      "description": "预览图片列表"
+    },
+    "isShowPreviewTitle": {
+      "type": "boolean",
+      "default": "true",
+      "description": "预览时是否显示标题"
+    },
+    "maskClose": {
+      "type": "boolean",
+      "default": "true",
+      "description": "点击遮罩是否关闭预览"
+    },
+    "zIndex": {
+      "type": "number",
+      "default": "2000",
+      "description": "预览层级"
+    }
+  },
+
+  "slots": {
+    "error": {
+      "description": "加载失败时显示的内容"
+    },
+    "placeholder": {
+      "description": "加载中显示的内容"
+    }
+  },
+
+  "relatedComponents": {
+    "bk-image-viewer": {
+      "description": "图片预览组件",
+      "props": {
+        "urlList": "array - 图片列表",
+        "initialIndex": "number - 初始显示索引",
+        "zIndex": "number - 层级"
+      }
+    }
+  }
+}

package/knowledge/component-apis/info-box.json

@@ -0,0 +1,75 @@
+{
+  "name": "bk-info-box",
+  "description": "信息弹框组件 (函数式调用)",
+  "version": "3.0",
+
+  "usage": "import { InfoBox } from 'bkui-vue'; InfoBox({ title: '确认删除？', subTitle: '删除后不可恢复' });",
+
+  "props": {
+    "title": {
+      "type": "string | VNode",
+      "default": "''",
+      "description": "标题"
+    },
+    "subTitle": {
+      "type": "string | VNode",
+      "default": "''",
+      "description": "副标题"
+    },
+    "type": {
+      "type": "'success' | 'warning' | 'danger' | 'loading'",
+      "default": "undefined",
+      "description": "类型"
+    },
+    "confirmText": {
+      "type": "string",
+      "default": "确定",
+      "description": "确认按钮文字"
+    },
+    "cancelText": {
+      "type": "string",
+      "default": "取消",
+      "description": "取消按钮文字"
+    },
+    "headerAlign": {
+      "type": "'left' | 'center' | 'right'",
+      "default": "center",
+      "description": "标题对齐方式"
+    },
+    "footerAlign": {
+      "type": "'left' | 'center' | 'right'",
+      "default": "center",
+      "description": "底部对齐方式"
+    },
+    "width": {
+      "type": "number | string",
+      "default": "400",
+      "description": "宽度"
+    },
+    "closeIcon": {
+      "type": "boolean",
+      "default": "true",
+      "description": "是否显示关闭图标"
+    },
+    "escClose": {
+      "type": "boolean",
+      "default": "true",
+      "description": "是否按 ESC 关闭"
+    },
+    "onConfirm": {
+      "type": "function",
+      "default": "undefined",
+      "description": "确认回调"
+    },
+    "onCancel": {
+      "type": "function",
+      "default": "undefined",
+      "description": "取消回调"
+    }
+  },
+
+  "methods": {
+    "InfoBox.show": "(options) - 显示弹框",
+    "InfoBox.hide": "() - 隐藏弹框"
+  }
+}

package/knowledge/component-apis/input.json

@@ -0,0 +1,146 @@
+{
+  "name": "bk-input",
+  "description": "输入框组件",
+  "version": "3.0",
+
+  "props": {
+    "modelValue": {
+      "type": "string | number",
+      "default": "undefined",
+      "description": "绑定值，支持 v-model"
+    },
+    "type": {
+      "type": "'text' | 'password' | 'number' | 'textarea' | 'search'",
+      "default": "text",
+      "description": "输入框类型 (从源码: search 类型带搜索图标)"
+    },
+    "placeholder": {
+      "type": "string",
+      "default": "''",
+      "description": "占位文本"
+    },
+    "disabled": {
+      "type": "boolean",
+      "default": "false",
+      "description": "是否禁用"
+    },
+    "readonly": {
+      "type": "boolean",
+      "default": "false",
+      "description": "是否只读"
+    },
+    "clearable": {
+      "type": "boolean",
+      "default": "false",
+      "description": "是否可清空"
+    },
+    "maxlength": {
+      "type": "number",
+      "default": "undefined",
+      "description": "最大输入长度"
+    },
+    "showWordLimit": {
+      "type": "boolean",
+      "default": "false",
+      "description": "是否显示字数统计"
+    },
+    "size": {
+      "type": "'small' | 'large'",
+      "default": "undefined",
+      "description": "尺寸"
+    },
+    "prefix": {
+      "type": "string",
+      "default": "undefined",
+      "description": "前缀文字"
+    },
+    "suffix": {
+      "type": "string",
+      "default": "undefined",
+      "description": "后缀文字"
+    },
+    "rows": {
+      "type": "number",
+      "default": "undefined",
+      "description": "textarea 行数"
+    },
+    "autosize": {
+      "type": "boolean | { minRows: number, maxRows: number }",
+      "default": "false",
+      "description": "textarea 自适应高度"
+    },
+    "behavior": {
+      "type": "'simplicity' | 'normal'",
+      "default": "normal",
+      "description": "输入框样式模式 (从源码)"
+    },
+    "maxcharacter": {
+      "type": "number",
+      "default": "undefined",
+      "description": "最大字符数(中文算2) (从源码)"
+    },
+    "showClearOnlyHover": {
+      "type": "boolean",
+      "default": "true",
+      "description": "仅悬停时显示清除按钮 (从源码)"
+    },
+    "showControl": {
+      "type": "boolean",
+      "default": "true",
+      "description": "number类型是否显示控制按钮 (从源码)"
+    },
+    "precision": {
+      "type": "number",
+      "default": "0",
+      "description": "number类型小数精度 (从源码)"
+    }
+  },
+
+  "slots": {
+    "prefix": {
+      "description": "前缀插槽"
+    },
+    "suffix": {
+      "description": "后缀插槽"
+    }
+  },
+
+  "events": {
+    "update:modelValue": {
+      "params": "(value: string | number)",
+      "description": "值变化时触发"
+    },
+    "input": {
+      "params": "(value: string, event: Event)",
+      "description": "输入时触发"
+    },
+    "change": {
+      "params": "(value: string, event: Event)",
+      "description": "值改变时触发"
+    },
+    "focus": {
+      "params": "(event: FocusEvent)",
+      "description": "获取焦点时触发"
+    },
+    "blur": {
+      "params": "(event: FocusEvent)",
+      "description": "失去焦点时触发"
+    },
+    "clear": {
+      "params": "()",
+      "description": "清空时触发"
+    },
+    "enter": {
+      "params": "(value: string, event: KeyboardEvent)",
+      "description": "按下回车时触发"
+    }
+  },
+
+  "visualMapping": {
+    "带搜索图标的输入框": "type=\"search\" (从源码: 自带搜索图标)",
+    "带清空按钮": "clearable",
+    "多行文本框": "type=\"textarea\"",
+    "显示字数统计": "maxlength + show-word-limit",
+    "简洁无边框样式": "behavior=\"simplicity\""
+  }
+}

package/knowledge/component-apis/link.json

@@ -0,0 +1,46 @@
+{
+  "name": "bk-link",
+  "description": "链接组件",
+  "version": "3.0",
+
+  "props": {
+    "theme": {
+      "type": "'default' | 'primary' | 'success' | 'warning' | 'danger'",
+      "default": "default",
+      "description": "主题"
+    },
+    "href": {
+      "type": "string",
+      "default": "''",
+      "description": "链接地址"
+    },
+    "target": {
+      "type": "string",
+      "default": "_self",
+      "description": "打开方式"
+    },
+    "disabled": {
+      "type": "boolean",
+      "default": "false",
+      "description": "是否禁用"
+    },
+    "underline": {
+      "type": "boolean",
+      "default": "false",
+      "description": "是否显示下划线"
+    }
+  },
+
+  "slots": {
+    "default": {
+      "description": "链接文字"
+    }
+  },
+
+  "events": {
+    "click": {
+      "params": "(event: Event)",
+      "description": "点击时触发"
+    }
+  }
+}

package/knowledge/component-apis/loading.json

@@ -0,0 +1,48 @@
+{
+  "name": "bk-loading",
+  "description": "加载中组件",
+  "version": "3.0",
+
+  "props": {
+    "loading": {
+      "type": "boolean",
+      "default": "true",
+      "description": "是否显示加载状态"
+    },
+    "title": {
+      "type": "string",
+      "default": "''",
+      "description": "加载提示文字"
+    },
+    "theme": {
+      "type": "'primary' | 'warning' | 'success' | 'danger'",
+      "default": "primary",
+      "description": "主题色"
+    },
+    "size": {
+      "type": "'mini' | 'small' | 'large'",
+      "default": "small",
+      "description": "尺寸"
+    },
+    "mode": {
+      "type": "'default' | 'spin'",
+      "default": "default",
+      "description": "加载模式"
+    },
+    "opacity": {
+      "type": "number",
+      "default": "0.9",
+      "description": "遮罩透明度"
+    }
+  },
+
+  "slots": {
+    "default": {
+      "description": "被包裹的内容"
+    }
+  },
+
+  "directive": {
+    "v-bkloading": "指令方式使用: v-bkloading=\"{ loading: true, title: '加载中' }\""
+  }
+}

package/knowledge/component-apis/menu.json

@@ -0,0 +1,108 @@
+{
+  "name": "bk-menu",
+  "description": "蓝鲸菜单组件，通常配合 bk-navigation 使用",
+  "version": "3.0",
+  "lastUpdated": "2026-01-15",
+
+  "props": {
+    "activeKey": {
+      "type": "string",
+      "default": "undefined",
+      "description": "当前激活的菜单项 key"
+    },
+    "openedKeys": {
+      "type": "string[]",
+      "default": "undefined",
+      "description": "当前展开的子菜单 key 数组（注意：不是 default-open-keys！）"
+    },
+    "mode": {
+      "type": "'vertical' | 'horizontal'",
+      "default": "vertical",
+      "description": "菜单模式。vertical: 垂直(侧边栏); horizontal: 水平(顶部菜单栏)"
+    },
+    "collapse": {
+      "type": "boolean",
+      "default": "false",
+      "description": "是否收起菜单"
+    },
+    "uniqueOpen": {
+      "type": "boolean",
+      "default": "true",
+      "description": "是否只保持一个子菜单展开（手风琴模式）"
+    }
+  },
+
+  "slots": {
+    "default": {
+      "description": "菜单内容，放置 bk-menu-item 或 bk-menu-group"
+    }
+  },
+
+  "events": {
+    "click": {
+      "params": "(menuInfo: IMenuInfo)",
+      "description": "点击菜单项时触发"
+    },
+    "openChange": {
+      "params": "(opened: boolean, menuInfo: IMenuInfo)",
+      "description": "子菜单展开/收起时触发"
+    },
+    "update:activeKey": {
+      "params": "(key: string, menuInfo: IMenuInfo)",
+      "description": "激活项变化时触发，支持 v-model:activeKey"
+    },
+    "update:openKeys": {
+      "params": "(keys: string[])",
+      "description": "展开项变化时触发，支持 v-model:openKeys"
+    }
+  },
+
+  "commonMistakes": [
+    {
+      "wrong": "<bk-menu :default-open-keys=\"['group-1']\">",
+      "correct": "<bk-menu :opened-keys=\"['group-1']\">",
+      "reason": "bk-menu 没有 default-open-keys 属性！正确属性名是 opened-keys (kebab-case) 或 openedKeys (camelCase)"
+    },
+    {
+      "wrong": "<bk-menu :active-key=\"currentKey\">",
+      "correct": "<bk-menu :active-key=\"currentKey\" @click=\"handleClick\">",
+      "reason": "activeKey 只是初始值，点击后需要通过 @click 事件更新"
+    },
+    {
+      "wrong": "top-bottom 模式下 <bk-menu>",
+      "correct": "top-bottom 模式下 <bk-menu mode=\"horizontal\">",
+      "reason": "顶部菜单栏必须设置 mode=\"horizontal\""
+    }
+  ],
+
+  "relatedComponents": {
+    "bk-menu-item": {
+      "props": {
+        "key": "string (通过 Vue key 属性设置，必填)",
+        "disabled": "boolean (是否禁用)",
+        "needIcon": "boolean (是否需要图标，默认 true)"
+      },
+      "slots": {
+        "default": "菜单项文字内容",
+        "icon": "图标插槽"
+      }
+    },
+    "bk-menu-group": {
+      "props": {
+        "name": "string (分组名称)",
+        "foldName": "string (收起时的分组名称，默认同 name)"
+      },
+      "slots": {
+        "default": "菜单项内容",
+        "name": "自定义分组名称"
+      }
+    }
+  },
+
+  "visualMapping": {
+    "左侧垂直菜单": "mode=\"vertical\" (默认)",
+    "顶部水平菜单": "mode=\"horizontal\"",
+    "菜单项有图标": "使用 #icon 插槽 + bkui-vue/lib/icon",
+    "有分组标题(如日志接入/日志清洗)": "使用 bk-menu-group"
+  }
+}

package/knowledge/component-apis/message.json

@@ -0,0 +1,47 @@
+{
+  "name": "bk-message",
+  "description": "消息提示组件 (函数式调用)",
+  "version": "3.0",
+
+  "usage": "import { Message } from 'bkui-vue'; Message({ message: '提示内容', theme: 'success' });",
+
+  "props": {
+    "message": {
+      "type": "string | VNode",
+      "default": "''",
+      "description": "消息内容"
+    },
+    "theme": {
+      "type": "'primary' | 'success' | 'warning' | 'error'",
+      "default": "primary",
+      "description": "消息主题"
+    },
+    "delay": {
+      "type": "number",
+      "default": "3000",
+      "description": "自动关闭延时 (ms)，0 表示不自动关闭"
+    },
+    "dismissable": {
+      "type": "boolean",
+      "default": "true",
+      "description": "是否可手动关闭"
+    },
+    "offsetY": {
+      "type": "number",
+      "default": "30",
+      "description": "距离顶部的偏移量"
+    },
+    "spacing": {
+      "type": "number",
+      "default": "10",
+      "description": "多条消息之间的间距"
+    }
+  },
+
+  "methods": {
+    "Message.success": "(options | string) - 成功消息",
+    "Message.warning": "(options | string) - 警告消息",
+    "Message.error": "(options | string) - 错误消息",
+    "Message.close": "(id: string) - 关闭指定消息"
+  }
+}