@blueking/bkui-knowledge 0.0.1-beta.1

package/knowledge/component-apis/collapse.json

@@ -0,0 +1,96 @@
+{
+  "name": "bk-collapse",
+  "description": "折叠面板组件",
+  "version": "3.0",
+
+  "props": {
+    "modelValue": {
+      "type": "string | number | array",
+      "default": "undefined",
+      "description": "当前展开的面板，支持 v-model"
+    },
+    "accordion": {
+      "type": "boolean",
+      "default": "false",
+      "description": "是否手风琴模式"
+    },
+    "list": {
+      "type": "array",
+      "default": "[]",
+      "description": "面板数据列表"
+    },
+    "idFiled": {
+      "type": "string",
+      "default": "name",
+      "description": "列表数据中标识字段"
+    },
+    "titleField": {
+      "type": "string",
+      "default": "title",
+      "description": "列表数据中标题字段"
+    },
+    "contentField": {
+      "type": "string",
+      "default": "content",
+      "description": "列表数据中内容字段"
+    },
+    "hasHeaderBorder": {
+      "type": "boolean",
+      "default": "false",
+      "description": "是否显示头部边框线"
+    },
+    "hasHeaderHover": {
+      "type": "boolean",
+      "default": "false",
+      "description": "是否显示头部 hover 效果"
+    },
+    "useCardTheme": {
+      "type": "boolean",
+      "default": "false",
+      "description": "是否使用卡片样式"
+    },
+    "useBlockTheme": {
+      "type": "boolean",
+      "default": "false",
+      "description": "是否使用色块样式"
+    },
+    "headerIconAlign": {
+      "type": "'left' | 'right'",
+      "default": "right",
+      "description": "图标位置"
+    }
+  },
+
+  "slots": {
+    "default": {
+      "description": "面板内容，放置 bk-collapse-panel"
+    },
+    "title": {
+      "description": "自定义标题"
+    },
+    "content": {
+      "description": "自定义内容"
+    }
+  },
+
+  "events": {
+    "update:modelValue": {
+      "params": "(value)",
+      "description": "展开状态变化"
+    },
+    "item-click": {
+      "params": "(item)",
+      "description": "点击面板时触发"
+    }
+  },
+
+  "relatedComponents": {
+    "bk-collapse-panel": {
+      "props": {
+        "name": "string | number - 面板唯一标识",
+        "title": "string - 标题",
+        "disabled": "boolean - 是否禁用"
+      }
+    }
+  }
+}

package/knowledge/component-apis/color-picker.json

@@ -0,0 +1,60 @@
+{
+  "name": "bk-color-picker",
+  "description": "颜色选择器组件",
+  "version": "3.0",
+
+  "props": {
+    "modelValue": {
+      "type": "string",
+      "default": "''",
+      "description": "绑定值，支持 v-model"
+    },
+    "disabled": {
+      "type": "boolean",
+      "default": "false",
+      "description": "是否禁用"
+    },
+    "readonly": {
+      "type": "boolean",
+      "default": "false",
+      "description": "是否只读"
+    },
+    "size": {
+      "type": "'small' | 'large'",
+      "default": "undefined",
+      "description": "尺寸"
+    },
+    "showValue": {
+      "type": "boolean",
+      "default": "true",
+      "description": "是否显示色值"
+    },
+    "transfer": {
+      "type": "boolean",
+      "default": "false",
+      "description": "是否挂载到 body"
+    },
+    "recommend": {
+      "type": "boolean | array",
+      "default": "true",
+      "description": "是否显示推荐色或自定义推荐色"
+    }
+  },
+
+  "slots": {
+    "default": {
+      "description": "自定义触发器"
+    }
+  },
+
+  "events": {
+    "update:modelValue": {
+      "params": "(value: string)",
+      "description": "值变化时触发"
+    },
+    "change": {
+      "params": "(value: string)",
+      "description": "颜色改变时触发"
+    }
+  }
+}

package/knowledge/component-apis/config-provider.json

