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

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

@@ -0,0 +1,27 @@
+{
+  "description": "异常提示组件，用于展示 403、404、500 等异常状态",
+  "events": {},
+  "name": "bk-exception",
+  "props": {
+    "ext-cls": {
+      "default": "-",
+      "description": "配置自定义样式类名，传入的类会被加在组件最外层的 DOM .bk-exception 上",
+      "type": "String"
+    },
+    "scene": {
+      "default": "page",
+      "description": "使用场景",
+      "type": "'page' | 'part'"
+    },
+    "type": {
+      "default": "404",
+      "description": "异常类型",
+      "type": "'403' | '404' | '500' | 'building' | 'empty' | 'search-empty' | 'login'"
+    }
+  },
+  "slots": {
+    "default": {
+      "description": "自定义异常提示内容"
+    }
+  }
+}

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

@@ -0,0 +1,23 @@
+{
+  "description": "悬浮导航组件，提供固定在页面侧边的快捷导航",
+  "events": {},
+  "name": "bk-fixed-navbar",
+  "props": {
+    "ext-cls": {
+      "default": "-",
+      "description": "配置自定义样式类名，传入的类会被加在组件最外层的 DOM .bk-fixed-navbar-wrapper 上",
+      "type": "String"
+    },
+    "navItems": {
+      "default": "[]",
+      "description": "导航元素列表，数组的每个元素都是一个对象，属性包括 icon、text、tooltip 和 action",
+      "type": "Array"
+    },
+    "position": {
+      "default": "middle",
+      "description": "悬浮导航的位置",
+      "type": "'middle' | 'top' | 'bottom'"
+    }
+  },
+  "slots": {}
+}

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

@@ -0,0 +1,7 @@
+{
+  "description": "字体规范，规范蓝鲸系列产品字号和字体的使用",
+  "events": {},
+  "name": "font",
+  "props": {},
+  "slots": {}
+}

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

@@ -0,0 +1,33 @@
+{
+  "description": "由输入框、选择器、单选框、多选框等控件组成，用以收集、校验、提交数据",
+  "events": {},
+  "name": "bk-form",
+  "props": {
+    "ext-cls": {
+      "default": "-",
+      "description": "配置自定义样式类名，传入的类会被加在组件最外层的 DOM .bk-form 上",
+      "type": "String"
+    },
+    "form-type": {
+      "default": "horizontal",
+      "description": "表单类型, 水平布局（horizontal）、垂直布局（vertical）、行内布局（inline）",
+      "type": "'horizontal' | 'vertical' | 'inline'"
+    },
+    "label-width": {
+      "default": "150",
+      "description": "表单项 label 宽度",
+      "type": "Number"
+    },
+    "model": {
+      "default": "-",
+      "description": "表单数据对象",
+      "type": "Object"
+    },
+    "rules": {
+      "default": "-",
+      "description": "表单项验证规则",
+      "type": "Object"
+    }
+  },
+  "slots": {}
+}

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

@@ -0,0 +1,33 @@
+{
+  "description": "栅格系统，通过栅格系统迅速简便地创建布局",
+  "events": {},
+  "name": "bk-container",
+  "props": {
+    "col": {
+      "default": "24",
+      "description": "栅格数",
+      "type": "Number"
+    },
+    "ext-cls": {
+      "default": "-",
+      "description": "配置自定义样式类名，传入的类会被加在组件最外层的 DOM .bk-grid-container 上",
+      "type": "String"
+    },
+    "flex": {
+      "default": "false",
+      "description": "是否启用 flex 布局",
+      "type": "Boolean"
+    },
+    "gutter": {
+      "default": "20",
+      "description": "栅格之间的间距",
+      "type": "Number"
+    },
+    "margin": {
+      "default": "20",
+      "description": "栅格容器的左右外边距",
+      "type": "Number"
+    }
+  },
+  "slots": {}
+}

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

@@ -0,0 +1,7 @@
+{
+  "description": "国际化配置，支持中文(zh-CN)和英文(en-US)语言包",
+  "events": {},
+  "name": "i18n",
+  "props": {},
+  "slots": {}
+}

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

