@opentiny/vue-docs 1.0.0 → 1.0.2

package/resources/pc/api/en-US/checkbox.json

@@ -95,5 +95,169 @@
       "desc": "This event is triggered when the binding value changes.",
       "defaultValue": ""
     }
+  ],
+  "checkbox-button-attrs": [
+    {
+      "name": "label",
+      "sample": "checkbox-group",
+      "type": "String , Number , Boolean",
+      "desc": "Value in the selected state (This parameter is valid only when checkbox-group or the bound object type is array.) The optional value of this attribute is medium-",
+      "defaultValue": ""
+    },
+    {
+      "name": "true-label",
+      "sample": "text",
+      "type": "String , Number",
+      "desc": "Value when selected",
+      "defaultValue": ""
+    },
+    {
+      "name": "false-label",
+      "sample": "text",
+      "type": "String , Number",
+      "desc": "Value when no option is selected",
+      "defaultValue": ""
+    },
+    {
+      "name": "disabled",
+      "sample": "with-border",
+      "type": "Boolean",
+      "desc": "Disable",
+      "defaultValue": "The default value of this attribute is false."
+    },
+    {
+      "name": "name",
+      "sample": "checkbox-group",
+      "type": "String",
+      "desc": "Native name attribute",
+      "defaultValue": ""
+    },
+    {
+      "name": "text",
+      "sample": "text",
+      "type": "String",
+      "desc": "Text",
+      "defaultValue": "The default value of this attribute is Function."
+    },
+    {
+      "name": "modelValue / v-model",
+      "sample": "checkbox-button",
+      "type": "String , Number , Boolean",
+      "desc": "Bound Value",
+      "defaultValue": ""
+    },
+    {
+      "name": "events",
+      "sample": "checkbox-group",
+      "type": "Object",
+      "desc": "Native event",
+      "defaultValue": ""
+    },
+    {
+      "name": "checked",
+      "sample": "checkbox-button",
+      "type": "Boolean",
+      "desc": "Currently selected",
+      "defaultValue": "The default value of this attribute is false."
+    }
+  ],
+  "checkbox-button-slots": [
+    {
+      "name": "default",
+      "sample": "with-border",
+      "type": "",
+      "desc": "Checkbox-button content",
+      "defaultValue": ""
+    }
+  ],
+  "checkbox-group-attrs": [
+    {
+      "name": "modelValue / v-model",
+      "sample": "checkbox-group",
+      "type": "Array",
+      "desc": "Bound Value",
+      "defaultValue": ""
+    },
+    {
+      "name": "size",
+      "sample": "with-border",
+      "type": "String",
+      "desc": "Size of the check box group. This parameter is valid only for the check box with buttons or borders. The optional values of this attribute are medium / small / mini",
+      "defaultValue": ""
+    },
+    {
+      "name": "disabled",
+      "sample": "with-border",
+      "type": "Boolean",
+      "desc": "Disable",
+      "defaultValue": "The default value of this attribute is false."
+    },
+    {
+      "name": "min",
+      "sample": "min-max",
+      "type": "Number",
+      "desc": "Minimum number of checkboxes that can be selected",
+      "defaultValue": ""
+    },
+    {
+      "name": "max",
+      "sample": "min-max",
+      "type": "Number",
+      "desc": "Maximum number of checkboxes that can be selected",
+      "defaultValue": ""
+    },
+    {
+      "name": "text-color",
+      "sample": "vertical-checkbox",
+      "type": "String",
+      "desc": "Text color when the checkbox in button mode is activated",
+      "defaultValue": "The default value of this attribute is #ffffff."
+    },
+    {
+      "name": "fill",
+      "sample": "checkbox-button",
+      "type": "String",
+      "desc": "Fill color and border color when the checkbox in button mode is activated",
+      "defaultValue": "The default value of this attribute is #409EFF"
+    },
+    {
+      "name": "options",
+      "sample": "checkbox-group",
+      "type": "Array",
+      "desc": "Checkbox component list",
+      "defaultValue": ""
+    },
+    {
+      "name": "type",
+      "sample": "checkbox-group",
+      "type": "String",
+      "desc": "Checkbox component type (button/checkbox)",
+      "defaultValue": "The default value of this attribute is checkbox, which is used together with the options attribute."
+    },
+    {
+      "name": "vertical",
+      "sample": "vertical-checkbox",
+      "type": "Boolean",
+      "desc": "Set the component arrangement mode. Sets whether the check boxes are arranged vertically. The value of this attribute can be true or false",
+      "defaultValue": "The default value of this attribute is false."
+    }
+  ],
+  "checkbox-group-slots": [
+    {
+      "name": "default",
+      "sample": "checkbox-group",
+      "type": "",
+      "desc": "Checkbox Option Group",
+      "defaultValue": ""
+    }
+  ],
+  "checkbox-group-events": [
+    {
+      "name": "change",
+      "sample": "dynamic-create-checkbox",
+      "type": "",
+      "desc": "This event is triggered when the binding value changes.",
+      "defaultValue": ""
+    }
   ]
 }

