@blueking/bkui-knowledge 0.0.1-beta.1

package/knowledge/component-apis/radio.json

@@ -0,0 +1,79 @@
+{
+  "name": "bk-radio",
+  "description": "单选框组件",
+  "version": "3.0",
+
+  "props": {
+    "modelValue": {
+      "type": "string | number | boolean",
+      "default": "undefined",
+      "description": "绑定值，支持 v-model"
+    },
+    "label": {
+      "type": "string | number | boolean",
+      "default": "undefined",
+      "description": "Radio 的值"
+    },
+    "disabled": {
+      "type": "boolean",
+      "default": "false",
+      "description": "是否禁用"
+    },
+    "checked": {
+      "type": "boolean",
+      "default": "false",
+      "description": "是否默认选中"
+    }
+  },
+
+  "slots": {
+    "default": {
+      "description": "单选框文本内容"
+    }
+  },
+
+  "events": {
+    "update:modelValue": {
+      "params": "(value)",
+      "description": "值变化时触发"
+    },
+    "change": {
+      "params": "(value, event: Event)",
+      "description": "值改变时触发"
+    }
+  },
+
+  "relatedComponents": {
+    "bk-radio-group": {
+      "props": {
+        "modelValue": "string | number | boolean - 绑定值",
+        "type": "'tab' | 'capsule' | 'card' - 样式类型 (默认 tab)",
+        "size": "尺寸",
+        "disabled": "是否禁用"
+      },
+      "description": "单选框组，管理多个 bk-radio"
+    },
+    "bk-radio-button": {
+      "description": "按钮样式的单选框"
+    }
+  },
+
+  "visualMapping": {
+    "圆形单选": "bk-radio",
+    "按钮式单选组": "bk-radio-group + bk-radio-button",
+    "胶囊样式筛选(边框包裹+分隔线)": "bk-radio-group type=\"capsule\"",
+    "多个单选项": "bk-radio-group"
+  },
+
+  "capsuleUsage": {
+    "description": "胶囊样式 - 用于表格上方的筛选条件（如 全部/启用/停用）",
+    "code": "<bk-radio-group v-model=\"activeFilter\" type=\"capsule\">\n  <bk-radio-button label=\"all\">全部(24)</bk-radio-button>\n  <bk-radio-button label=\"enabled\">启用(10)</bk-radio-button>\n  <bk-radio-button label=\"disabled\">停用(14)</bk-radio-button>\n</bk-radio-group>",
+    "note": "当看到选项被边框包裹、选项之间有分隔线时，使用 radio capsule 而不是 tab"
+  },
+
+  "vsTab": {
+    "description": "Radio Capsule vs Tab 的区分",
+    "useCapsule": "纯筛选切换，没有对应的面板内容",
+    "useTab": "有对应的内容面板需要切换显示"
+  }
+}

package/knowledge/component-apis/rate.json

@@ -0,0 +1,38 @@
+{
+  "name": "bk-rate",
+  "description": "评分组件",
+  "version": "3.0",
+
+  "props": {
+    "modelValue": {
+      "type": "number",
+      "default": "0",
+      "description": "绑定值，支持 v-model"
+    },
+    "size": {
+      "type": "'small' | 'large' | 'huge'",
+      "default": "undefined",
+      "description": "尺寸"
+    },
+    "editable": {
+      "type": "boolean",
+      "default": "true",
+      "description": "是否可编辑"
+    }
+  },
+
+  "events": {
+    "update:modelValue": {
+      "params": "(value: number)",
+      "description": "值变化时触发"
+    },
+    "change": {
+      "params": "(value: number)",
+      "description": "评分改变时触发"
+    },
+    "hover-change": {
+      "params": "(value: number)",
+      "description": "鼠标移动到评分时触发"
+    }
+  }
+}

package/knowledge/component-apis/resize-layout.json