@@ -0,0 +1,28 @@
+{
+  "description": "bk-magic-vue 图标集，包含小图标、填充图标和线性图标",
+  "events": {},
+  "name": "bk-icon",
+  "props": {
+    "height": {
+      "default": "1em",
+      "description": "使用svg图标时的高度",
+      "type": "String"
+    },
+    "svg": {
+      "default": "false",
+      "description": "使用svg输出图标，支持彩色图标",
+      "type": "Boolean"
+    },
+    "type": {
+      "default": "-",
+      "description": "图标类型",
+      "type": "String"
+    },
+    "width": {
+      "default": "1em",
+      "description": "使用svg图标时的宽度",
+      "type": "String"
+    }
+  },
+  "slots": {}
+}

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

@@ -0,0 +1,84 @@
+{
+  "description": "图片容器，在保留原生img的特性下，支持懒加载，自定义占位、加载失败、大图预览等",
+  "events": {
+    "error": {
+      "description": "图片加载失败触发",
+      "params": "(e: Error)"
+    },
+    "load": {
+      "description": "图片加载成功触发",
+      "params": "(e: Event)"
+    }
+  },
+  "name": "bk-image",
+  "props": {
+    "alt": {
+      "default": "-",
+      "description": "原生 alt 属性",
+      "type": "String"
+    },
+    "fallback": {
+      "default": "-",
+      "description": "加载失败容错地址，会被 Slots error 覆盖",
+      "type": "String"
+    },
+    "fit": {
+      "default": "-",
+      "description": "确定图片如何适应容器框，同原生 object-fit",
+      "type": "'fill' | 'contain' | 'cover' | 'none' | 'scale-down'"
+    },
+    "isShowPreviewTitle": {
+      "default": "-",
+      "description": "预览图片时，是否显示头部信息",
+      "type": "Boolean"
+    },
+    "lazy": {
+      "default": "false",
+      "description": "是否开启懒加载",
+      "type": "Boolean"
+    },
+    "mask-close": {
+      "default": "true",
+      "description": "是否允许点击遮罩关闭弹框",
+      "type": "Boolean"
+    },
+    "preview-src-list": {
+      "default": "-",
+      "description": "开启图片预览功能的图片地址列表",
+      "type": "Array"
+    },
+    "referrer-policy": {
+      "default": "-",
+      "description": "原生 referrerPolicy 属性",
+      "type": "String"
+    },
+    "scroll-container": {
+      "default": "-",
+      "description": "开启懒加载后，监听 scroll 事件的容器",
+      "type": "String | HTMLElement"
+    },
+    "src": {
+      "default": "-",
+      "description": "图片源，同原生",
+      "type": "String"
+    },
+    "transfer": {
+      "default": "true",
+      "description": "控制图片预览弹框是否出现在 body 内",
+      "type": "Boolean"
+    },
+    "z-index": {
+      "default": "2000",
+      "description": "设置图片预览的弹窗 z-index",
+      "type": "Number"
+    }
+  },
+  "slots": {
+    "error": {
+      "description": "图片加载失败的内容"
+    },
+    "placeholder": {
+      "description": "图片未加载的占位内容"
+    }
+  }
+}

package/knowledge/component-apis/vue2/info-box.json