@@ -0,0 +1,29 @@
+{
+  "name": "bk-config-provider",
+  "description": "全局配置组件",
+  "version": "3.0",
+
+  "props": {
+    "locale": {
+      "type": "object",
+      "default": "undefined",
+      "description": "国际化配置"
+    },
+    "prefix": {
+      "type": "string",
+      "default": "bk",
+      "description": "组件类名前缀"
+    }
+  },
+
+  "slots": {
+    "default": {
+      "description": "包裹的内容"
+    }
+  },
+
+  "usage": {
+    "example": "<bk-config-provider :locale=\"zhCN\"><App /></bk-config-provider>",
+    "note": "通常放在应用根组件"
+  }
+}

package/knowledge/component-apis/container.json

@@ -0,0 +1,59 @@
+{
+  "name": "bk-container",
+  "description": "栅格布局容器组件",
+  "version": "3.0",
+
+  "props": {
+    "col": {
+      "type": "number",
+      "default": "24",
+      "description": "列数"
+    },
+    "gutter": {
+      "type": "number",
+      "default": "20",
+      "description": "列间距"
+    },
+    "margin": {
+      "type": "number",
+      "default": "20",
+      "description": "外边距"
+    },
+    "flex": {
+      "type": "boolean",
+      "default": "false",
+      "description": "是否使用 flex 布局"
+    },
+    "extCls": {
+      "type": "string",
+      "default": "''",
+      "description": "自定义类名"
+    }
+  },
+
+  "slots": {
+    "default": {
+      "description": "容器内容，放置 bk-row/bk-col"
+    }
+  },
+
+  "relatedComponents": {
+    "bk-row": {
+      "description": "行容器",
+      "props": {
+        "gutter": "number - 列间距",
+        "justify": "string - 水平对齐方式",
+        "align": "string - 垂直对齐方式"
+      }
+    },
+    "bk-col": {
+      "description": "列容器",
+      "props": {
+        "span": "number - 占据列数",
+        "offset": "number - 偏移列数",
+        "push": "number - 向右移动列数",
+        "pull": "number - 向左移动列数"
+      }
+    }
+  }
+}

package/knowledge/component-apis/date-picker.json

@@ -0,0 +1,84 @@
+{
+  "name": "bk-date-picker",
+  "description": "日期选择器组件",
+  "version": "3.0",
+
+  "props": {
+    "modelValue": {
+      "type": "Date | string | array",
+      "default": "undefined",
+      "description": "绑定值，支持 v-model"
+    },
+    "type": {
+      "type": "'date' | 'daterange' | 'datetime' | 'datetimerange' | 'month' | 'year'",
+      "default": "date",
+      "description": "选择器类型"
+    },
+    "format": {
+      "type": "string",
+      "default": "yyyy-MM-dd",
+      "description": "显示格式"
+    },
+    "placeholder": {
+      "type": "string",
+      "default": "请选择日期",
+      "description": "占位文本"
+    },
+    "disabled": {
+      "type": "boolean",
+      "default": "false",
+      "description": "是否禁用"
+    },
+    "readonly": {
+      "type": "boolean",
+      "default": "false",
+      "description": "是否只读"
+    },
+    "clearable": {
+      "type": "boolean",
+      "default": "true",
+      "description": "是否可清空"
+    },
+    "disabledDate": {
+      "type": "function",
+      "default": "undefined",
+      "description": "禁用日期函数 (date) => boolean"
+    },
+    "shortcuts": {
+      "type": "array",
+      "default": "[]",
+      "description": "快捷选项配置"
+    }
+  },
+
+  "slots": {
+    "trigger": {
+      "description": "自定义触发器"
+    },
+    "header": {
+      "description": "面板头部"
+    },
+    "footer": {
+      "description": "面板底部"
+    }
+  },
+
+  "events": {
+    "update:modelValue": {
+      "params": "(value)",
+      "description": "值变化时触发"
+    },
+    "change": {
+      "params": "(value, type)",
+      "description": "值改变时触发"
+    },
+    "open-change": {
+      "params": "(isOpen: boolean)",
+      "description": "面板展开/收起时触发"
+    },
+    "pick": {
+      "params": "(value)",
+      "description": "选择日期时触发"
+    }
+  }
+}

