@blueking/bkui-knowledge 0.0.1-beta.13 → 0.0.1-beta.15

package/knowledge/component-apis/vue2/back-top.json

@@ -0,0 +1,37 @@
+{
+  "description": "点击按钮快速回到页面顶部，可以配置显示的位置和条件",
+  "events": {
+    "click": {
+      "description": "点击按钮所触发的事件",
+      "params": "()"
+    }
+  },
+  "name": "bk-back-top",
+  "props": {
+    "bottom": {
+      "default": "40",
+      "description": "控制组件显示的位置，距离有页面底部的距离",
+      "type": "Number | String"
+    },
+    "right": {
+      "default": "40",
+      "description": "控制组件显示的位置，距离有页面右侧的距离",
+      "type": "Number"
+    },
+    "target": {
+      "default": "-",
+      "description": "触发滚动的对象",
+      "type": "String"
+    },
+    "visibility-height": {
+      "default": "200",
+      "description": "滚动高度达到此参数值才出现",
+      "type": "Number"
+    }
+  },
+  "slots": {
+    "default": {
+      "description": "自定义显示内容"
+    }
+  }
+}

package/knowledge/component-apis/vue2/badge.json

@@ -0,0 +1,71 @@
+{
+  "description": "可以出现在任意 DOM 节点角上的数字或状态标记",
+  "events": {
+    "hover": {
+      "description": "广播给父组件 mouseover 事件",
+      "params": "()"
+    },
+    "leave": {
+      "description": "广播给父组件 mouseleave 事件",
+      "params": "()"
+    }
+  },
+  "name": "bk-badge",
+  "props": {
+    "dot": {
+      "default": "-",
+      "description": "是否仅显示小圆点；当设置 dot 为 true 时，value, icon, max 均会被忽略",
+      "type": "Boolean"
+    },
+    "ext-cls": {
+      "default": "-",
+      "description": "配置自定义样式类名，传入的类会被加在组件最外层的 DOM .bk-badge-wrapper 上",
+      "type": "String"
+    },
+    "icon": {
+      "default": "-",
+      "description": "组件显示图标；当设置 icon 时，将忽略设置的 value 值",
+      "type": "String"
+    },
+    "max": {
+      "default": "-",
+      "description": "组件显示的最大值，当 value 超过 max，显示数字 +；仅当设置了 Number 类型的 value 值时生效",
+      "type": "Number"
+    },
+    "position": {
+      "default": "top-right",
+      "description": "组件相对于其兄弟组件的位置",
+      "type": "'top-right' | 'bottom-right' | 'bottom-left' | 'top-left'"
+    },
+    "radius": {
+      "default": "18px",
+      "description": "配置自定义弧度，以实现多种形状",
+      "type": "String | Number"
+    },
+    "theme": {
+      "default": "primary",
+      "description": "组件的主题色",
+      "type": "'primary' | 'info' | 'warning' | 'danger' | 'success'"
+    },
+    "val": {
+      "default": "1",
+      "description": "组件显示的值",
+      "type": "Number | String"
+    },
+    "valLength": {
+      "default": "3",
+      "description": "配置val字符显示长度，最大值建议英文不超过3个字母，中文不超过2个汉字(一个汉字长度算作2)",
+      "type": "Number"
+    },
+    "visible": {
+      "default": "-",
+      "description": "是否显示组件",
+      "type": "Boolean"
+    }
+  },
+  "slots": {
+    "default": {
+      "description": "默认插槽，用于放置需要添加标记的元素"
+    }
+  }
+}

package/knowledge/component-apis/vue2/big-tree.json