@@ -0,0 +1,113 @@
+{
+  "description": "模态对话框组件，可用于消息提示，成功提示，错误提示，后续操作询问等",
+  "events": {},
+  "name": "$bkInfo",
+  "props": {
+    "afterLeaveFn": {
+      "default": "-",
+      "description": "弹框消失的动画结束后触发的回调函数",
+      "type": "Function"
+    },
+    "cancelFn": {
+      "default": "-",
+      "description": "取消按钮点击回调函数",
+      "type": "Function"
+    },
+    "cancelText": {
+      "default": "-",
+      "description": "取消按钮的文字",
+      "type": "String"
+    },
+    "closeIcon": {
+      "default": "true",
+      "description": "是否显示右上角的关闭 icon，此属性为 false 时，esc-close 和 mask-close 会被强制设置为 false",
+      "type": "Boolean"
+    },
+    "closeFn": {
+      "default": "-",
+      "description": "右上角的关闭 icon 点击回调函数，默认与取消按钮的回调函数一致",
+      "type": "Function"
+    },
+    "confirmFn": {
+      "default": "-",
+      "description": "确认按钮点击回调函数，支持异步函数，函数返回false可阻止弹窗关闭",
+      "type": "Function"
+    },
+    "confirmLoading": {
+      "default": "false",
+      "description": "异步 confirmFn 确定按钮自动开启 loading",
+      "type": "Boolean"
+    },
+    "container": {
+      "default": "document.body",
+      "description": "控制弹框出现在什么容器内",
+      "type": "HTMLElement | VNode | String"
+    },
+    "escClose": {
+      "default": "true",
+      "description": "是否允许 esc 按键关闭弹框",
+      "type": "Boolean"
+    },
+    "extCls": {
+      "default": "-",
+      "description": "配置自定义样式类名，传入的类会被加在组件最外层的 DOM .bk-dialog-wrapper 上",
+      "type": "String"
+    },
+    "icon": {
+      "default": "-",
+      "description": "消息框状态的图标，使用蓝鲸icon",
+      "type": "String"
+    },
+    "maskClose": {
+      "default": "true",
+      "description": "是否允许点击遮罩关闭弹框",
+      "type": "Boolean"
+    },
+    "okText": {
+      "default": "-",
+      "description": "确定按钮的文字",
+      "type": "String"
+    },
+    "showFooter": {
+      "default": "true",
+      "description": "是否显示底部按钮",
+      "type": "Boolean"
+    },
+    "stateChangeFn": {
+      "default": "-",
+      "description": "弹框显示状态变化的回调函数",
+      "type": "Function"
+    },
+    "subHeader": {
+      "default": "-",
+      "description": "消息框的二级标题，可以用 vm.$createElement 函数生成模版",
+      "type": "String | VNode"
+    },
+    "subTitle": {
+      "default": "-",
+      "description": "消息框的二级标题",
+      "type": "String"
+    },
+    "theme": {
+      "default": "primary",
+      "description": "消息框主按钮的颜色",
+      "type": "'primary' | 'success' | 'warning' | 'danger'"
+    },
+    "title": {
+      "default": "-",
+      "description": "消息框的标题",
+      "type": "String"
+    },
+    "type": {
+      "default": "-",
+      "description": "消息框的类型，配置此属性后，可支持显示 icon 等",
+      "type": "'success' | 'warning' | 'error' | 'loading'"
+    },
+    "width": {
+      "default": "400",
+      "description": "弹框的宽度，支持数字和百分比",
+      "type": "Number | String"
+    }
+  },
+  "slots": {}
+}

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

