@blueking/bkui-knowledge 0.0.1-beta.1

package/knowledge/component-apis/navigation.json

@@ -0,0 +1,143 @@
+{
+  "name": "bk-navigation",
+  "description": "蓝鲸导航组件，用于构建管理后台的整体布局框架",
+  "version": "3.0",
+  "lastUpdated": "2026-01-15",
+
+  "props": {
+    "navigationType": {
+      "type": "'left-right' | 'top-bottom'",
+      "default": "left-right",
+      "description": "导航类型。left-right: 左侧菜单; top-bottom: 顶部菜单"
+    },
+    "headerTitle": {
+      "type": "string",
+      "default": "''",
+      "description": "头部标题文字（left-right 模式下显示在顶部中央）"
+    },
+    "sideTitle": {
+      "type": "string",
+      "default": "''",
+      "description": "侧栏标题文字（展开时显示）"
+    },
+    "needMenu": {
+      "type": "boolean",
+      "default": "true",
+      "description": "是否需要侧边菜单栏"
+    },
+    "defaultOpen": {
+      "type": "boolean",
+      "default": "false",
+      "description": "是否默认展开侧边栏"
+    },
+    "navWidth": {
+      "type": "number | string",
+      "default": "60",
+      "description": "侧栏收起时的宽度(px)"
+    },
+    "hoverWidth": {
+      "type": "number | string",
+      "default": "260",
+      "description": "侧栏展开时的宽度(px)"
+    },
+    "headHeight": {
+      "type": "number | string",
+      "default": "52",
+      "description": "头部高度(px)"
+    },
+    "showSideNavTitle": {
+      "type": "boolean",
+      "default": "true",
+      "description": "是否显示侧栏标题区域"
+    },
+    "hoverEnterDelay": {
+      "type": "number",
+      "default": "100",
+      "description": "鼠标进入展开的延迟时间(ms)"
+    },
+    "hoverLeaveDelay": {
+      "type": "number",
+      "default": "0",
+      "description": "鼠标离开收起的延迟时间(ms)"
+    }
+  },
+
+  "slots": {
+    "default": {
+      "description": "主内容区域，放置页面业务内容"
+    },
+    "header": {
+      "description": "头部区域。left-right 模式下在顶部右侧；top-bottom 模式下是整个头部右侧区域"
+    },
+    "menu": {
+      "description": "菜单区域，放置 <bk-menu> 组件"
+    },
+    "footer": {
+      "description": "页面底部区域"
+    },
+    "side-header": {
+      "description": "侧栏头部自定义内容，会替换默认的 sideTitle"
+    },
+    "side-icon": {
+      "description": "侧栏图标（仅当未使用 side-header 时生效）"
+    },
+    "side-footer": {
+      "description": "侧栏底部区域（在折叠按钮下方）"
+    },
+    "header-set": {
+      "description": "头部设置区域（仅 left-right 模式，header slot 为空时生效）"
+    }
+  },
+
+  "events": {
+    "toggle": {
+      "params": "(isOpen: boolean)",
+      "description": "侧栏展开/收起状态变化时触发"
+    },
+    "toggle-click": {
+      "params": "(isOpen: boolean)",
+      "description": "点击折叠按钮时触发"
+    },
+    "hover": {
+      "params": "(isHover: boolean)",
+      "description": "鼠标悬停导致展开时触发"
+    },
+    "leave": {
+      "params": "(isHover: boolean)",
+      "description": "鼠标离开导致收起时触发"
+    }
+  },
+
+  "commonMistakes": [
+    {
+      "wrong": "<bk-navigation :default-open-keys=\"['menu-1']\">",
+      "correct": "<bk-navigation default-open>",
+      "reason": "bk-navigation 没有 default-open-keys 属性！应使用 default-open (布尔值) 控制侧栏初始是否展开。菜单的展开用 bk-menu 的 opened-keys"
+    },
+    {
+      "wrong": "在 top-bottom 模式下仍然使用 #menu slot",
+      "correct": "top-bottom 模式下，将 <bk-menu mode=\"horizontal\"> 放入 #header slot",
+      "reason": "top-bottom 模式下菜单在顶部，应放在 header slot 中"
+    },
+    {
+      "wrong": "<bk-navigation><template #sidebar>...</template></bk-navigation>",
+      "correct": "<bk-navigation><template #menu>...</template></bk-navigation>",
+      "reason": "slot 名称是 menu，不是 sidebar"
+    }
+  ],
+
+  "codeExamples": {
+    "leftRight": "调用 get_bkui_pattern({ patternName: 'admin_layout' }) 获取完整示例",
+    "topBottom": "调用 get_bkui_pattern({ patternName: 'admin_layout_top' }) 获取完整示例",
+    "darkTheme": "获取 skill://bkui-builder/assets/layouts/admin-layout-dark.vue 深色侧边栏模版"
+  },
+
+  "themeCustomization": {
+    "description": "bk-navigation 默认为浅色主题，若需深色侧边栏，使用 CSS 变量覆盖",
+    "darkSidebarCSS": [
+      ".admin-layout--dark :deep(.bk-navigation-side) { background-color: #1a1a2e !important; }",
+      ".admin-layout--dark :deep(.bk-menu) { --menu-bg-color: transparent; --menu-text-color: rgba(255,255,255,0.8); }",
+      ".admin-layout--dark :deep(.bk-menu-item.is-active) { background-color: rgba(58,132,255,0.2); color: #fff; }"
+    ]
+  }
+}