package/knowledge/component-apis/dialog.json

@@ -0,0 +1,124 @@
+{
+  "name": "bk-dialog",
+  "description": "对话框组件",
+  "version": "3.0",
+
+  "props": {
+    "isShow": {
+      "type": "boolean",
+      "default": "false",
+      "description": "是否显示，支持 v-model:isShow"
+    },
+    "title": {
+      "type": "string",
+      "default": "''",
+      "description": "标题"
+    },
+    "width": {
+      "type": "string | number",
+      "default": "480",
+      "description": "宽度"
+    },
+    "draggable": {
+      "type": "boolean",
+      "default": "false",
+      "description": "是否可拖拽"
+    },
+    "confirmText": {
+      "type": "string",
+      "default": "确定",
+      "description": "确认按钮文字"
+    },
+    "cancelText": {
+      "type": "string",
+      "default": "取消",
+      "description": "取消按钮文字"
+    },
+    "headerAlign": {
+      "type": "'left' | 'center' | 'right'",
+      "default": "left",
+      "description": "标题对齐方式"
+    },
+    "footerAlign": {
+      "type": "'left' | 'center' | 'right'",
+      "default": "right",
+      "description": "底部按钮对齐方式"
+    },
+    "isLoading": {
+      "type": "boolean",
+      "default": "false",
+      "description": "确认按钮是否 loading"
+    },
+    "closeIcon": {
+      "type": "boolean",
+      "default": "true",
+      "description": "是否显示关闭图标"
+    },
+    "escClose": {
+      "type": "boolean",
+      "default": "true",
+      "description": "是否按 ESC 关闭"
+    },
+    "quickClose": {
+      "type": "boolean",
+      "default": "true",
+      "description": "是否点击遮罩关闭"
+    },
+    "fullscreen": {
+      "type": "boolean",
+      "default": "false",
+      "description": "是否全屏"
+    },
+    "transfer": {
+      "type": "boolean",
+      "default": "true",
+      "description": "是否挂载到 body"
+    }
+  },
+
+  "slots": {
+    "default": {
+      "description": "对话框内容"
+    },
+    "header": {
+      "description": "自定义头部"
+    },
+    "footer": {
+      "description": "自定义底部"
+    }
+  },
+
+  "events": {
+    "update:isShow": {
+      "params": "(value: boolean)",
+      "description": "显示状态变化"
+    },
+    "confirm": {
+      "params": "()",
+      "description": "点击确认按钮"
+    },
+    "cancel": {
+      "params": "()",
+      "description": "点击取消按钮"
+    },
+    "closed": {
+      "params": "()",
+      "description": "关闭动画结束后"
+    }
+  },
+
+  "commonMistakes": [
+    {
+      "wrong": "<bk-dialog v-model=\"visible\">",
+      "correct": "<bk-dialog v-model:isShow=\"visible\">",
+      "reason": "bk-dialog 使用 v-model:isShow 而不是 v-model"
+    }
+  ],
+
+  "visualMapping": {
+    "标准编辑弹窗": "width=\"640\"",
+    "确认提示弹窗": "width=\"400\"",
+    "大型表单弹窗": "width=\"960\"",
+    "全屏弹窗": "fullscreen"
+  }
+}

package/knowledge/component-apis/divider.json

@@ -0,0 +1,39 @@
+{
+  "name": "bk-divider",
+  "description": "分割线组件",
+  "version": "3.0",
+
+  "props": {
+    "direction": {
+      "type": "'horizontal' | 'vertical'",
+      "default": "horizontal",
+      "description": "方向"
+    },
+    "align": {
+      "type": "'left' | 'center' | 'right'",
+      "default": "center",
+      "description": "文字位置"
+    },
+    "color": {
+      "type": "string",
+      "default": "#dde4eb",
+      "description": "分割线颜色"
+    },
+    "width": {
+      "type": "number",
+      "default": "1",
+      "description": "分割线宽度"
+    },
+    "type": {
+      "type": "'solid' | 'dashed'",
+      "default": "solid",
+      "description": "线条类型"
+    }
+  },
+
+  "slots": {
+    "default": {
+      "description": "分割线中的文字内容"
+    }
+  }
+}

