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

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

@@ -0,0 +1,62 @@
+{
+  "description": "表单-多选框，在一组选项中进行多选",
+  "events": {
+    "change": {
+      "description": "显示时触发此回调函数",
+      "params": "(currentValue)"
+    }
+  },
+  "name": "bk-checkbox",
+  "props": {
+    "before-change": {
+      "default": "-",
+      "description": "在选中状态发生变更前执行的函数，返回false将中断状态变更",
+      "type": "Function"
+    },
+    "checked": {
+      "default": "undefined",
+      "description": "初始化选中状态，如果 v-model 绑定的值也会相应改变",
+      "type": "Boolean"
+    },
+    "disabled": {
+      "default": "false",
+      "description": "是否禁用",
+      "type": "Boolean"
+    },
+    "ext-cls": {
+      "default": "-",
+      "description": "配置自定义样式类名，传入的类会被加在组件最外层的 DOM .bk-form-checkbox 上",
+      "type": "String"
+    },
+    "false-value": {
+      "default": "false",
+      "description": "checkbox 的假值",
+      "type": "String | Number | Boolean"
+    },
+    "indeterminate": {
+      "default": "false",
+      "description": "是否半选",
+      "type": "Boolean"
+    },
+    "name": {
+      "default": "-",
+      "description": "名称",
+      "type": "String"
+    },
+    "true-value": {
+      "default": "true",
+      "description": "checkbox 的真值",
+      "type": "String | Number | Boolean"
+    },
+    "value": {
+      "default": "undefined",
+      "description": "checkbox 的真值，与 checkbox-group 结合时通过配置 value",
+      "type": "String | Number | Boolean"
+    }
+  },
+  "slots": {
+    "default": {
+      "description": "自定义checkbox标签内容"
+    }
+  }
+}

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

@@ -0,0 +1,28 @@
+{
+  "description": "折叠面板，可以折叠/展开的内容区域",
+  "events": {
+    "item-click": {
+      "description": "点击时触发",
+      "params": "(activeName: Array)"
+    }
+  },
+  "name": "bk-collapse",
+  "props": {
+    "accordion": {
+      "default": "false",
+      "description": "是否使用手风琴效果",
+      "type": "Boolean"
+    },
+    "active-name": {
+      "default": "-",
+      "description": "当前激活面板的 name",
+      "type": "Array | String"
+    },
+    "ext-cls": {
+      "default": "-",
+      "description": "配置自定义样式类名，传入的类会被加在组件最外层的 DOM .bk-collapse 上",
+      "type": "String"
+    }
+  },
+  "slots": {}
+}

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

@@ -0,0 +1,53 @@
+{
+  "description": "用于颜色选择，支持多种颜色格式，支持颜色预设",
+  "events": {
+    "change": {
+      "description": "当前选择的RGB颜色值变化时调用",
+      "params": "(value: string)"
+    }
+  },
+  "name": "bk-color-picker",
+  "props": {
+    "disabled": {
+      "default": "false",
+      "description": "是否禁用",
+      "type": "Boolean"
+    },
+    "ext-cls": {
+      "default": "-",
+      "description": "配置自定义样式类名，传入的类会被加在组件最外层的 DOM .bk-color-picker 上",
+      "type": "String"
+    },
+    "readonly": {
+      "default": "false",
+      "description": "是否只读",
+      "type": "Boolean"
+    },
+    "recommend": {
+      "default": "true",
+      "description": "是否显示预设值",
+      "type": "Boolean | Array"
+    },
+    "show-value": {
+      "default": "true",
+      "description": "是否显示当前选择的RGB颜色值",
+      "type": "Boolean"
+    },
+    "size": {
+      "default": "-",
+      "description": "有三种尺寸：大、默认（中）、小",
+      "type": "'large' | 'small'"
+    },
+    "transfer": {
+      "default": "false",
+      "description": "控制颜色面板是否出现在 body 内",
+      "type": "Boolean"
+    },
+    "value": {
+      "default": "#3A84FF",
+      "description": "当前选择的RGB颜色值，支持 v-model",
+      "type": "String"
+    }
+  },
+  "slots": {}
+}

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