package/knowledge/component-apis/notify.json

@@ -0,0 +1,57 @@
+{
+  "name": "bk-notify",
+  "description": "通知组件 (函数式调用)",
+  "version": "3.0",
+
+  "usage": "import { Notify } from 'bkui-vue'; Notify({ title: '标题', message: '内容', theme: 'success' });",
+
+  "props": {
+    "title": {
+      "type": "string",
+      "default": "''",
+      "description": "标题"
+    },
+    "message": {
+      "type": "string | VNode",
+      "default": "''",
+      "description": "通知内容"
+    },
+    "theme": {
+      "type": "'primary' | 'success' | 'warning' | 'error'",
+      "default": "primary",
+      "description": "主题"
+    },
+    "position": {
+      "type": "'top-right' | 'top-left' | 'bottom-right' | 'bottom-left'",
+      "default": "top-right",
+      "description": "位置"
+    },
+    "delay": {
+      "type": "number",
+      "default": "5000",
+      "description": "自动关闭延时 (ms)，0 表示不自动关闭"
+    },
+    "dismissable": {
+      "type": "boolean",
+      "default": "true",
+      "description": "是否可手动关闭"
+    },
+    "offsetX": {
+      "type": "number",
+      "default": "10",
+      "description": "水平偏移量"
+    },
+    "offsetY": {
+      "type": "number",
+      "default": "10",
+      "description": "垂直偏移量"
+    }
+  },
+
+  "methods": {
+    "Notify.success": "(options | string) - 成功通知",
+    "Notify.warning": "(options | string) - 警告通知",
+    "Notify.error": "(options | string) - 错误通知",
+    "Notify.close": "(id: string) - 关闭指定通知"
+  }
+}

package/knowledge/component-apis/overflow-title.json

@@ -0,0 +1,38 @@
+{
+  "name": "bk-overflow-title",
+  "description": "文本溢出提示组件",
+  "version": "3.0",
+
+  "props": {
+    "content": {
+      "type": "string",
+      "default": "''",
+      "description": "显示内容"
+    },
+    "type": {
+      "type": "'tips' | 'title'",
+      "default": "tips",
+      "description": "提示类型: tips 使用 popover，title 使用原生 title"
+    },
+    "placement": {
+      "type": "string",
+      "default": "top",
+      "description": "提示位置"
+    },
+    "resizeTarget": {
+      "type": "string | HTMLElement",
+      "default": "undefined",
+      "description": "监听尺寸变化的目标"
+    }
+  },
+
+  "slots": {
+    "default": {
+      "description": "显示内容"
+    }
+  },
+
+  "directive": {
+    "v-bk-overflow-title": "指令方式: v-bk-overflow-title"
+  }
+}

package/knowledge/component-apis/pagination.json