@@ -0,0 +1,202 @@
+{
+  "description": "非递归渲染的树组件，适用于渲染大量树节点，更快的渲染速度，更少的内存使用，并且节点状态不污染原始数据",
+  "events": {
+    "check-change": {
+      "description": "复选节点发生变化时触发",
+      "params": "(id | id[], checked: boolean)"
+    },
+    "disable-change": {
+      "description": "禁用/启用节点时触发",
+      "params": "(TreeNode | TreeNode[])"
+    },
+    "expand-change": {
+      "description": "展开/折叠节点时触发",
+      "params": "(TreeNode)"
+    },
+    "select-change": {
+      "description": "选中的节点发生变化时触发",
+      "params": "(TreeNode)"
+    }
+  },
+  "name": "bk-big-tree",
+  "props": {
+    "before-check": {
+      "default": "-",
+      "description": "复选节点前的回调函数，返回false时将终止后续的复选动作",
+      "type": "Function(node | [node])"
+    },
+    "before-select": {
+      "default": "-",
+      "description": "选中节点前的回调函数，返回false时将终止后续的选中动作",
+      "type": "Function(node)"
+    },
+    "check-on-click": {
+      "default": "false",
+      "description": "点击节点时复选/取消复选",
+      "type": "Boolean"
+    },
+    "check-only-available-strictly": {
+      "default": "false",
+      "description": "在显示复选框且严格的遵循父子互相关联的情况下，是否仅关联可用节点",
+      "type": "Boolean"
+    },
+    "check-strictly": {
+      "default": "true",
+      "description": "在显示复选框的情况下，是否严格的遵循父子互相关联的做法",
+      "type": "Boolean"
+    },
+    "collapse-icon": {
+      "default": "bk-icon icon-down-shape",
+      "description": "展开时的图标",
+      "type": "String"
+    },
+    "configurable": {
+      "default": "true",
+      "description": "仅作为数据展示用时，可将此属性配置为false，从而节省渲染开销",
+      "type": "Boolean"
+    },
+    "data": {
+      "default": "-",
+      "description": "同步渲染数据，异步数据请使用组件实例的setData方法进行渲染",
+      "type": "Array"
+    },
+    "default-checked-nodes": {
+      "default": "-",
+      "description": "默认勾选的节点id集合",
+      "type": "Array"
+    },
+    "default-expand-all": {
+      "default": "false",
+      "description": "默认展开全部节点",
+      "type": "Boolean"
+    },
+    "default-expanded-nodes": {
+      "default": "-",
+      "description": "默认展开的节点id集合",
+      "type": "Array"
+    },
+    "default-selected-node": {
+      "default": "-",
+      "description": "默认选中的节点id，selectable为false时无效",
+      "type": "String | Number"
+    },
+    "disable-strictly": {
+      "default": "true",
+      "description": "禁用/启用节点时，是否严格的遵循子节点跟随当前节点一同变化的做法",
+      "type": "Boolean"
+    },
+    "display-matched-node-descendants": {
+      "default": "false",
+      "description": "筛选时，节点命中后，是否显示后代节点",
+      "type": "Boolean"
+    },
+    "enable-title-tip": {
+      "default": "false",
+      "description": "是否开启节点tip提示",
+      "type": "Boolean"
+    },
+    "expand-icon": {
+      "default": "bk-icon icon-down-shape",
+      "description": "折叠时的图标",
+      "type": "String"
+    },
+    "expand-on-click": {
+      "default": "true",
+      "description": "点击节点时展开/折叠",
+      "type": "Boolean"
+    },
+    "ext-cls": {
+      "default": "-",
+      "description": "配置自定义样式类名，传入的类会被加在组件最外层的 DOM .bk-big-tree 上",
+      "type": "String"
+    },
+    "filter-method": {
+      "default": "-",
+      "description": "筛选节点的方法, 默认按节点的名称进行筛选",
+      "type": "Function(keyword, node)"
+    },
+    "fixed-width": {
+      "default": "false",
+      "description": "是否使用固定宽度布局",
+      "type": "Boolean"
+    },
+    "height": {
+      "default": "-",
+      "description": "容器高度，设置此属性可开启虚拟滚动，支持渲染大量数据",
+      "type": "Number"
+    },
+    "lazy-disabled": {
+      "default": "-",
+      "description": "是否禁用异步加载节点",
+      "type": "Function | Boolean"
+    },
+    "lazy-method": {
+      "default": "-",
+      "description": "异步加载子节点的方法",
+      "type": "Function(node)"
+    },
+    "loading-class": {
+      "default": "node-loading",
+      "description": "节点处于异步加载子节点时的类名",
+      "type": "String"
+    },
+    "node-height": {
+      "default": "32",
+      "description": "单个节点的高度，用于虚拟滚动的数据计算",
+      "type": "Number"
+    },
+    "node-icon": {
+      "default": "-",
+      "description": "节点的图标",
+      "type": "String | Function"
+    },
+    "node-width": {
+      "default": "-",
+      "description": "节点宽度(px)，设定该值后，将动态判断是否应用宽度",
+      "type": "String | Number"
+    },
+    "options": {
+      "default": "-",
+      "description": "配置项，包含idKey、nameKey、childrenKey、isFolder等",
+      "type": "Object"
+    },
+    "padding": {
+      "default": "16",
+      "description": "节点左侧缩进的距离",
+      "type": "Number"
+    },
+    "selectable": {
+      "default": "false",
+      "description": "节点是否可以选中",
+      "type": "Boolean"
+    },
+    "show-checkbox": {
+      "default": "false",
+      "description": "是否显示节点复选框，为Function时返回true显示",
+      "type": "Boolean | Function(data)"
+    },
+    "show-link-line": {
+      "default": "false",
+      "description": "是否显示层级连线",
+      "type": "Boolean"
+    },
+    "size": {
+      "default": "normal",
+      "description": "树的尺寸",
+      "type": "'normal' | 'small'"
+    },
+    "use-default-empty": {
+      "default": "false",
+      "description": "无搜索结果时，是否显示默认的无结果UI",
+      "type": "Boolean"
+    }
+  },
+  "slots": {
+    "default": {
+      "description": "匿名作用域插槽, 提供node、data两个props"
+    },
+    "empty": {
+      "description": "搜索结果为空时的插槽"
+    }
+  }
+}