package/resources/pc/api/en-US/loading.json

@@ -14,6 +14,13 @@
       "desc": "Set type to true to display the full screen. Same as the fullscreen modifier in the v-loading instruction",
       "defaultValue": "The default value of this attribute is true."
     },
+    {
+      "name": "size",
+      "sample": "size",
+      "type": "String",
+      "desc": "Load icon size",
+      "defaultValue": "small"
+    },
     {
       "name": "target",
       "sample": "target",
@@ -57,4 +64,4 @@
       "defaultValue": ""
     }
   ]
-}
+}

package/resources/pc/api/en-US/pager.json

@@ -97,6 +97,20 @@
       "type": "String",
       "desc": "Set the pagination display mode. The default value is number. Set the pagination display mode. The optional values of this attribute are number / simple / complete / fixed",
       "defaultValue": ""
+    },
+    {
+      "name": "size",
+      "sample": "pager-size",
+      "type": "String",
+      "desc": "Define the pager size. The value of this attribute can be mini",
+      "defaultValue": ""
+    },
+    {
+      "name": "disabled",
+      "sample": "pager-disabled",
+      "type": "Boolean",
+      "desc": "Disabled pager",
+      "defaultValue": "The default value of this attribute is false"
     }
   ],
   "slots": [

package/resources/pc/api/en-US/rate.json

@@ -37,10 +37,10 @@
     },
     {
       "name": "disabled-void-icon-class",
-      "sample": "disabled-not-selected-color",
+      "sample": "disabled-void-icon-class",
       "type": "String",
-      "desc": "Icon style name that is not selected in read-only state",
-      "defaultValue": "The default value of this attribute is icon-stardisable."
+      "desc": "Icon style name that is not selected in read-only state. Options 'icon-starDisable' | 'icon-frown' | 'icon-meh' | 'icon-smile'",
+      "defaultValue": "The default value of this attribute is icon-starActive."
     },
     {
       "name": "high-threshold",
@@ -109,8 +109,8 @@
       "name": "void-icon-class",
       "sample": "not-selected-class",
       "type": "String",
-      "desc": "Class name of unselected icons",
-      "defaultValue": "The default value of this attribute is icon-stardisable."
+      "desc": "Class name of unselected icons. Options 'icon-starDisable' | 'icon-frown' | 'icon-meh' | 'icon-smile'",
+      "defaultValue": "The default value of this attribute is icon-starActive."
     },
     {
       "name": "radio",

package/resources/pc/api/en-US/search.json

@@ -64,6 +64,13 @@
       "type": "",
       "desc": "Default search type slot",
       "defaultValue": ""
+    },
+    {
+      "name": "prefix",
+      "sample": "slot-prefix",
+      "type": "",
+      "desc": "Left slot",
+      "defaultValue": ""
     }
   ],
   "events": [
@@ -89,4 +96,4 @@
       "defaultValue": ""
     }
   ]
-}
+}

package/resources/pc/api/en-US/select.json

@@ -168,6 +168,20 @@
       "desc": "Text displayed when the option is empty. You can also use slot=\"empty\" to set it.",
       "defaultValue": "The default value of this attribute is no data."
     },