@@ -0,0 +1,7 @@
+{
+  "description": "色彩规范，定义组件库使用的主色、辅助色、中性色等颜色规范",
+  "events": {},
+  "name": "color",
+  "props": {},
+  "slots": {}
+}

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

@@ -0,0 +1,18 @@
+{
+  "description": "多个表单项组合排版的布局风格",
+  "events": {},
+  "name": "bk-compose-form-item",
+  "props": {
+    "head-background-color": {
+      "default": "#FAFBFD",
+      "description": "第一个表单项的背景色",
+      "type": "String"
+    },
+    "tail-background-color": {
+      "default": "-",
+      "description": "最后一个表单项的背景色",
+      "type": "String"
+    }
+  },
+  "slots": {}
+}

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

@@ -0,0 +1,7 @@
+{
+  "description": "自定义配置，用于设置组件命名空间及默认属性",
+  "events": {},
+  "name": "config",
+  "props": {},
+  "slots": {}
+}

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

@@ -0,0 +1,177 @@
+{
+  "description": "日期选择器，支持日期、日期范围、日期时间、日期时间范围等多种类型选择",
+  "events": {
+    "change": {
+      "description": "日期改变事件，参数为当前选择的日期以及当前日历组件的类型",
+      "params": "(date, type)"
+    },
+    "clear": {
+      "description": "日历面板点击清空事件，无参数",
+      "params": "()"
+    },
+    "open-change": {
+      "description": "日历面板弹出或收起事件，参数为日历面板展开收起的状态",
+      "params": "(state: boolean)"
+    },
+    "pick-success": {
+      "description": "日历面板选择日期后，点击确定选择成功的事件，无参数",
+      "params": "()"
+    },
+    "shortcut-change": {
+      "description": "快捷项改变事件",
+      "params": "(value, index)"
+    }
+  },
+  "name": "bk-date-picker",
+  "props": {
+    "behavior": {
+      "default": "normal",
+      "description": "风格设置(simplicity:简约 normal:正常)",
+      "type": "'normal' | 'simplicity'"
+    },
+    "cell-class": {
+      "default": "-",
+      "description": "自定义每个日期Cell样式",
+      "type": "Function"
+    },
+    "clearable": {
+      "default": "true",
+      "description": "是否可清空",
+      "type": "Boolean"
+    },
+    "disabled": {
+      "default": "false",
+      "description": "是否禁用",
+      "type": "Boolean"
+    },
+    "editable": {
+      "default": "true",
+      "description": "设置文本框是否可编辑",
+      "type": "Boolean"
+    },
+    "ext-cls": {
+      "default": "-",
+      "description": "配置自定义样式类名，传入的类会被加在组件最外层的 DOM .bk-date-picker 上",
+      "type": "String"
+    },
+    "ext-popover-cls": {
+      "default": "-",
+      "description": "配置自定义样式类名，传入的类会被加在弹出的日历面板 DOM .bk-date-picker-dropdown 上",
+      "type": "String"
+    },
+    "font-size": {
+      "default": "normal",
+      "description": "设置组件主体内容字体大小",
+      "type": "'normal' | 'medium' | 'large'"
+    },
+    "footer-slot-cls": {
+      "default": "-",
+      "description": "自定义 footer 的容器的样式，只有存在自定义 footer 时才会生效",
+      "type": "String"
+    },
+    "format": {
+      "default": "yyyy-MM-dd",
+      "description": "日期格式",
+      "type": "String"
+    },
+    "header-slot-cls": {
+      "default": "-",
+      "description": "自定义 header 的容器的样式，只有存在自定义 header 时才会生效",
+      "type": "String"
+    },
+    "multiple": {
+      "default": "false",
+      "description": "是否允许选择多个日期，multiple 只支持 date 类型",
+      "type": "Boolean"
+    },
+    "open": {
+      "default": "false",
+      "description": "控制日历面板的显示与隐藏",
+      "type": "Boolean"
+    },
+    "options": {
+      "default": "{}",
+      "description": "额外配置，目前包括不可选日期的配置",
+      "type": "Object"
+    },
+    "placeholder": {
+      "default": "-",
+      "description": "占位文案",
+      "type": "String"
+    },
+    "placement": {
+      "default": "bottom-start",
+      "description": "日历面板出现的位置",
+      "type": "'top' | 'top-start' | 'top-end' | 'bottom' | 'bottom-start' | 'bottom-end' | 'left' | 'left-start' | 'left-end' | 'right' | 'right-start' | 'right-end'"
+    },
+    "readonly": {
+      "default": "false",
+      "description": "是否只读",
+      "type": "Boolean"
+    },
+    "shortcut-close": {
+      "default": "false",
+      "description": "配置点击 shortcuts 是否关闭弹层",
+      "type": "Boolean"
+    },
+    "shortcut-selected-index": {
+      "default": "-1",
+      "description": "选中的快捷项index",
+      "type": "Number"
+    },
+    "shortcuts": {
+      "default": "-",
+      "description": "配置快捷选择日期",
+      "type": "Object"
+    },
+    "start-date": {
+      "default": "-",
+      "description": "设置日历面板默认显示的日期",
+      "type": "Date"
+    },
+    "time-picker-options": {
+      "default": "{}",
+      "description": "支持 datetime 和 datetimerange 类型，在 DatePicker 中配置 TimePicker 的属性",
+      "type": "Object"
+    },
+    "transfer": {
+      "default": "false",
+      "description": "控制日历面板是否出现在 body 内",
+      "type": "Boolean"
+    },
+    "type": {
+      "default": "date",
+      "description": "日期选择器类型",
+      "type": "'date' | 'daterange' | 'datetime' | 'datetimerange' | 'month' | 'year'"
+    },
+    "up-to-now": {
+      "default": "false",
+      "description": "在日期范围选择器和日期时间范围选择器中，设置 up-to-now 为 true 可使配置终止时间为‘至今’",
+      "type": "Boolean"
+    },
+    "use-shortcut-text": {
+      "default": "false",
+      "description": "开启后，点击选中配置的快捷项时，输入框显示的内容为选中的快捷文案，且不可编辑",
+      "type": "Boolean"
+    },
+    "value": {
+      "default": "-",
+      "description": "日历组件的值，可以是 Date 或字符串或数组，只有在 daterange 和 datetimerange 类型时才支持数组",
+      "type": "Date | String | Array"
+    }
+  },
+  "slots": {
+    "footer": {
+      "description": "可用该插槽，自定义日期选择器 footer 的展示"
+    },
+    "header": {
+      "description": "可用该插槽，自定义日期选择器 header 的展示"
+    },
+    "shortcuts": {
+      "description": "datetimerange、daterange类型可用该插槽，自定义时间范围选择器快捷选项区域的展示"
+    },
+    "trigger": {
+      "description": "可用该插槽配合open属性，自定义日期选择器的展示"
+    }
+  }
+}

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