@@ -0,0 +1,72 @@
+{
+  "name": "bk-resize-layout",
+  "description": "可拖拽调整大小的布局组件",
+  "version": "3.0",
+
+  "props": {
+    "placement": {
+      "type": "'left' | 'right' | 'top' | 'bottom'",
+      "default": "left",
+      "description": "侧边栏位置"
+    },
+    "min": {
+      "type": "number",
+      "default": "100",
+      "description": "最小宽度/高度"
+    },
+    "max": {
+      "type": "number",
+      "default": "undefined",
+      "description": "最大宽度/高度"
+    },
+    "initialDivide": {
+      "type": "number | string",
+      "default": "200",
+      "description": "初始宽度/高度"
+    },
+    "disabled": {
+      "type": "boolean",
+      "default": "false",
+      "description": "是否禁用拖拽"
+    },
+    "immediate": {
+      "type": "boolean",
+      "default": "false",
+      "description": "是否实时响应"
+    },
+    "border": {
+      "type": "boolean",
+      "default": "true",
+      "description": "是否显示边框"
+    },
+    "collapsible": {
+      "type": "boolean",
+      "default": "false",
+      "description": "是否可折叠"
+    }
+  },
+
+  "slots": {
+    "aside": {
+      "description": "侧边栏内容"
+    },
+    "main": {
+      "description": "主内容区"
+    }
+  },
+
+  "events": {
+    "resize": {
+      "params": "(size: number)",
+      "description": "拖拽时触发"
+    },
+    "resize-end": {
+      "params": "(size: number)",
+      "description": "拖拽结束时触发"
+    },
+    "collapse": {
+      "params": "(collapsed: boolean)",
+      "description": "折叠状态变化时触发"
+    }
+  }
+}

package/knowledge/component-apis/scrollbar.json

@@ -0,0 +1,73 @@
+{
+  "name": "bk-scrollbar",
+  "description": "自定义滚动条组件",
+  "version": "3.0",
+
+  "props": {
+    "height": {
+      "type": "string | number",
+      "default": "''",
+      "description": "高度"
+    },
+    "maxHeight": {
+      "type": "string | number",
+      "default": "''",
+      "description": "最大高度"
+    },
+    "native": {
+      "type": "boolean",
+      "default": "false",
+      "description": "是否使用原生滚动条"
+    },
+    "wrapStyle": {
+      "type": "string | object",
+      "default": "''",
+      "description": "包裹容器样式"
+    },
+    "wrapClass": {
+      "type": "string",
+      "default": "''",
+      "description": "包裹容器类名"
+    },
+    "viewStyle": {
+      "type": "string | object",
+      "default": "''",
+      "description": "视图容器样式"
+    },
+    "viewClass": {
+      "type": "string",
+      "default": "''",
+      "description": "视图容器类名"
+    },
+    "noresize": {
+      "type": "boolean",
+      "default": "false",
+      "description": "是否不响应尺寸变化"
+    },
+    "tag": {
+      "type": "string",
+      "default": "div",
+      "description": "视图容器标签"
+    }
+  },
+
+  "slots": {
+    "default": {
+      "description": "滚动内容"
+    }
+  },
+
+  "events": {
+    "scroll": {
+      "params": "(event)",
+      "description": "滚动时触发"
+    }
+  },
+
+  "methods": {
+    "scrollTo": "(options) - 滚动到指定位置",
+    "setScrollTop": "(top) - 设置滚动顶部位置",
+    "setScrollLeft": "(left) - 设置滚动左侧位置",
+    "update": "() - 更新滚动条状态"
+  }
+}

package/knowledge/component-apis/search-select.json

@@ -0,0 +1,74 @@
+{
+  "name": "bk-search-select",
+  "description": "搜索选择器组件",
+  "version": "3.0",
+
+  "props": {
+    "modelValue": {
+      "type": "array",
+      "default": "[]",
+      "description": "绑定值，支持 v-model"
+    },
+    "data": {
+      "type": "array",
+      "default": "[]",
+      "description": "搜索条件数据"
+    },
+    "placeholder": {
+      "type": "string",
+      "default": "请输入",
+      "description": "占位文本"
+    },
+    "clearable": {
+      "type": "boolean",
+      "default": "true",
+      "description": "是否可清空"
+    },
+    "conditions": {
+      "type": "array",
+      "default": "[]",
+      "description": "预设条件"
+    },
+    "getMenuList": {
+      "type": "function",
+      "default": "undefined",
+      "description": "异步获取菜单列表"
+    },
+    "validateValues": {
+      "type": "function",
+      "default": "undefined",
+      "description": "验证输入值"
+    }
+  },
+
+  "dataItemProps": {
+    "id": "string - 唯一标识",
+    "name": "string - 显示名称",
+    "children": "array - 子选项",
+    "multiple": "boolean - 是否多选",
+    "remote": "boolean - 是否远程搜索"
+  },
+
+  "events": {
+    "update:modelValue": {
+      "params": "(value: array)",
+      "description": "值变化时触发"
+    },
+    "change": {
+      "params": "(value: array)",
+      "description": "值改变时触发"
+    },
+    "search": {
+      "params": "(value: array)",
+      "description": "搜索时触发"
+    }
+  },
+
+  "visualMapping": {
+    "多条件组合搜索框": "bk-search-select (不是普通 bk-input)",
+    "带下拉筛选的搜索": "bk-search-select + :data",
+    "普通单一搜索框": "bk-input (不需要 search-select)"
+  },
+
+  "usageNote": "当搜索框需要支持'字段:值'的组合条件时用 bk-search-select，普通关键词搜索用 bk-input"
+}