@@ -0,0 +1,189 @@
+{
+  "description": "表单组件，文本输入框，在原生控件基础上进行了功能扩展",
+  "events": {
+    "blur": {
+      "description": "文本框失去焦点时调用",
+      "params": "(value, event)"
+    },
+    "change": {
+      "description": "文本框内容变化时调用",
+      "params": "(value, event)"
+    },
+    "clear": {
+      "description": "点击文本框的清除图标时调用",
+      "params": "(value, event)"
+    },
+    "enter": {
+      "description": "文本框获取焦点时，按下回车时调用",
+      "params": "(value, event)"
+    },
+    "focus": {
+      "description": "文本框获取焦点时调用",
+      "params": "(value, event)"
+    },
+    "input": {
+      "description": "文本框输入时调用",
+      "params": "(value, event)"
+    },
+    "keydown": {
+      "description": "文本框输入按下键盘时调用",
+      "params": "(value, event)"
+    },
+    "keypress": {
+      "description": "文本框输入按下键盘时调用",
+      "params": "(value, event)"
+    },
+    "keyup": {
+      "description": "文本框输入按下键盘按键松开时调用",
+      "params": "(value, event)"
+    },
+    "left-icon-click": {
+      "description": "点击配置的左图标时调用",
+      "params": "(value, event)"
+    },
+    "paste": {
+      "description": "文本框粘贴内容时调用",
+      "params": "(value, event)"
+    },
+    "right-icon-click": {
+      "description": "点击配置的右图标时调用",
+      "params": "(value, event)"
+    }
+  },
+  "name": "bk-input",
+  "props": {
+    "allow-emoji": {
+      "default": "true",
+      "description": "是否允许文本框输入表情，设置为 false 时，不允许输入表情，此时文本框会自动把输入的表情过滤",
+      "type": "Boolean"
+    },
+    "allow-number-paste": {
+      "default": "false",
+      "description": "允许type为number时可粘贴",
+      "type": "Boolean"
+    },
+    "behavior": {
+      "default": "normal",
+      "description": "简约风格设置(simplicity:简约 normal:正常 type=textarea时不生效)",
+      "type": "'normal' | 'simplicity'"
+    },
+    "clearable": {
+      "default": "false",
+      "description": "是否可清除，数字输入框时此配置不生效",
+      "type": "Boolean"
+    },
+    "disabled": {
+      "default": "false",
+      "description": "是否禁用",
+      "type": "Boolean"
+    },
+    "ext-cls": {
+      "default": "-",
+      "description": "配置自定义样式类名，传入的类会被加在组件最外层的 DOM .bk-form-control 上",
+      "type": "String"
+    },
+    "font-size": {
+      "default": "normal",
+      "description": "设置输入框内容字体大小",
+      "type": "'normal' | 'medium' | 'large'"
+    },
+    "initial-control-value": {
+      "default": "-",
+      "description": "设置上下键调整数值时的起始值",
+      "type": "Number"
+    },
+    "input-style": {
+      "default": "{}",
+      "description": "输入框样式",
+      "type": "Object"
+    },
+    "left-icon": {
+      "default": "-",
+      "description": "左边显示icon",
+      "type": "String"
+    },
+    "maxlength": {
+      "default": "-",
+      "description": "最大输入长度",
+      "type": "Number"
+    },
+    "minlength": {
+      "default": "-",
+      "description": "最小输入长度",
+      "type": "Number"
+    },
+    "name": {
+      "default": "-",
+      "description": "名称",
+      "type": "String"
+    },
+    "native-attributes": {
+      "default": "-",
+      "description": "Html input标签原生属性设置",
+      "type": "Object"
+    },
+    "password-icon": {
+      "default": "['icon-eye-slash', 'icon-eye']",
+      "description": "设置密码框切换显示密码的 icon",
+      "type": "Array"
+    },
+    "placeholder": {
+      "default": "-",
+      "description": "空白提示",
+      "type": "String"
+    },
+    "precision": {
+      "default": "-",
+      "description": "保留小数位",
+      "type": "Number"
+    },
+    "readonly": {
+      "default": "false",
+      "description": "是否只读",
+      "type": "Boolean"
+    },
+    "right-icon": {
+      "default": "-",
+      "description": "右边显示icon",
+      "type": "String"
+    },
+    "show-clear-only-hover": {
+      "default": "false",
+      "description": "是否在只有 hover 的时候才显示 clear 清除按钮",
+      "type": "Boolean"
+    },
+    "show-controls": {
+      "default": "true",
+      "description": "type为number时，是否显示右侧控制箭头",
+      "type": "Boolean"
+    },
+    "show-overflow-tooltips": {
+      "default": "false",
+      "description": "文本超出长度是否显示tooltips",
+      "type": "Boolean"
+    },
+    "show-word-limit": {
+      "default": "-",
+      "description": "是否显示输入字数统计，只在 type = text 或 type = textarea 时有效",
+      "type": "Boolean"
+    },
+    "size": {
+      "default": "-",
+      "description": "输入框尺寸，只在 type!=textarea 时有效",
+      "type": "'large' | 'small'"
+    },
+    "type": {
+      "default": "text",
+      "description": "输入框类型",
+      "type": "'text' | 'textarea' | 'password' | 'number' | 'email' | 'url' | 'date'"
+    }
+  },
+  "slots": {
+    "append": {
+      "description": "输入框后置内容"
+    },
+    "prepend": {
+      "description": "输入框前置内容"
+    }
+  }
+}

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