@@ -0,0 +1,98 @@
+{
+  "name": "bk-pagination",
+  "description": "分页组件",
+  "version": "3.0",
+
+  "props": {
+    "modelValue": {
+      "type": "number",
+      "default": "1",
+      "description": "当前页码，支持 v-model"
+    },
+    "count": {
+      "type": "number",
+      "default": "0",
+      "description": "总条数"
+    },
+    "limit": {
+      "type": "number",
+      "default": "10",
+      "description": "每页条数"
+    },
+    "limitList": {
+      "type": "array",
+      "default": "[10, 20, 50, 100]",
+      "description": "每页条数选项"
+    },
+    "showLimit": {
+      "type": "boolean",
+      "default": "true",
+      "description": "是否显示每页条数选择"
+    },
+    "showTotalCount": {
+      "type": "boolean",
+      "default": "true",
+      "description": "是否显示总条数"
+    },
+    "small": {
+      "type": "boolean",
+      "default": "false",
+      "description": "是否使用小尺寸"
+    },
+    "align": {
+      "type": "'left' | 'center' | 'right'",
+      "default": "left",
+      "description": "对齐方式"
+    },
+    "type": {
+      "type": "'default' | 'compact'",
+      "default": "default",
+      "description": "分页类型 (从源码)"
+    },
+    "location": {
+      "type": "'left' | 'right'",
+      "default": "right",
+      "description": "总条数位置 (从源码)"
+    },
+    "layout": {
+      "type": "array",
+      "default": "['total', 'list', 'limit']",
+      "description": "布局组成部分 (从源码)"
+    },
+    "disabled": {
+      "type": "boolean",
+      "default": "false",
+      "description": "是否禁用 (从源码)"
+    }
+  },
+
+  "events": {
+    "update:modelValue": {
+      "params": "(page: number)",
+      "description": "页码变化时触发"
+    },
+    "change": {
+      "params": "(page: number)",
+      "description": "页码改变时触发"
+    },
+    "limit-change": {
+      "params": "(limit: number)",
+      "description": "每页条数变化时触发"
+    }
+  },
+
+  "visualMapping": {
+    "左侧显示'共计XX条'": "show-total-count + align=\"left\"",
+    "右侧显示分页器": "align=\"right\" (默认)",
+    "紧凑小尺寸": "small",
+    "隐藏每页条数选择": ":show-limit=\"false\""
+  },
+
+  "commonMistakes": [
+    {
+      "wrong": "pagination 组件单独使用",
+      "correct": "使用 bk-table 的 :pagination 属性",
+      "reason": "表格场景推荐用 bk-table 内置分页，而非独立 bk-pagination"
+    }
+  ]
+}

package/knowledge/component-apis/pop-confirm.json

@@ -0,0 +1,79 @@
+{
+  "name": "bk-pop-confirm",
+  "description": "气泡确认框组件",
+  "version": "3.0",
+
+  "props": {
+    "title": {
+      "type": "string",
+      "default": "''",
+      "description": "标题"
+    },
+    "content": {
+      "type": "string",
+      "default": "''",
+      "description": "内容"
+    },
+    "confirmText": {
+      "type": "string",
+      "default": "确定",
+      "description": "确认按钮文字"
+    },
+    "cancelText": {
+      "type": "string",
+      "default": "取消",
+      "description": "取消按钮文字"
+    },
+    "trigger": {
+      "type": "'click' | 'hover'",
+      "default": "click",
+      "description": "触发方式"
+    },
+    "placement": {
+      "type": "string",
+      "default": "top",
+      "description": "弹出位置"
+    },
+    "theme": {
+      "type": "'dark' | 'light'",
+      "default": "light",
+      "description": "主题"
+    },
+    "width": {
+      "type": "number | string",
+      "default": "undefined",
+      "description": "宽度"
+    }
+  },
+
+  "slots": {
+    "default": {
+      "description": "触发元素"
+    },
+    "content": {
+      "description": "自定义内容"
+    },
+    "icon": {
+      "description": "自定义图标"
+    }
+  },
+
+  "events": {
+    "confirm": {
+      "params": "()",
+      "description": "点击确认按钮时触发"
+    },
+    "cancel": {
+      "params": "()",
+      "description": "点击取消按钮时触发"
+    },
+    "after-show": {
+      "params": "()",
+      "description": "显示后触发"
+    },
+    "after-hidden": {
+      "params": "()",
+      "description": "隐藏后触发"
+    }
+  }
+}

package/knowledge/component-apis/popover.json