package/knowledge/component-apis/select.json

@@ -0,0 +1,146 @@
+{
+  "name": "bk-select",
+  "description": "下拉选择组件",
+  "version": "3.0",
+
+  "props": {
+    "modelValue": {
+      "type": "string | number | array",
+      "default": "undefined",
+      "description": "绑定值，支持 v-model"
+    },
+    "multiple": {
+      "type": "boolean",
+      "default": "false",
+      "description": "是否多选"
+    },
+    "disabled": {
+      "type": "boolean",
+      "default": "false",
+      "description": "是否禁用"
+    },
+    "clearable": {
+      "type": "boolean",
+      "default": "false",
+      "description": "是否可清空"
+    },
+    "filterable": {
+      "type": "boolean",
+      "default": "false",
+      "description": "是否可搜索"
+    },
+    "placeholder": {
+      "type": "string",
+      "default": "请选择",
+      "description": "占位文本"
+    },
+    "loading": {
+      "type": "boolean",
+      "default": "false",
+      "description": "是否加载中"
+    },
+    "remoteMethod": {
+      "type": "function",
+      "default": "undefined",
+      "description": "远程搜索方法"
+    },
+    "collapseTags": {
+      "type": "boolean",
+      "default": "false",
+      "description": "多选时是否折叠标签"
+    },
+    "popoverMinWidth": {
+      "type": "number",
+      "default": "undefined",
+      "description": "下拉面板最小宽度"
+    },
+    "multipleMode": {
+      "type": "'default' | 'tag'",
+      "default": "default",
+      "description": "多选展示方式 (从源码)"
+    },
+    "showSelectAll": {
+      "type": "boolean",
+      "default": "false",
+      "description": "是否显示全选 (从源码)"
+    },
+    "selectedStyle": {
+      "type": "'check' | 'checkbox'",
+      "default": "check",
+      "description": "选中样式 (从源码)"
+    },
+    "highlightKeyword": {
+      "type": "boolean",
+      "default": "false",
+      "description": "搜索高亮 (从源码)"
+    },
+    "inputSearch": {
+      "type": "boolean",
+      "default": "false",
+      "description": "输入框搜索模式 (从源码)"
+    },
+    "allowCreate": {
+      "type": "boolean",
+      "default": "false",
+      "description": "允许创建自定义选项 (从源码)"
+    },
+    "enableVirtualRender": {
+      "type": "boolean",
+      "default": "false",
+      "description": "虚拟滚动 (从源码)"
+    }
+  },
+
+  "slots": {
+    "default": {
+      "description": "选项列表，放置 bk-option"
+    },
+    "prefix": {
+      "description": "前缀插槽"
+    },
+    "trigger": {
+      "description": "自定义触发器"
+    }
+  },
+
+  "events": {
+    "update:modelValue": {
+      "params": "(value)",
+      "description": "值变化时触发"
+    },
+    "change": {
+      "params": "(value, oldValue)",
+      "description": "选中值变化时触发"
+    },
+    "clear": {
+      "params": "()",
+      "description": "清空时触发"
+    },
+    "toggle": {
+      "params": "(isOpen: boolean)",
+      "description": "下拉框展开/收起时触发"
+    }
+  },
+
+  "relatedComponents": {
+    "bk-option": {
+      "props": {
+        "value": "string | number - 选项值 (必填)",
+        "label": "string - 选项显示文本",
+        "disabled": "boolean - 是否禁用"
+      }
+    },
+    "bk-option-group": {
+      "props": {
+        "label": "string - 分组名称"
+      }
+    }
+  },
+
+  "visualMapping": {
+    "可搜索下拉框": "filterable",
+    "多选下拉框": "multiple",
+    "多选+标签折叠": "multiple + collapse-tags",
+    "远程搜索": "filterable + :remote-method=\"fn\""
+  }
+}