@@ -0,0 +1,7 @@
+{
+  "description": "安装指南，介绍如何通过 CDN 或 NPM 安装组件库",
+  "events": {},
+  "name": "install",
+  "props": {},
+  "slots": {}
+}

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

@@ -0,0 +1,43 @@
+{
+  "description": "文字超链接组件",
+  "events": {
+    "click": {
+      "description": "文字链接点击事件",
+      "params": "(event)"
+    }
+  },
+  "name": "bk-link",
+  "props": {
+    "disabled": {
+      "default": "false",
+      "description": "是否禁用",
+      "type": "Boolean"
+    },
+    "href": {
+      "default": "-",
+      "description": "文字链接地址",
+      "type": "String"
+    },
+    "icon": {
+      "default": "-",
+      "description": "图标类名",
+      "type": "String"
+    },
+    "icon-placement": {
+      "default": "left",
+      "description": "图标位置",
+      "type": "'left' | 'right'"
+    },
+    "theme": {
+      "default": "default",
+      "description": "文字链接主题色",
+      "type": "'default' | 'primary' | 'success' | 'warning' | 'danger'"
+    },
+    "underline": {
+      "default": "false",
+      "description": "是否显示下划线",
+      "type": "Boolean"
+    }
+  },
+  "slots": {}
+}

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

@@ -0,0 +1,68 @@
+{
+  "description": "覆盖正在加载数据的组件一个 loading 层",
+  "events": {},
+  "name": "bk-loading",
+  "props": {
+    "afterLeave": {
+      "default": "-",
+      "description": "loading 消失完毕的回调函数",
+      "type": "Function"
+    },
+    "color": {
+      "default": "#ffffff",
+      "description": "loading 遮罩的背景色 支持 rgb/hex/rgba",
+      "type": "String"
+    },
+    "delay": {
+      "default": "0",
+      "description": "组件消失推迟",
+      "type": "Number"
+    },
+    "extCls": {
+      "default": "-",
+      "description": "配置自定义样式类名，传入的类会被加在组件最外层的 DOM .bk-loading 上",
+      "type": "String"
+    },
+    "immediate": {
+      "default": "false",
+      "description": "组件在初始化完成后立即显示",
+      "type": "Boolean"
+    },
+    "isLoading": {
+      "default": "-",
+      "description": "一个 boolean 变量，控制组件的显示",
+      "type": "Boolean"
+    },
+    "mode": {
+      "default": "normal",
+      "description": "loading 的显示形式",
+      "type": "'normal' | 'spin'"
+    },
+    "opacity": {
+      "default": "0.9",
+      "description": "loading 遮罩的背景透明度，如设置了 color 属性为 rgba 类型颜色则此属性将被覆盖",
+      "type": "Number"
+    },
+    "size": {
+      "default": "large",
+      "description": "组件显示大小配置",
+      "type": "'large' | 'small' | 'mini'"
+    },
+    "theme": {
+      "default": "colorful",
+      "description": "组件显示主题配置",
+      "type": "'colorful' | 'default' | 'primary' | 'danger' | 'warning' | 'success'"
+    },
+    "title": {
+      "default": "-",
+      "description": "组件显示时的文案，支持使用 createElement 函数生成的 VNode",
+      "type": "String | VNode"
+    },
+    "zIndex": {
+      "default": "-",
+      "description": "如果配置项有 zIndex 选项，遮罩层的层叠顺序使用配置项的 zIndex，否则使用层叠顺序管理器自动生成的 zIndex",
+      "type": "Number"
+    }
+  },
+  "slots": {}
+}