@@ -0,0 +1,158 @@
+{
+  "description": "可完全定制内容的弹框",
+  "events": {
+    "after-leave": {
+      "description": "弹框消失的动画结束后触发的回调函数",
+      "params": "()"
+    },
+    "cancel": {
+      "description": "点击取消按钮触发的事件，主动调用关闭才会触发，通过改变双向绑定的值关闭弹框时不会触发",
+      "params": "()"
+    },
+    "confirm": {
+      "description": "点击确定按钮触发的事件",
+      "params": "()"
+    },
+    "value-change": {
+      "description": "弹框显示状态变化的回调函数",
+      "params": "(value: boolean)"
+    }
+  },
+  "name": "bk-dialog",
+  "props": {
+    "auto-close": {
+      "default": "true",
+      "description": "点击确认时是否自动关闭弹窗",
+      "type": "Boolean"
+    },
+    "cancel-text": {
+      "default": "-",
+      "description": "取消按钮的文字",
+      "type": "String"
+    },
+    "close-icon": {
+      "default": "true",
+      "description": "是否显示右上角的关闭 icon，此属性为 false 时，esc-close 和 mask-close 会被强制设置为 false",
+      "type": "Boolean"
+    },
+    "confirm-fn": {
+      "default": "-",
+      "description": "点击确认时触发的回调方法，参数是Dialog的this对象",
+      "type": "Function"
+    },
+    "draggable": {
+      "default": "true",
+      "description": "是否允许弹框拖拽，当设置全屏弹框时，draggable 属性无效",
+      "type": "Boolean"
+    },
+    "esc-close": {
+      "default": "true",
+      "description": "是否允许 esc 按键关闭弹框",
+      "type": "Boolean"
+    },
+    "ext-cls": {
+      "default": "-",
+      "description": "配置自定义样式类名，传入的类会被加在组件最外层的 DOM .bk-dialog-wrapper 上",
+      "type": "String"
+    },
+    "footer-position": {
+      "default": "right",
+      "description": "显示 footer 的位置",
+      "type": "'left' | 'center' | 'right'"
+    },
+    "fullscreen": {
+      "default": "false",
+      "description": "是否全屏弹框，当设置全屏弹框时，draggable 属性无效",
+      "type": "Boolean"
+    },
+    "header-position": {
+      "default": "center",
+      "description": "显示 header 的位置",
+      "type": "'left' | 'center'"
+    },
+    "mask-close": {
+      "default": "true",
+      "description": "是否允许点击遮罩关闭弹框",
+      "type": "Boolean"
+    },
+    "ok-text": {
+      "default": "-",
+      "description": "确定按钮的文字",
+      "type": "String"
+    },
+    "on-close": {
+      "default": "-",
+      "description": "点击取消时触发的回调方法，参数是Dialog的this对象",
+      "type": "Function"
+    },
+    "position": {
+      "default": "-",
+      "description": "设置层的位置，接收 top, left 两个属性",
+      "type": "Object"
+    },
+    "render-directive": {
+      "default": "show",
+      "description": "弹框的渲染方式",
+      "type": "'if' | 'show'"
+    },
+    "scrollable": {
+      "default": "false",
+      "description": "弹框出现时，是否允许页面滚动",
+      "type": "Boolean"
+    },
+    "show-footer": {
+      "default": "true",
+      "description": "是否显示 footer",
+      "type": "Boolean"
+    },
+    "show-mask": {
+      "default": "true",
+      "description": "是否允许出现遮罩",
+      "type": "Boolean"
+    },
+    "theme": {
+      "default": "primary",
+      "description": "颜色按钮类型",
+      "type": "'primary' | 'success' | 'warning' | 'danger'"
+    },
+    "title": {
+      "default": "-",
+      "description": "弹框的标题，不设置 title 和 slot header 可配置出无 header 的弹框",
+      "type": "String"
+    },
+    "transfer": {
+      "default": "true",
+      "description": "控制弹框是否出现在 body 内",
+      "type": "Boolean"
+    },
+    "value": {
+      "default": "false",
+      "description": "是否显示弹框，支持 v-model 双向绑定",
+      "type": "Boolean"
+    },
+    "width": {
+      "default": "400",
+      "description": "弹框的宽度，支持数字和百分比",
+      "type": "Number | String"
+    },
+    "z-index": {
+      "default": "-",
+      "description": "配置自定义层级",
+      "type": "Number"
+    }
+  },
+  "slots": {
+    "default": {
+      "description": "没有名字的插槽，会被渲染到dialog的主体上"
+    },
+    "footer": {
+      "description": "确认和取消按钮部分的插槽，dialog底部区域"
+    },
+    "header": {
+      "description": "title部分的插槽，dialog头部区域"
+    },
+    "tools": {
+      "description": "工具栏插槽，顶部区域"
+    }
+  }
+}

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

