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

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

@@ -0,0 +1,73 @@
+{
+  "description": "提供一个从两侧滑入的组件，供用户填写/查看更多信息",
+  "events": {
+    "animation-end": {
+      "description": "关闭组件后动画结束的回调函数",
+      "params": "()"
+    },
+    "hidden": {
+      "description": "关闭组件后的回调函数",
+      "params": "()"
+    },
+    "shown": {
+      "description": "显示组件后的回调函数",
+      "params": "()"
+    }
+  },
+  "name": "bk-sideslider",
+  "props": {
+    "before-close": {
+      "default": "-",
+      "description": "关闭前钩子函数",
+      "type": "Function"
+    },
+    "direction": {
+      "default": "right",
+      "description": "组件滑出的方向",
+      "type": "'left' | 'right'"
+    },
+    "ext-cls": {
+      "default": "-",
+      "description": "配置自定义样式类名，传入的类会被加在组件最外层的 DOM .bk-sideslider 上",
+      "type": "String"
+    },
+    "is-show": {
+      "default": "false",
+      "description": "是否显示组件，支持 .sync 修饰符",
+      "type": "Boolean"
+    },
+    "quick-close": {
+      "default": "false",
+      "description": "是否支持点击遮罩关闭组件",
+      "type": "Boolean"
+    },
+    "show-mask": {
+      "default": "true",
+      "description": "是否允许出现遮罩",
+      "type": "Boolean"
+    },
+    "title": {
+      "default": "-",
+      "description": "自定义组件标题",
+      "type": "String"
+    },
+    "transfer": {
+      "default": "false",
+      "description": "控制 sidslider 是否出现在 body 内",
+      "type": "Boolean"
+    },
+    "width": {
+      "default": "400",
+      "description": "组件的宽度",
+      "type": "Number"
+    }
+  },
+  "slots": {
+    "content": {
+      "description": "用于设置侧栏内容区"
+    },
+    "footer": {
+      "description": "用于设置侧栏底部区"
+    }
+  }
+}

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

@@ -0,0 +1,120 @@
+{
+  "description": "滑动选择器，用于在指定范围内进行数值选择",
+  "events": {
+    "change": {
+      "description": "鼠标弹起时触发",
+      "params": "(value)"
+    }
+  },
+  "name": "bk-slider",
+  "props": {
+    "button-label-unit": {
+      "default": "-",
+      "description": "滑块下是否显示单位",
+      "type": "String"
+    },
+    "custom-content": {
+      "default": "-",
+      "description": "自定义内容",
+      "type": "Object"
+    },
+    "disable": {
+      "default": "false",
+      "description": "拖拽禁用",
+      "type": "Boolean"
+    },
+    "ext-cls": {
+      "default": "-",
+      "description": "配置自定义样式类名，传入的类会被加在组件最外层的 DOM .bk-slider 上",
+      "type": "String"
+    },
+    "height": {
+      "default": "200px",
+      "description": "垂直模式高度",
+      "type": "String"
+    },
+    "interval-label-unit": {
+      "default": "-",
+      "description": "标签单位",
+      "type": "String"
+    },
+    "max-value": {
+      "default": "100",
+      "description": "最大值设置",
+      "type": "Number"
+    },
+    "min-value": {
+      "default": "0",
+      "description": "最小值设置",
+      "type": "Number"
+    },
+    "range": {
+      "default": "false",
+      "description": "是否为范围选择",
+      "type": "Boolean"
+    },
+    "show-between-label": {
+      "default": "false",
+      "description": "首尾标签",
+      "type": "Boolean"
+    },
+    "show-button-label": {
+      "default": "false",
+      "description": "滑块下是否显示value值",
+      "type": "Boolean"
+    },
+    "show-custom-label": {
+      "default": "false",
+      "description": "是否显示自定义标签",
+      "type": "Boolean"
+    },
+    "show-custom-tip": {
+      "default": "false",
+      "description": "是否显示自定义tip",
+      "type": "Boolean"
+    },
+    "show-input": {
+      "default": "false",
+      "description": "带输入的选择",
+      "type": "Boolean"
+    },
+    "show-interval": {
+      "default": "false",
+      "description": "是否显示间断点",
+      "type": "Boolean"
+    },
+    "show-interval-label": {
+      "default": "false",
+      "description": "是否显示间断点下的标签",
+      "type": "Boolean"
+    },
+    "show-tip": {
+      "default": "true",
+      "description": "显示提示",
+      "type": "Boolean"
+    },
+    "step": {
+      "default": "1",
+      "description": "滑块每一步移动的距离",
+      "type": "Number"
+    },
+    "value": {
+      "default": "0",
+      "description": "使用v-model，将指定变量与slider的值进行绑定",
+      "type": "Number | Array"
+    },
+    "vertical": {
+      "default": "false",
+      "description": "是否为垂直模式",
+      "type": "Boolean"
+    }
+  },
+  "slots": {
+    "end": {
+      "description": "滑块尾部插槽"
+    },
+    "start": {
+      "description": "滑块头部插槽"
+    }
+  }
+}

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