package/knowledge/component-apis/dropdown.json

@@ -0,0 +1,60 @@
+{
+  "name": "bk-dropdown",
+  "description": "下拉菜单组件",
+  "version": "3.0",
+
+  "props": {
+    "disabled": {
+      "type": "boolean",
+      "default": "false",
+      "description": "是否禁用"
+    },
+    "trigger": {
+      "type": "'hover' | 'click' | 'manual'",
+      "default": "hover",
+      "description": "触发方式"
+    },
+    "placement": {
+      "type": "'top' | 'bottom' | 'left' | 'right'",
+      "default": "bottom",
+      "description": "弹出位置"
+    },
+    "isShow": {
+      "type": "boolean",
+      "default": "false",
+      "description": "是否显示 (manual 模式)"
+    }
+  },
+
+  "slots": {
+    "default": {
+      "description": "触发元素"
+    },
+    "content": {
+      "description": "下拉内容，放置 bk-dropdown-menu"
+    }
+  },
+
+  "events": {
+    "show": {
+      "params": "()",
+      "description": "显示时触发"
+    },
+    "hide": {
+      "params": "()",
+      "description": "隐藏时触发"
+    }
+  },
+
+  "relatedComponents": {
+    "bk-dropdown-menu": {
+      "description": "下拉菜单容器"
+    },
+    "bk-dropdown-item": {
+      "props": {
+        "disabled": "boolean - 是否禁用",
+        "divided": "boolean - 是否显示分割线"
+      }
+    }
+  }
+}

package/knowledge/component-apis/exception.json

@@ -0,0 +1,43 @@
+{
+  "name": "bk-exception",
+  "description": "异常状态组件",
+  "version": "3.0",
+
+  "props": {
+    "type": {
+      "type": "'403' | '404' | '500' | 'building' | 'empty' | 'search-empty' | 'login'",
+      "default": "404",
+      "description": "异常类型"
+    },
+    "scene": {
+      "type": "'page' | 'part'",
+      "default": "page",
+      "description": "场景: 整页或局部"
+    },
+    "title": {
+      "type": "string",
+      "default": "undefined",
+      "description": "标题"
+    },
+    "description": {
+      "type": "string",
+      "default": "undefined",
+      "description": "描述"
+    }
+  },
+
+  "slots": {
+    "default": {
+      "description": "底部操作区域"
+    },
+    "type": {
+      "description": "自定义图片"
+    },
+    "title": {
+      "description": "自定义标题"
+    },
+    "description": {
+      "description": "自定义描述"
+    }
+  }
+}

package/knowledge/component-apis/fixed-navbar.json

@@ -0,0 +1,43 @@
+{
+  "name": "bk-fixed-navbar",
+  "description": "固定导航栏组件",
+  "version": "3.0",
+
+  "props": {
+    "navItems": {
+      "type": "array",
+      "default": "[]",
+      "description": "导航项列表"
+    },
+    "position": {
+      "type": "'left' | 'middle' | 'right'",
+      "default": "middle",
+      "description": "位置"
+    },
+    "extCls": {
+      "type": "string",
+      "default": "''",
+      "description": "自定义类名"
+    }
+  },
+
+  "navItemProps": {
+    "icon": "string | VNode - 图标",
+    "text": "string - 文字",
+    "action": "function - 点击回调",
+    "tooltip": "string | object - 提示"
+  },
+
+  "slots": {
+    "default": {
+      "description": "自定义导航项"
+    }
+  },
+
+  "events": {
+    "click": {
+      "params": "(item, index)",
+      "description": "点击导航项时触发"
+    }
+  }
+}