@@ -0,0 +1,38 @@
+{
+  "description": "差异对比组件，用于展示新旧内容的差异",
+  "events": {},
+  "name": "bk-diff",
+  "props": {
+    "context": {
+      "default": "-",
+      "description": "不同地方间隔多少行不隐藏",
+      "type": "Number"
+    },
+    "ext-cls": {
+      "default": "-",
+      "description": "配置自定义样式类名，传入的类会被加在组件最外层的 DOM .bk-diff 上",
+      "type": "String"
+    },
+    "format": {
+      "default": "line-by-line",
+      "description": "展示方式",
+      "type": "'line-by-line' | 'side-by-side'"
+    },
+    "new-content": {
+      "default": "-",
+      "description": "新内容",
+      "type": "String"
+    },
+    "old-content": {
+      "default": "-",
+      "description": "旧内容",
+      "type": "String"
+    },
+    "theme": {
+      "default": "light",
+      "description": "主题风格",
+      "type": "'light' | 'dark'"
+    }
+  },
+  "slots": {}
+}

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

@@ -0,0 +1,7 @@
+{
+  "description": "常用自定义指令集合，包括 v-bk-clickoutside、v-bk-overflow-tips、v-bk-copy",
+  "events": {},
+  "name": "directives",
+  "props": {},
+  "slots": {}
+}

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