package/knowledge/component-apis/sideslider.json

@@ -0,0 +1,80 @@
+{
+  "name": "bk-sideslider",
+  "description": "侧滑组件",
+  "version": "3.0",
+
+  "props": {
+    "isShow": {
+      "type": "boolean",
+      "default": "false",
+      "description": "是否显示，支持 v-model:isShow"
+    },
+    "title": {
+      "type": "string",
+      "default": "''",
+      "description": "标题"
+    },
+    "width": {
+      "type": "number",
+      "default": "400",
+      "description": "宽度"
+    },
+    "direction": {
+      "type": "'left' | 'right'",
+      "default": "right",
+      "description": "滑出方向"
+    },
+    "quickClose": {
+      "type": "boolean",
+      "default": "false",
+      "description": "是否点击遮罩关闭"
+    },
+    "showMask": {
+      "type": "boolean",
+      "default": "true",
+      "description": "是否显示遮罩"
+    },
+    "escClose": {
+      "type": "boolean",
+      "default": "true",
+      "description": "是否按 ESC 关闭"
+    },
+    "transfer": {
+      "type": "boolean",
+      "default": "false",
+      "description": "是否挂载到 body"
+    },
+    "beforeClose": {
+      "type": "function",
+      "default": "undefined",
+      "description": "关闭前的回调，返回 false 阻止关闭"
+    }
+  },
+
+  "slots": {
+    "default": {
+      "description": "内容"
+    },
+    "header": {
+      "description": "自定义头部"
+    },
+    "footer": {
+      "description": "底部内容"
+    }
+  },
+
+  "events": {
+    "update:isShow": {
+      "params": "(value: boolean)",
+      "description": "显示状态变化"
+    },
+    "shown": {
+      "params": "()",
+      "description": "显示后触发"
+    },
+    "hidden": {
+      "params": "()",
+      "description": "隐藏后触发"
+    }
+  }
+}

package/knowledge/component-apis/slider.json

@@ -0,0 +1,93 @@
+{
+  "name": "bk-slider",
+  "description": "滑动选择器组件",
+  "version": "3.0",
+
+  "props": {
+    "modelValue": {
+      "type": "number | [number, number]",
+      "default": "undefined",
+      "description": "绑定值，支持 v-model"
+    },
+    "minValue": {
+      "type": "number",
+      "default": "0",
+      "description": "最小值"
+    },
+    "maxValue": {
+      "type": "number",
+      "default": "100",
+      "description": "最大值"
+    },
+    "step": {
+      "type": "number",
+      "default": "1",
+      "description": "步长"
+    },
+    "range": {
+      "type": "boolean",
+      "default": "false",
+      "description": "是否为范围选择"
+    },
+    "disable": {
+      "type": "boolean",
+      "default": "false",
+      "description": "是否禁用"
+    },
+    "vertical": {
+      "type": "boolean",
+      "default": "false",
+      "description": "是否垂直模式"
+    },
+    "height": {
+      "type": "string",
+      "default": "200px",
+      "description": "垂直模式高度"
+    },
+    "showTip": {
+      "type": "boolean",
+      "default": "false",
+      "description": "是否显示 tooltip"
+    },
+    "showInterval": {
+      "type": "boolean",
+      "default": "false",
+      "description": "是否显示间断点"
+    },
+    "showIntervalLabel": {
+      "type": "boolean",
+      "default": "false",
+      "description": "是否显示间断点文字"
+    },
+    "showInput": {
+      "type": "boolean",
+      "default": "false",
+      "description": "是否显示输入框"
+    },
+    "formatterLabel": {
+      "type": "function",
+      "default": "(value) => value",
+      "description": "间断点文字格式化"
+    }
+  },
+
+  "slots": {
+    "start": {
+      "description": "滑块左侧/上方内容"
+    },
+    "end": {
+      "description": "滑块右侧/下方内容"
+    }
+  },
+
+  "events": {
+    "update:modelValue": {
+      "params": "(value)",
+      "description": "值变化时触发"
+    },
+    "change": {
+      "params": "(value)",
+      "description": "值改变时触发"
+    }
+  }
+}