package/knowledge/component-apis/vue2/breadcrumb.json

@@ -0,0 +1,27 @@
+{
+  "description": "显示当前页面的路径，快速返回之前的任意页面。",
+  "events": {},
+  "name": "bk-breadcrumb",
+  "props": {
+    "back-router": {
+      "default": "-",
+      "description": "路由跳转对象，同 vue-router 的 to",
+      "type": "String | Object"
+    },
+    "separator": {
+      "default": "/",
+      "description": "分隔符",
+      "type": "String"
+    },
+    "separator-class": {
+      "default": "-",
+      "description": "图标分隔符 class",
+      "type": "String"
+    }
+  },
+  "slots": {
+    "prefix": {
+      "description": "用于面包屑返回区域的插槽"
+    }
+  }
+}

package/knowledge/component-apis/vue2/button.json

@@ -0,0 +1,72 @@
+{
+  "description": "常用的操作按钮",
+  "events": {
+    "click": {
+      "description": "点击事件",
+      "params": "(event: Event)"
+    }
+  },
+  "name": "bk-button",
+  "props": {
+    "disabled": {
+      "default": "false",
+      "description": "是否禁用",
+      "type": "Boolean"
+    },
+    "ext-cls": {
+      "default": "-",
+      "description": "配置自定义样式类名，传入的类会被加在组件最外层的 DOM button 上",
+      "type": "String"
+    },
+    "hover-theme": {
+      "default": "-",
+      "description": "mouseover 按钮类型，当设置了此属性时，theme 和 text 失效",
+      "type": "'primary' | 'success' | 'warning' | 'danger'"
+    },
+    "icon": {
+      "default": "-",
+      "description": "左侧图标，设置为 loading 的时候，会显示转圈的 loading 效果",
+      "type": "String"
+    },
+    "icon-right": {
+      "default": "-",
+      "description": "右侧图标，设置为 loading 的时候，会显示转圈的 loading 效果",
+      "type": "String"
+    },
+    "loading": {
+      "default": "false",
+      "description": "是否加载中",
+      "type": "Boolean"
+    },
+    "outline": {
+      "default": "false",
+      "description": "是否显示反色按钮",
+      "type": "Boolean"
+    },
+    "size": {
+      "default": "normal",
+      "description": "尺寸",
+      "type": "'small' | 'normal' | 'large'"
+    },
+    "text": {
+      "default": "false",
+      "description": "是否是文字按钮",
+      "type": "Boolean"
+    },
+    "theme": {
+      "default": "default",
+      "description": "按钮类型",
+      "type": "'default' | 'primary' | 'success' | 'warning' | 'danger'"
+    },
+    "title": {
+      "default": "-",
+      "description": "title 文案",
+      "type": "String"
+    }
+  },
+  "slots": {
+    "default": {
+      "description": "按钮内容"
+    }
+  }
+}

package/knowledge/component-apis/vue2/card.json

@@ -0,0 +1,73 @@
+{
+  "description": "卡片是一种容器，可以将信息聚合展示。",
+  "events": {
+    "edit": {
+      "description": "编辑标题事件",
+      "params": "(title: string)"
+    }
+  },
+  "name": "bk-card",
+  "props": {
+    "border": {
+      "default": "true",
+      "description": "是否显示边框",
+      "type": "Boolean"
+    },
+    "collapse-icons": {
+      "default": "['icon-down-shape', 'icon-up-shape']",
+      "description": "支持自定义展开 & 收起的icon",
+      "type": "Array"
+    },
+    "collapse-status": {
+      "default": "true",
+      "description": "展开 & 收起状态",
+      "type": "Boolean"
+    },
+    "disableHeaderStyle": {
+      "default": "false",
+      "description": "是否禁用Header的line-height默认样式",
+      "type": "Boolean"
+    },
+    "is-collapse": {
+      "default": "false",
+      "description": "是否支持展开&收起",
+      "type": "Boolean"
+    },
+    "isEdit": {
+      "default": "false",
+      "description": "是否启用编辑标题功能",
+      "type": "Boolean"
+    },
+    "position": {
+      "default": "left",
+      "description": "展开icon的显示位置",
+      "type": "'left' | 'right'"
+    },
+    "showFoot": {
+      "default": "false",
+      "description": "是否显示底部",
+      "type": "Boolean"
+    },
+    "showHead": {
+      "default": "true",
+      "description": "是否显示头部",
+      "type": "Boolean"
+    },
+    "title": {
+      "default": "-",
+      "description": "卡片标题",
+      "type": "String"
+    }
+  },
+  "slots": {
+    "default": {
+      "description": "自定义 Card 中间内容的展示"
+    },
+    "footer": {
+      "description": "可用该插槽，自定义 Card 中底部内容 的展示"
+    },
+    "header": {
+      "description": "可用该插槽，自定义 Card 中顶部内容 的展示"
+    }
+  }
+}