@@ -0,0 +1,33 @@
+{
+  "description": "区分内容的分割线",
+  "events": {},
+  "name": "bk-divider",
+  "props": {
+    "align": {
+      "default": "center",
+      "description": "分割线位置",
+      "type": "'left' | 'right' | 'center'"
+    },
+    "color": {
+      "default": "#dde4eb",
+      "description": "分割线颜色",
+      "type": "String"
+    },
+    "direction": {
+      "default": "horizontal",
+      "description": "分割线方向",
+      "type": "'horizontal' | 'vertical'"
+    },
+    "type": {
+      "default": "solid",
+      "description": "分割线类型，border-style类型",
+      "type": "'solid' | 'dashed'"
+    },
+    "width": {
+      "default": "0",
+      "description": "分割线宽度",
+      "type": "Number"
+    }
+  },
+  "slots": {}
+}

package/knowledge/component-apis/vue2/dropdown-menu.json

@@ -0,0 +1,64 @@
+{
+  "description": "下拉菜单组件",
+  "events": {
+    "hide": {
+      "description": "隐藏时触发此回调函数",
+      "params": "()"
+    },
+    "show": {
+      "description": "显示时触发此回调函数",
+      "params": "()"
+    }
+  },
+  "name": "bk-dropdown-menu",
+  "props": {
+    "align": {
+      "default": "left",
+      "description": "与触发对象的对齐方式，包括左对齐，居中，右对齐三种方式",
+      "type": "'left' | 'center' | 'right'"
+    },
+    "close-delay": {
+      "default": "100",
+      "description": "关闭下拉菜单的延迟时间，单位为毫秒",
+      "type": "Number"
+    },
+    "disabled": {
+      "default": "false",
+      "description": "禁用下拉菜单",
+      "type": "Boolean"
+    },
+    "ext-cls": {
+      "default": "-",
+      "description": "配置自定义样式类名，传入的类会被加在组件最外层的 DOM .bk-dropdown-menu 上",
+      "type": "String"
+    },
+    "font-size": {
+      "default": "normal",
+      "description": "设置下拉已选择及列表的字体大小",
+      "type": "'normal' | 'medium' | 'large'"
+    },
+    "open-delay": {
+      "default": "0",
+      "description": "打开下拉菜单的延迟时间，单位为毫秒",
+      "type": "Number"
+    },
+    "position-fixed": {
+      "default": "false",
+      "description": "下拉框定位属性，true 使用 position:fixed，false 使用 position:absolute",
+      "type": "Boolean"
+    },
+    "trigger": {
+      "default": "mouseover",
+      "description": "触发事件",
+      "type": "'click' | 'mouseover'"
+    }
+  },
+  "slots": {
+    "dropdown-content": {
+      "description": "配置下拉列表"
+    },
+    "dropdown-trigger": {
+      "description": "配置触发对象，即触发下拉列表显示的元素"
+    }
+  }
+}