@@ -0,0 +1,37 @@
+{
+  "description": "用于页面的加载中状态",
+  "events": {},
+  "name": "bk-spin",
+  "props": {
+    "icon": {
+      "default": "-",
+      "description": "自定义的加载图标",
+      "type": "String"
+    },
+    "placement": {
+      "default": "bottom",
+      "description": "插槽的位置",
+      "type": "'right' | 'bottom'"
+    },
+    "size": {
+      "default": "small",
+      "description": "尺寸",
+      "type": "'large' | 'normal' | 'small' | 'mini'"
+    },
+    "spinning": {
+      "default": "true",
+      "description": "是否为加载中状态",
+      "type": "Boolean"
+    },
+    "theme": {
+      "default": "primary",
+      "description": "加载类型",
+      "type": "'default' | 'primary' | 'success' | 'warning' | 'danger' | 'info'"
+    }
+  },
+  "slots": {
+    "default": {
+      "description": "匿名作用域插槽，自定义 spin 的内容"
+    }
+  }
+}

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

@@ -0,0 +1,63 @@
+{
+  "description": "引导用户按步骤完成流程的组件",
+  "events": {
+    "step-changed": {
+      "description": "当前步骤变化时的回调",
+      "params": "(index)"
+    }
+  },
+  "name": "bk-steps",
+  "props": {
+    "before-change": {
+      "default": "-",
+      "description": "步骤切换前的钩子函数，支持异步函数",
+      "type": "Function(nextStep)"
+    },
+    "controllable": {
+      "default": "false",
+      "description": "步骤可否被控制前后跳转",
+      "type": "Boolean"
+    },
+    "cur-step": {
+      "default": "1",
+      "description": "当前步骤的索引值，从 1 开始；支持 .sync 修饰符",
+      "type": "Number"
+    },
+    "direction": {
+      "default": "horizontal",
+      "description": "步骤条方向，支持水平（horizontal）和竖直（vertical）两种方向",
+      "type": "'horizontal' | 'vertical'"
+    },
+    "ext-cls": {
+      "default": "-",
+      "description": "配置自定义样式类名，传入的类会被加在组件最外层的 DOM .bk-steps 上",
+      "type": "String"
+    },
+    "line-type": {
+      "default": "dashed",
+      "description": "线条类型",
+      "type": "'dashed' | 'solid'"
+    },
+    "size": {
+      "default": "-",
+      "description": "指定大小，目前支持普通（不设置）和小尺寸（small）",
+      "type": "'small'"
+    },
+    "status": {
+      "default": "-",
+      "description": "指定当前步骤状态，不指定则为默认状态（是否完成）",
+      "type": "'error' | 'loading'"
+    },
+    "steps": {
+      "default": "-",
+      "description": "组件步骤内容，数组中的元素可以是对象、数字或字符串；当元素是对象时，有四个可选的key：title、icon、description、status",
+      "type": "Array"
+    },
+    "theme": {
+      "default": "primary",
+      "description": "组件的主题色",
+      "type": "'primary' | 'info' | 'success' | 'warning' | 'danger'"
+    }
+  },
+  "slots": {}
+}

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

@@ -0,0 +1,52 @@
+{
+  "description": "轮播图组件，用于展示图片",
+  "events": {
+    "index-change": {
+      "description": "图片索引改变时触发该事件",
+      "params": "(index)"
+    }
+  },
+  "name": "bk-swiper",
+  "props": {
+    "ext-cls": {
+      "default": "-",
+      "description": "配置自定义样式类名，传入的类会被加在组件最外层的 DOM .bk-swiper-home 上",
+      "type": "String"
+    },
+    "height": {
+      "default": "-",
+      "description": "轮播容器高度",
+      "type": "Number | String"
+    },
+    "is-loop": {
+      "default": "true",
+      "description": "是否开启图片轮播",
+      "type": "Boolean"
+    },
+    "list": {
+      "default": "-",
+      "description": "数据列表，传了list以list为主",
+      "type": "Array"
+    },
+    "loop-time": {
+      "default": "8000",
+      "description": "轮播间隔",
+      "type": "Number"
+    },
+    "pics": {
+      "default": "-",
+      "description": "图片列表",
+      "type": "Array"
+    },
+    "width": {
+      "default": "-",
+      "description": "轮播容器宽度",
+      "type": "Number | String"
+    }
+  },
+  "slots": {
+    "default": {
+      "description": "匿名插槽，传递data数据给自定义内容"
+    }
+  }
+}

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