+    {
+      "name": "show-empty-image",
+      "sample": "no-data-text",
+      "type": "Boolean",
+      "desc": "By default, empty data images are not displayed. When this parameter is set to true, empty data images are displayed.",
+      "defaultValue": "false"
+    },
+    {
+      "name": "input-box-type",
+      "sample": "input-box-type",
+      "type": "String",
+      "desc": "Set the display type of the text box. The options are input and underline. The default value is input.",
+      "defaultValue": "input"
+    },
     {
       "name": "popper-class",
       "sample": "popup-style-position",

package/resources/pc/api/en-US/tabs.json

@@ -4,7 +4,7 @@
       "name": "tab-style",
       "sample": "tab-style-card",
       "type": "String",
-      "desc": "Label page style; The optional value of this attribute is card / border-card",
+      "desc": "Label page style; The optional value of this attribute is card / border-card / button-card",
       "defaultValue": ""
     },
     {
@@ -83,6 +83,20 @@
       "type": "String",
       "desc": "Sets the tab page size. This attribute is valid only when tabStyle is set to card or border-card. The value of this attribute can be small.",
       "defaultValue": ""
+    },
+    {
+      "name": "drop-config",
+      "sample": "tabs-draggable",
+      "type": "String",
+      "desc": "Enable the tab page drag function to reorder tab pages. Note that tab-items that are not rendered by v-for cannot be saved in the tab-drag-end event after being dragged and sorted.",
+      "defaultValue": ""
+    },
+    {
+      "name": "tooltip-config",
+      "sample": "position-left",
+      "type": "Object, String",
+      "desc": "Set the message indicating that the text exceeds the limit. For details about the value of the Object type, see the configuration of the tooltip component. If you want to use the default title attribute, set it to the String type and set it to title. [Added in 3.8.0]",
+      "defaultValue": ""
     }
   ],
   "slots": [
@@ -92,9 +106,37 @@
       "type": "",
       "desc": "Customized titl content",
       "defaultValue": ""
+    },
+    {
+      "name": "moreIcon",
+      "sample": "custom-more-icon",
+      "type": "",
+      "desc": "Customize More Icons",
+      "defaultValue": ""
     }
   ],
   "events": [
+    {
+      "name": "tab-drag-start",
+      "sample": "tabs-events-add",
+      "type": "Function(arg1)",
+      "desc": "Drag start event, arguments: arg1:event",
+      "defaultValue": ""
+    },
+    {
+      "name": "tab-drag-over",
+      "sample": "tabs-events-add",
+      "type": "Function(arg1)",
+      "desc": "Draging event, arguments: arg1:event",
+      "defaultValue": ""
+    },
+    {
+      "name": "tab-drag-end",
+      "sample": "tabs-events-add",
+      "type": "Function(arg1)",
+      "desc": "Event after the drag is complete. arguments: arg1:event",
+      "defaultValue": ""
+    },
     {
       "name": "add",
       "sample": "tabs-events-add",
@@ -124,4 +166,4 @@
       "defaultValue": ""
     }
   ]
-}
+}

package/resources/pc/api/en-US/tag.json

@@ -41,12 +41,19 @@
       "type": "String",
       "desc": "Subject; The optional values of this attribute are dark / light / plain",
       "defaultValue": "The default value of this attribute is light."
+    },
+    {
+      "name": "disabled",
+      "sample": "disabled",
+      "type": "Boolean",
+      "desc": "Whether to disable",
+      "defaultValue": "The default value of this attribute is false."
     }
   ],
   "slots": [
     {
       "name": "default",
-      "sample": "effect",
+      "sample": "slot-default",
       "type": "",
       "desc": "Label Content",
       "defaultValue": ""
@@ -68,4 +75,4 @@
       "defaultValue": ""
     }
   ]
-}
+}

package/resources/pc/api/en-US/tooltip.json

@@ -7,6 +7,13 @@
       "desc": "Default theme; The value of this attribute can be dark or light",
       "defaultValue": "The default value of this attribute is dark."
     },
+    {
+      "name": "type",
+      "sample": "tooltip-theme",
+      "type": "String",
+      "desc": "The default type is provided. The options for this attribute are normal, warning, error, information, and success. The priority of type is higher than that of effect.",
+      "defaultValue": ""
+    },
     {
       "name": "content",
       "sample": "basic-usage",
@@ -136,4 +143,4 @@
       "defaultValue": ""
     }
   ]