@@ -0,0 +1,73 @@
+{
+  "name": "bk-popover",
+  "description": "气泡弹出层组件",
+  "version": "3.0",
+
+  "props": {
+    "content": {
+      "type": "string",
+      "default": "''",
+      "description": "弹出内容"
+    },
+    "theme": {
+      "type": "'dark' | 'light'",
+      "default": "dark",
+      "description": "主题"
+    },
+    "trigger": {
+      "type": "'hover' | 'click' | 'manual'",
+      "default": "hover",
+      "description": "触发方式"
+    },
+    "placement": {
+      "type": "'top' | 'bottom' | 'left' | 'right' | 'auto' | ...",
+      "default": "top",
+      "description": "弹出位置"
+    },
+    "disabled": {
+      "type": "boolean",
+      "default": "false",
+      "description": "是否禁用"
+    },
+    "isShow": {
+      "type": "boolean",
+      "default": "false",
+      "description": "是否显示 (manual 模式下使用)"
+    },
+    "arrow": {
+      "type": "boolean",
+      "default": "true",
+      "description": "是否显示箭头"
+    },
+    "offset": {
+      "type": "number",
+      "default": "6",
+      "description": "偏移量"
+    },
+    "boundary": {
+      "type": "'parent' | 'body' | HTMLElement",
+      "default": "body",
+      "description": "边界元素"
+    }
+  },
+
+  "slots": {
+    "default": {
+      "description": "触发元素"
+    },
+    "content": {
+      "description": "弹出内容"
+    }
+  },
+
+  "events": {
+    "after-show": {
+      "params": "()",
+      "description": "显示后触发"
+    },
+    "after-hidden": {
+      "params": "()",
+      "description": "隐藏后触发"
+    }
+  }
+}

package/knowledge/component-apis/process.json

@@ -0,0 +1,55 @@
+{
+  "name": "bk-process",
+  "description": "步骤流程组件",
+  "version": "3.0",
+
+  "props": {
+    "list": {
+      "type": "array",
+      "default": "[]",
+      "description": "流程数据"
+    },
+    "curProcess": {
+      "type": "number",
+      "default": "0",
+      "description": "当前步骤，支持 v-model:curProcess"
+    },
+    "displayKey": {
+      "type": "string",
+      "default": "content",
+      "description": "显示字段名"
+    },
+    "controllable": {
+      "type": "boolean",
+      "default": "false",
+      "description": "是否可点击切换"
+    },
+    "showSteps": {
+      "type": "boolean",
+      "default": "false",
+      "description": "是否显示步骤数"
+    },
+    "extCls": {
+      "type": "string",
+      "default": "undefined",
+      "description": "自定义类名"
+    }
+  },
+
+  "listItemProps": {
+    "content": "string - 步骤内容",
+    "status": "string - 状态 (loading, error, done)",
+    "icon": "VNode - 自定义图标"
+  },
+
+  "events": {
+    "update:curProcess": {
+      "params": "(index: number)",
+      "description": "步骤变化时触发"
+    },
+    "click": {
+      "params": "(index: number)",
+      "description": "点击步骤时触发"
+    }
+  }
+}

package/knowledge/component-apis/progress.json

@@ -0,0 +1,74 @@
+{
+  "name": "bk-progress",
+  "description": "进度条组件",
+  "version": "3.0",
+
+  "props": {
+    "percent": {
+      "type": "number",
+      "default": "0",
+      "description": "进度百分比 (0-100)"
+    },
+    "type": {
+      "type": "'line' | 'circle' | 'dashboard'",
+      "default": "line",
+      "description": "类型"
+    },
+    "theme": {
+      "type": "'primary' | 'success' | 'warning' | 'danger'",
+      "default": "primary",
+      "description": "主题色"
+    },
+    "size": {
+      "type": "'small' | 'large'",
+      "default": "undefined",
+      "description": "尺寸"
+    },
+    "width": {
+      "type": "number",
+      "default": "126",
+      "description": "环形/仪表盘直径"
+    },
+    "strokeWidth": {
+      "type": "number",
+      "default": "undefined",
+      "description": "进度条宽度"
+    },
+    "textInside": {
+      "type": "boolean",
+      "default": "false",
+      "description": "文字是否显示在进度条内"
+    },
+    "showText": {
+      "type": "boolean",
+      "default": "true",
+      "description": "是否显示文字"
+    },
+    "color": {
+      "type": "string",
+      "default": "undefined",
+      "description": "自定义进度条颜色"
+    },
+    "bgColor": {
+      "type": "string",
+      "default": "undefined",
+      "description": "自定义背景色"
+    },
+    "fixed": {
+      "type": "number",
+      "default": "0",
+      "description": "小数点位数"
+    },
+    "format": {
+      "type": "function",
+      "default": "(percent) => `${percent}%`",
+      "description": "自定义文字格式"
+    }
+  },
+
+  "slots": {
+    "default": {
+      "description": "自定义文字内容"
+    }
+  }
+}