@@ -0,0 +1,73 @@
+{
+  "description": "在两种状态之间的切换",
+  "events": {
+    "change": {
+      "description": "状态发生变化时回调函数",
+      "params": "(value: Boolean)"
+    }
+  },
+  "name": "bk-switcher",
+  "props": {
+    "disabled": {
+      "default": "false",
+      "description": "是否禁用",
+      "type": "Boolean"
+    },
+    "false-value": {
+      "default": "false",
+      "description": "switcher的假值",
+      "type": "Boolean"
+    },
+    "is-outline": {
+      "default": "false",
+      "description": "是否为描边效果",
+      "type": "Boolean"
+    },
+    "is-square": {
+      "default": "false",
+      "description": "是否为方形效果",
+      "type": "Boolean"
+    },
+    "off-text": {
+      "default": "OFF",
+      "description": "关闭状态显示文本",
+      "type": "String"
+    },
+    "on-text": {
+      "default": "ON",
+      "description": "打开状态显示的文本",
+      "type": "String"
+    },
+    "pre-check": {
+      "default": "-",
+      "description": "状态切换的前置检测接收操作后的状态（lastValue），返回true、false或Promise",
+      "type": "Function"
+    },
+    "show-text": {
+      "default": "false",
+      "description": "是否显示文本",
+      "type": "Boolean"
+    },
+    "size": {
+      "default": "normal",
+      "description": "尺寸，显示文本时此属性无效",
+      "type": "'small' | 'normal' | 'large'"
+    },
+    "theme": {
+      "default": "success",
+      "description": "主题",
+      "type": "'primary' | 'success'"
+    },
+    "true-value": {
+      "default": "true",
+      "description": "switcher的真值",
+      "type": "Boolean"
+    },
+    "value": {
+      "default": "false",
+      "description": "是否打开",
+      "type": "Boolean"
+    }
+  },
+  "slots": {}
+}

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

@@ -0,0 +1,128 @@
+{
+  "description": "选项卡组件，用于在不同内容区域之间切换",
+  "events": {
+    "add-panel": {
+      "description": "新增选项卡时调用",
+      "params": "()"
+    },
+    "close-panel": {
+      "description": "关闭选项卡时调用",
+      "params": "(index, panel)"
+    },
+    "on-drag-tab": {
+      "description": "标签拖动时调用",
+      "params": "(dragTabIndex, dragEvent)"
+    },
+    "scroll-show-change": {
+      "description": "滚动按钮显隐时调用",
+      "params": "(hasScroll)"
+    },
+    "sort-change": {
+      "description": "标签拖动交互位置后调用",
+      "params": "(dragTabIndex, dropTabIndex)"
+    },
+    "tab-change": {
+      "description": "选项卡切换时调用",
+      "params": "(name)"
+    }
+  },
+  "name": "bk-tab",
+  "props": {
+    "active": {
+      "default": "-",
+      "description": "当前显示的选项卡名称，支持sync修饰符",
+      "type": "String"
+    },
+    "active-bar": {
+      "default": "{ position: 'bottom', height: '2px' }",
+      "description": "当前选中激活样式，暂时只支持横排样式",
+      "type": "Object"
+    },
+    "add-show-next-right": {
+      "default": "false",
+      "description": "添加按钮是否显示在右边滚动按钮左边",
+      "type": "Boolean"
+    },
+    "addable": {
+      "default": "false",
+      "description": "是否可新增选项卡",
+      "type": "Boolean"
+    },
+    "before-toggle": {
+      "default": "-",
+      "description": "切换选项卡前的钩子函数，支持异步函数",
+      "type": "Function(panelName, panelInstance)"
+    },
+    "change-on-hover": {
+      "default": "false",
+      "description": "鼠标悬停tab时进行切换",
+      "type": "Boolean"
+    },
+    "change-on-hover-delay": {
+      "default": "1000",
+      "description": "鼠标悬停切换tab的延时，单位为毫秒",
+      "type": "Number"
+    },
+    "closable": {
+      "default": "false",
+      "description": "是否可关闭选项卡",
+      "type": "Boolean"
+    },
+    "ext-cls": {
+      "default": "-",
+      "description": "配置自定义样式类名，传入的类会被加在组件最外层的 DOM .bk-tab 上",
+      "type": "String"
+    },
+    "label-height": {
+      "default": "50",
+      "description": "选项卡label的高度",
+      "type": "Number"
+    },
+    "scroll-step": {
+      "default": "200",
+      "description": "可滚动时，每次滚动的像素",
+      "type": "Number"
+    },
+    "show-header": {
+      "default": "true",
+      "description": "是否显示选项卡头部",
+      "type": "Boolean"
+    },
+    "sort-type": {
+      "default": "replace",
+      "description": "标签拖拽排序的方式",
+      "type": "'replace' | 'insert'"
+    },
+    "sortable": {
+      "default": "false",
+      "description": "标签是否可拖拽排序",
+      "type": "Boolean"
+    },
+    "tab-position": {
+      "default": "top",
+      "description": "选项卡位置",
+      "type": "'left' | 'right' | 'top'"
+    },
+    "type": {
+      "default": "border-card",
+      "description": "选项卡样式",
+      "type": "'card' | 'card-tab' | 'border-card' | 'unborder-card' | 'vertical-card'"
+    },
+    "validate-active": {
+      "default": "true",
+      "description": "是否校验ActiveName，true：如果active匹配不到，默认激活第一个Tab",
+      "type": "Boolean"
+    }
+  },
+  "slots": {
+    "add": {
+      "description": "自定义新增按钮"
+    },
+    "extension": {
+      "description": "自定义扩展内容（紧接选项卡之后，新增按钮之前）"
+    },
+    "setting": {
+      "description": "插入至选项卡右上角的扩展内容"
+    }
+  }
+}