-}
+}

package/resources/pc/api/zh-CN/breadcrumb.json

@@ -5,7 +5,7 @@
       "sample": "separator",
       "type": "String",
       "desc": "分隔符",
-      "defaultValue": "该属性的默认值为 /"
+      "defaultValue": "该属性的默认值为 >"
     },
     {
       "name": "separator-icon",
@@ -22,11 +22,11 @@
       "defaultValue": "[]"
     },
     {
-      "name": "textField",
+      "name": "text-field",
       "sample": "options",
-      "type": "Array",
+      "type": "String",
       "desc": "指定面包屑的显示字段，结合 options 使用，组件默认 label ",
-      "defaultValue": "[]"
+      "defaultValue": "label"
     }
   ],
   "events": [

package/resources/pc/api/zh-CN/button-group.json

@@ -62,6 +62,13 @@
       "type": "Boolean",
       "desc": "是否显示编辑按钮，只有在显示更多的情况下生效。",
       "defaultValue": "该属性的默认值为 false"
+    },
+    {
+      "name": "border",
+      "sample": "border",
+      "type": "Boolean",
+      "desc": "是否显示边框线",
+      "defaultValue": "该属性的默认值为 true"
     }
   ],
   "slots": [

package/resources/pc/api/zh-CN/checkbox-button.json

@@ -1,5 +1,5 @@
 {
-  "attrs": [
+  "checkbox-button-attrs": [
     {
       "name": "label",
       "sample": "checkbox-group",
@@ -64,7 +64,7 @@
       "defaultValue": "该属性的默认值为 false"
     }
   ],
-  "slots": [
+  "checkbox-button-slots": [
     {
       "name": "default",
       "sample": "with-border",

package/resources/pc/api/zh-CN/checkbox-group.json

@@ -1,5 +1,5 @@
 {
-  "attrs": [
+  "checkbox-group-attrs": [
     {
       "name": "modelValue / v-model",
       "sample": "checkbox-group",
@@ -71,7 +71,7 @@
       "defaultValue": "该属性的默认值为 false"
     }
   ],
-  "slots": [
+  "checkbox-group-slots": [
     {
       "name": "default",
       "sample": "checkbox-group",
@@ -80,7 +80,7 @@
       "defaultValue": ""
     }
   ],
-  "events": [
+  "checkbox-group-events": [
     {
       "name": "change",
       "sample": "dynamic-create-checkbox",
@@ -89,4 +89,4 @@
       "defaultValue": ""
     }
   ]
-}
+}

package/resources/pc/api/zh-CN/checkbox.json

@@ -95,5 +95,169 @@
       "desc": "当绑定值变化时触发的事件",
       "defaultValue": ""
     }
+  ],
+  "checkbox-button-attrs": [
+    {
+      "name": "label",
+      "sample": "checkbox-group",
+      "type": "String , Number , Boolean",
+      "desc": "选中状态的值（只有在checkbox-group或者绑定对象类型为array时有效）;该属性的可选值为 medium-",
+      "defaultValue": ""
+    },
+    {
+      "name": "true-label",
+      "sample": "text",
+      "type": "String , Number",
+      "desc": "选中时的值",
+      "defaultValue": ""
+    },
+    {
+      "name": "false-label",
+      "sample": "text",
+      "type": "String , Number",
+      "desc": "没有选中时的值",
+      "defaultValue": ""
+    },
+    {
+      "name": "disabled",
+      "sample": "with-border",
+      "type": "Boolean",
+      "desc": "是否禁用",
+      "defaultValue": "该属性的默认值为 false"
+    },
+    {
+      "name": "name",
+      "sample": "checkbox-group",
+      "type": "String",
+      "desc": "原生 name 属性",
+      "defaultValue": ""
+    },
+    {
+      "name": "text",
+      "sample": "text",
+      "type": "String",
+      "desc": "文本",
+      "defaultValue": "该属性的默认值为 Function"
+    },
+    {
+      "name": "modelValue / v-model",
+      "sample": "checkbox-button",
+      "type": "String , Number , Boolean",
+      "desc": "绑定值",
+      "defaultValue": ""
+    },
+    {
+      "name": "events",
+      "sample": "checkbox-group",
+      "type": "Object",
+      "desc": "原生事件",
+      "defaultValue": ""
+    },
+    {
+      "name": "checked",
+      "sample": "checkbox-button",
+      "type": "Boolean",
+      "desc": "当前是否勾选",
+      "defaultValue": "该属性的默认值为 false"
+    }
+  ],
+  "checkbox-button-slots": [
+    {
+      "name": "default",
+      "sample": "with-border",
+      "type": "",
+      "desc": "Checkbox-button的内容",
+      "defaultValue": ""
+    }
+  ],
+  "checkbox-group-attrs": [
+    {
+      "name": "modelValue / v-model",
+      "sample": "checkbox-group",
+      "type": "Array",
+      "desc": "绑定值",
+      "defaultValue": ""
+    },
+    {
+      "name": "size",
+      "sample": "with-border",
+      "type": "String",
+      "desc": "多选框组尺寸，仅对按钮形式的 Checkbox 或带有边框的 Checkbox 有效;该属性的可选值为 medium / small / mini",
+      "defaultValue": ""
+    },
+    {
+      "name": "disabled",
+      "sample": "with-border",
+      "type": "Boolean",
+      "desc": "是否禁用",
+      "defaultValue": "该属性的默认值为 false"
+    },
+    {
+      "name": "min",
+      "sample": "min-max",
+      "type": "Number",
+      "desc": "可被勾选的 checkbox 的最小数量",
+      "defaultValue": ""
+    },
+    {
+      "name": "max",
+      "sample": "min-max",
+      "type": "Number",
+      "desc": "可被勾选的 checkbox 的最大数量",
+      "defaultValue": ""
+    },
+    {
+      "name": "text-color",
+      "sample": "vertical-checkbox",
+      "type": "String",
+      "desc": "按钮形式的 Checkbox 激活时的文本颜色",
+      "defaultValue": "该属性的默认值为 #ffffff"
+    },
+    {
+      "name": "fill",
+      "sample": "checkbox-button",
+      "type": "String",
+      "desc": "按钮形式的 Checkbox 激活时的填充色和边框色",
+      "defaultValue": "该属性的默认值为 #409EFF"
+    },
+    {
+      "name": "options",
+      "sample": "checkbox-group",
+      "type": "Array",
+      "desc": "checkbox组件列表",
+      "defaultValue": ""
+    },
+    {
+      "name": "type",
+      "sample": "checkbox-group",
+      "type": "String",
+      "desc": " checkbox组件类型（button/checkbox）",
+      "defaultValue": "该属性的默认值为 checkbox,配合 options 属性一起使用"
+    },
+    {
+      "name": "vertical",
+      "sample": "vertical-checkbox",
+      "type": "Boolean",
+      "desc": "设置组件排列方式;设置复选框是否垂直排列;该属性的可选值为 true / false",
+      "defaultValue": "该属性的默认值为 false"
+    }
+  ],
+  "checkbox-group-slots": [
+    {
+      "name": "default",
+      "sample": "checkbox-group",
+      "type": "",
+      "desc": "checkbox选项组",
+      "defaultValue": ""
+    }
+  ],
+  "checkbox-group-events": [
+    {
+      "name": "change",
+      "sample": "dynamic-create-checkbox",
+      "type": "",
+      "desc": "当绑定值变化时触发的事件",
+      "defaultValue": ""
+    }
   ]
 }

package/resources/pc/api/zh-CN/loading.json

@@ -14,6 +14,13 @@
       "desc": "设置 type 属性为 true 显示全屏;同 v-loading 指令中的 fullscreen 修饰符",
       "defaultValue": "该属性的默认值为 true"
     },
+    {
+      "name": "size",
+      "sample": "size",
+      "type": "String",
+      "desc": "加载图标尺寸",
+      "defaultValue": "small"
+    },
     {
       "name": "target",
       "sample": "target",
@@ -57,4 +64,4 @@
       "defaultValue": ""
     }
   ]
-}
+}