package/knowledge/component-apis/vue2/cascade.json

@@ -0,0 +1,148 @@
+{
+  "description": "将动作或菜单折叠到下拉菜单中，支持单选和多选",
+  "events": {
+    "change": {
+      "description": "选项发生变化时调用",
+      "params": "(newValue, oldValue, selectList)"
+    },
+    "clear": {
+      "description": "清空选项时调用",
+      "params": "(oldValue)"
+    },
+    "search": {
+      "description": "搜索输入时调用",
+      "params": "(string, event)"
+    },
+    "toggle": {
+      "description": "切换下拉折叠状态时调用",
+      "params": "(Boolean)"
+    }
+  },
+  "name": "bk-cascade",
+  "props": {
+    "allow-disabled-expand": {
+      "default": "false",
+      "description": "选项禁用是否允许展开下一级，默认不允许",
+      "type": "Boolean"
+    },
+    "change-immediately": {
+      "default": "false",
+      "description": "当打开了搜索功能，是否开启选择立即改变",
+      "type": "Boolean"
+    },
+    "check-any-level": {
+      "default": "false",
+      "description": "是否允许选择任意一级",
+      "type": "Boolean"
+    },
+    "clearable": {
+      "default": "false",
+      "description": "是否允许清空",
+      "type": "Boolean"
+    },
+    "disabled": {
+      "default": "false",
+      "description": "是否禁用",
+      "type": "Boolean"
+    },
+    "ext-popover-cls": {
+      "default": "-",
+      "description": "配置自定义样式类名，传入的类会被加在下拉菜单的 DOM .bk-cascade-dropdown-content 上",
+      "type": "String"
+    },
+    "filterable": {
+      "default": "false",
+      "description": "是否允许快捷搜索",
+      "type": "Boolean"
+    },
+    "is-remote": {
+      "default": "false",
+      "description": "开启远程加载，搭配remote-method一起使用",
+      "type": "Boolean"
+    },
+    "limit-one-line": {
+      "default": "false",
+      "description": "限制是否只显示一行（仅当 multiple 为 true 时生效）",
+      "type": "Boolean"
+    },
+    "list": {
+      "default": "[]",
+      "description": "可选项数据源",
+      "type": "Array"
+    },
+    "max-width": {
+      "default": "100%",
+      "description": "设置弹出框最大宽度",
+      "type": "String | Number"
+    },
+    "multiple": {
+      "default": "false",
+      "description": "是否多选",
+      "type": "Boolean"
+    },
+    "options": {
+      "default": "-",
+      "description": "配置项，包含idKey、nameKey、childrenKey",
+      "type": "Object"
+    },
+    "placeholder": {
+      "default": "请选择",
+      "description": "未选择数据时的占位",
+      "type": "String"
+    },
+    "popover-options": {
+      "default": "-",
+      "description": "透传至下拉列表所在的popover组件的tippyOptions选项",
+      "type": "Object"
+    },
+    "remote-method": {
+      "default": "-",
+      "description": "远程搜索方法",
+      "type": "Function"
+    },
+    "scroll-height": {
+      "default": "216",
+      "description": "下拉列表滚动高度",
+      "type": "Number"
+    },
+    "scroll-width": {
+      "default": "160",
+      "description": "子版面的宽度",
+      "type": "Number"
+    },
+    "separator": {
+      "default": " / ",
+      "description": "选项分隔符",
+      "type": "String"
+    },
+    "show-complete-name": {
+      "default": "true",
+      "description": "输入框中是否显示选中值的完整路径",
+      "type": "Boolean"
+    },
+    "trigger": {
+      "default": "click",
+      "description": "触发子菜单模式",
+      "type": "'click' | 'hover'"
+    },
+    "value": {
+      "default": "[]",
+      "description": "当前被选中的值,支持v-model, 多选时配置一个二维数组",
+      "type": "Array"
+    }
+  },
+  "slots": {
+    "extension": {
+      "description": "固定在下拉列表最后的内容"
+    },
+    "option": {
+      "description": "自定义节点内容插槽"
+    },
+    "prepend": {
+      "description": "节点前置内容插槽"
+    },
+    "trigger": {
+      "description": "自定义触发器插槽"
+    }
+  }
+}

package/knowledge/component-apis/vue2/changelog.json

@@ -0,0 +1,7 @@
+{
+  "description": "组件库更新日志，记录版本更新内容",
+  "events": {},
+  "name": "changelog",
+  "props": {},
+  "slots": {}
+}