@opentiny/vue-docs 1.0.3 → 1.0.4

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

@@ -0,0 +1,99 @@
+{
+  "attrs": [
+    {
+      "name": "title",
+      "sample": "basic-usage",
+      "type": "String",
+      "desc": "Set the pop confirm title.",
+      "defaultValue": ""
+    },
+    {
+      "name": "content",
+      "sample": "basic-usage",
+      "type": "String",
+      "desc": "Set the pop confirm content.",
+      "defaultValue": ""
+    },
+    {
+      "name": "popperClass",
+      "sample": "basic-usage",
+      "type": "String",
+      "desc": "Set the pop confirm popper class name.",
+      "defaultValue": ""
+    },
+    {
+      "name": "trigger",
+      "sample": "trigger",
+      "type": "String",
+      "desc": "How to show the pop confirm.",
+      "defaultValue": "hover"
+    },
+    {
+      "name": "placement",
+      "sample": "basic-usage",
+      "type": "String",
+      "desc": "Set the pop confirm placement.",
+      "defaultValue": "top"
+    },
+    {
+      "name": "cancelButton",
+      "sample": "basic-usage",
+      "type": "Boolean",
+      "desc": "Is show the cancel button",
+      "defaultValue": "true"
+    },
+    {
+      "name": "width",
+      "sample": "basic-usage",
+      "type": "String, Number",
+      "desc": "Set the pop confirm box with.",
+      "defaultValue": ""
+    },
+    {
+      "name": "type",
+      "sample": "type",
+      "type": "String, Object",
+      "desc": "Set the icon type, info,success,warning,error can be set.",
+      "defaultValue": ""
+    }
+  ],
+  "slots": [
+    {
+      "name": "default",
+      "sample": "basic-usage",
+      "type": "",
+      "desc": "default slot",
+      "defaultValue": ""
+    },
+    {
+      "name": "reference",
+      "sample": "basic-usage",
+      "type": "",
+      "desc": "reference slot",
+      "defaultValue": ""
+    }
+  ],
+  "events": [
+    {
+      "name": "show",
+      "sample": "basic-usage",
+      "type": "",
+      "desc": "Triggered when pop confirm show",
+      "defaultValue": ""
+    },
+    {
+      "name": "hide",
+      "sample": "basic-usage",
+      "type": "",
+      "desc": "Triggered when pop confirm hide",
+      "defaultValue": ""
+    },
+    {
+      "name": "confirm",
+      "sample": "basic-usage",
+      "type": "",
+      "desc": "Triggered when confirm button is clicked",
+      "defaultValue": ""
+    }
+  ]
+}

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

@@ -202,6 +202,13 @@
       "type": "Boolean",
       "desc": "Set initialization not to request data",
       "defaultValue": "true"
+    },
+    {
+      "name": "suggest",
+      "sample": "suggest",
+      "type": "Boolean",
+      "desc": "Configure the suggest to enable the association function, and automatically trigger the association query after entering the input box; This function needs to be used in conjunction with remoteSearch",
+      "defaultValue": ""
     }
   ],
   "slots": [

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

@@ -37,7 +37,7 @@
     },
     {
       "name": "disabled-void-icon-class",
-      "sample": "disabled-void-icon-class",
+      "sample": "disabled-not-selected-class",
       "type": "String",
       "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."
@@ -157,4 +157,4 @@
       "defaultValue": ""
     }
   ]
-}
+}

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

@@ -21,6 +21,13 @@
       "desc": "Specifies whether multiple items can be entered or selected in the text box. The default value is false. ; Whether to select multiple options",
       "defaultValue": "The default value of this attribute is false."
     },
+    {
+      "name": "tag-type",
+      "sample": "tag-type",
+      "type": "String",
+      "desc": "This parameter is used to set tags for different themes. This parameter is applicable only when multiple themes are selected. By default, tag-type is empty. The options of this parameter are success, info, warning, and danger. When the Aurora theme is used, set this parameter to info.",
+      "defaultValue": ""
+    },
     {
       "name": "placement",
       "sample": "popup-style-position",

package/resources/pc/api/en-US/toggle-menu.json

@@ -8,8 +8,8 @@
       "defaultValue": ""
     },
     {
-      "name": "dragable",
-      "sample": "dragable",
+      "name": "draggable",
+      "sample": "draggable",
       "type": "Boolean",
       "desc": "Whether to enable the node drag function. The default value is `false`",
       "defaultValue": ""
@@ -51,7 +51,7 @@
     },
     {
       "name": "ellipsis",
-      "sample": "dragable",
+      "sample": "draggable",
       "type": "Boolean",
       "desc": "Omitted if the menu content is too long. The default value is false.",
       "defaultValue": ""
@@ -155,7 +155,7 @@
       "name": "node-drop",
       "sample": "node-drop",
       "type": "Function(arg1, arg2)",
-      "desc": "Indicates the event after a node is dragged and dropped. This parameter is valid when the dragable attribute is set to true. ; Events after a node is dragged and dropped. This parameter is valid when the dragable attribute is set to true. ; / / Parameter \narg1:Object Data information object of the current dragged node \n arg2:Object Data information object of the current clicked node after the dragged node \narg3:Drag type \narg4:event",
+      "desc": "Indicates the event after a node is dragged and dropped. This parameter is valid when the draggable attribute is set to true. ; Events after a node is dragged and dropped. This parameter is valid when the draggable attribute is set to true. ; / / Parameter \narg1:Object Data information object of the current dragged node \n arg2:Object Data information object of the current clicked node after the dragged node \narg3:Drag type \narg4:event",
       "defaultValue": ""
     }
   ]

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

@@ -33,7 +33,7 @@
       "sample": "type",
       "type": "String",
       "desc": "设置警告的类型;该属性的可选值为 success/warning/info/error",
-      "defaultValue": "该属性的默认值为 info"
+      "defaultValue": "该属性的默认值为 success"
     },
     {
       "name": "description",
@@ -47,7 +47,7 @@
       "sample": "center",
       "type": "Boolean",
       "desc": "文字是否居中",
-      "defaultValue": "该属性的默认值为 true"
+      "defaultValue": "该属性的默认值为 false"
     },
     {
       "name": "close-text",
@@ -90,7 +90,7 @@
   "events": [
     {
       "name": "close",
-      "sample": "close",
+      "sample": "close-events",
       "type": "",
       "desc": "关闭 alert 时触发的事件",
       "defaultValue": ""

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

@@ -1,5 +1,5 @@
 {
-  "attrs": [
+  "breadcrumbAttrs": [
     {
       "name": "separator",
       "sample": "separator",
@@ -29,24 +29,15 @@
       "defaultValue": "label"
     }
   ],
-  "events": [
+  "breadcrumbEvents": [
     {
       "name": "select",
-      "sample": "base",
+      "sample": "options",
       "type": "Function",
       "desc": "点击 breadcrumb-item 时触发",
       "defaultValue": ""
     }
   ],
-  "slots": [
-    {
-      "name": "default",
-      "sample": "slot-default",
-      "type": "",
-      "desc": "默认插槽",
-      "defaultValue": ""
-    }
-  ],
   "breadcrumbItemAttrs": [
     {
       "name": "to",

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

@@ -18,7 +18,7 @@
       "name": "data",
       "sample": "data",
       "type": "Array",
-      "desc": "按钮组数据。例：[{text: '', value: ''}]",
+      "desc": "按钮组数据。例：[{text: '', value: ''}]。",
       "defaultValue": ""
     },
     {
@@ -67,7 +67,7 @@
       "name": "border",
       "sample": "border",
       "type": "Boolean",
-      "desc": "是否显示边框线",
+      "desc": "是否显示边框线。",
       "defaultValue": "该属性的默认值为 true"
     }
   ],
@@ -83,10 +83,17 @@
   "events": [
     {
       "name": "edit",
-      "sample": "edit",
+      "sample": "event-edit",
       "type": "",
       "desc": "设置当编辑按钮被点击时触发的回调函数。",
       "defaultValue": ""
+    },
+    {
+      "name": "change",
+      "sample": "change-event",
+      "type": "",
+      "desc": "当选中按钮发生改变时触发的回调函数。",
+      "defaultValue": ""
     }
   ]
 }

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

@@ -1,5 +1,5 @@
 {
-  "attrs": [
+  "Carousel Attrs": [
     {
       "name": "arrow",
       "sample": "up-down-carousel",
@@ -11,14 +11,14 @@
       "name": "autoplay",
       "sample": "autoplay",
       "type": "Boolean",
-      "desc": "是否自动切换。",
+      "desc": "是否自动切换",
       "defaultValue": "该属性的默认值为 false"
     },
     {
       "name": "height",
       "sample": "indicator-trigger",
       "type": "String",
-      "desc": "走马灯的高度。",
+      "desc": "走马灯的高度",
       "defaultValue": ""
     },
     {
@@ -32,28 +32,28 @@
       "name": "initial-index",
       "sample": "manual-play",
       "type": "Number",
-      "desc": "初始状态激活的幻灯片的索引，从 0 开始 。",
+      "desc": "初始状态激活的幻灯片的索引，从 0 开始",
       "defaultValue": "该属性的默认值为 0"
     },
     {
       "name": "interval",
       "sample": "play-interval",
       "type": "Number",
-      "desc": "自动切换的时间间隔，单位为毫秒。",
+      "desc": "自动切换的时间间隔，单位为毫秒",
       "defaultValue": "该属性的默认值为 3000"
     },
     {
       "name": "show-title",
       "sample": "show-title",
       "type": "Boolean",
-      "desc": "是否显示标题。",
+      "desc": "是否显示标题",
       "defaultValue": "该属性的默认值为 false"
     },
     {
       "name": "trigger",
       "sample": "indicator-trigger",
       "type": "String",
-      "desc": "指示器的触发方式，默认为 hover。;该属性的可选值为 click",
+      "desc": "指示器的触发方式，默认为 hover。该属性的可选值为 click",
       "defaultValue": "该属性的默认值为 hover"
     },
     {
@@ -71,7 +71,7 @@
       "defaultValue": "该属性的默认值为 true"
     }
   ],
-  "slots": [
+  "Carousel Slots": [
     {
       "name": "default",
       "sample": "manual-play",
@@ -80,12 +80,12 @@
       "defaultValue": ""
     }
   ],
-  "methods": [
+  "Carousel Methods": [
     {
       "name": "next",
       "sample": "manual-play",
       "type": "",
-      "desc": "切换至下一张幻灯片。",
+      "desc": "切换至下一张幻灯片",
       "defaultValue": ""
     },
     {
@@ -103,13 +103,38 @@
       "defaultValue": ""
     }
   ],
-  "events": [
+  "Carousel Events": [
     {
       "name": "change",
-      "sample": "manual-play",
+      "sample": "carousel-events",
       "type": "",
       "desc": "幻灯片切换时触发",
       "defaultValue": ""
     }
+  ],
+  "Carousel-Item Attrs": [
+    {
+      "name": "title",
+      "sample": "show-title",
+      "type": "String",
+      "desc": "幻灯片标题",
+      "defaultValue": ""
+    },
+    {
+      "name": "name",
+      "sample": "show-title",
+      "type": "String",
+      "desc": "幻灯片名称",
+      "defaultValue": ""
+    }
+  ],
+  "Carousel-Item Slots": [
+    {
+      "name": "default",
+      "sample": "manual-play",
+      "type": "",
+      "desc": "默认插槽",
+      "defaultValue": ""
+    }
   ]
-}
+}

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

@@ -1,8 +1,8 @@
 {
-  "attrs": [
+  "collapseAttrs": [
     {
       "name": "modelValue / v-model",
-      "sample": "accordion",
+      "sample": "basic-usage",
       "type": "String , Array , Number",
       "desc": "当前激活的面板(如果是手风琴模式，绑定值类型需要为String，否则为array)",
       "defaultValue": ""
@@ -22,7 +22,7 @@
       "defaultValue": ""
     }
   ],
-  "slots": [
+  "collapseSlots": [
     {
       "name": "default",
       "sample": "dynamic-disable",
@@ -31,7 +31,7 @@
       "defaultValue": ""
     }
   ],
-  "events": [
+  "collapseEvents": [
     {
       "name": "change",
       "sample": "collapse-events",
@@ -39,5 +39,65 @@
       "desc": "当前激活面板改变时触发(如果是手风琴模式，参数 activeNames 类型为String，否则为array)",
       "defaultValue": ""
     }
+  ],
+  "collapseItemAttrs": [
+    {
+      "name": "name",
+      "sample": "accordion",
+      "type": "String | Number",
+      "desc": "唯一标志符",
+      "defaultValue": ""
+    },
+    {
+      "name": "title",
+      "sample": "custom-collapse-title",
+      "type": "String",
+      "desc": "面板标题",
+      "defaultValue": ""
+    },
+    {
+      "name": "disabled",
+      "sample": "dynamic-disable",
+      "type": "Boolean",
+      "desc": "是否禁用",
+      "defaultValue": "该属性的默认值为 false"
+    },
+    {
+      "name": "title-right",
+      "sample": "custom-title-right",
+      "type": "String",
+      "desc": "自定义面板标题右侧内容",
+      "defaultValue": ""
+    }
+  ],
+  "collapseItemSlots": [
+    {
+      "name": "default",
+      "sample": "dynamic-disable",
+      "type": "",
+      "desc": "默认插槽",
+      "defaultValue": ""
+    },
+    {
+      "name": "title",
+      "sample": "custom-collapse-title",
+      "type": "",
+      "desc": "标题",
+      "defaultValue": ""
+    },
+    {
+      "name": "icon",
+      "sample": "custom-collapse-icon",
+      "type": "",
+      "desc": "展开折叠 icon 图标",
+      "defaultValue": ""
+    },
+    {
+      "name": "title-right",
+      "sample": "custom-title-right",
+      "type": "",
+      "desc": "自定义面板标题右侧内容",
+      "defaultValue": ""
+    }
   ]
 }

package/resources/pc/api/zh-CN/dialog-box.json

@@ -1,5 +1,12 @@
 {
   "attrs": [
+    {
+      "name": "visible",
+      "sample": "basic-usage",
+      "type": "Boolean",
+      "desc": "控制弹出框显示与关闭",
+      "defaultValue": "该属性的默认值为 true"
+    },
     {
       "name": "center",
       "sample": "center",
@@ -105,13 +112,6 @@
       "desc": "设置弹出框距离窗口顶部的高度，默认为屏高的 15%",
       "defaultValue": "该属性的默认值为 15vh"
     },
-    {
-      "name": "visible",
-      "sample": "basic-usage",
-      "type": "Boolean",
-      "desc": "控制弹出框显示与关闭",
-      "defaultValue": "该属性的默认值为 true"
-    },
     {
       "name": "width",
       "sample": "dialog-width",

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

@@ -0,0 +1,120 @@
+{
+  "attrs": [
+    {
+      "name": "visible",
+      "sample": "basic-usage",
+      "type": "Boolean",
+      "desc": "控制抽屉显示与关闭",
+      "defaultValue": ""
+    },
+    {
+      "name": "placement",
+      "sample": "placement",
+      "type": "String",
+      "desc": "添加 placement 属性设置抽屉的方向，可选值有 left|right|top|bottom",
+      "defaultValue": "right"
+    },
+    {
+      "name": "width",
+      "sample": "width",
+      "type": "String",
+      "desc": "设置抽屉的宽度",
+      "defaultValue": "500px"
+    },
+    {
+      "name": "dragable",
+      "sample": "dragable",
+      "type": "Boolean",
+      "desc": "控制抽屉开启或关闭宽度拖拽功能",
+      "defaultValue": "false"
+    },
+    {
+      "name": "mask",
+      "sample": "mask",
+      "type": "Boolean",
+      "desc": "控制遮罩层显示隐藏 ",
+      "defaultValue": "true"
+    },
+    {
+      "name": "mask-closable",
+      "sample": "mask-closable",
+      "type": "Boolean",
+      "desc": "默认弹窗打开后，可以单击遮罩层关闭弹窗，设置 mask-closable 为 false 后将禁用该功能",
+      "defaultValue": "true"
+    },
+    {
+      "name": "show-close",
+      "sample": "show-close",
+      "type": "Boolean",
+      "desc": "控制关闭图标显示",
+      "defaultValue": "true"
+    },
+    {
+      "name": "show-header",
+      "sample": "show-header",
+      "type": "Boolean",
+      "desc": "控制头部显示",
+      "defaultValue": "true"
+    },
+    {
+      "name": "show-footer",
+      "sample": "show-footer",
+      "type": "Boolean",
+      "desc": "控制底部显示",
+      "defaultValue": "false"
+    },
+    {
+      "name": "z-index",
+      "sample": "z-index",
+      "type": "Number",
+      "desc": "自定义堆叠顺序（对于某些特殊场景，比如被遮挡时可能会用到）",
+      "defaultValue": "该属性的默认值为 2000"
+    }
+  ],
+  "slots": [
+    {
+      "name": "default",
+      "sample": "default-slot",
+      "type": "",
+      "desc": "默认插槽",
+      "defaultValue": ""
+    },
+    {
+      "name": "header",
+      "sample": "header-slot",
+      "type": "",
+      "desc": "头部插槽",
+      "defaultValue": ""
+    },
+    {
+      "name": "header-right",
+      "sample": "header-right-slot",
+      "type": "",
+      "desc": "头部右侧插槽",
+      "defaultValue": ""
+    },
+    {
+      "name": "footer",
+      "sample": "footer-slot",
+      "type": "",
+      "desc": "底部插槽",
+      "defaultValue": ""
+    }
+  ],
+  "events": [
+    {
+      "name": "close",
+      "sample": "close-event",
+      "type": "Function(params)",
+      "desc": "关闭抽屉事件",
+      "defaultValue": ""
+    },
+    {
+      "name": "confirm",
+      "sample": "confirm-event",
+      "type": "Function(params)",
+      "desc": "确认事件，设置 :show-footer=\"true\" 时有效",
+      "defaultValue": ""
+    }
+  ]
+}

package/resources/pc/api/zh-CN/drop-times.json

@@ -1,5 +1,12 @@
 {
   "attrs": [
+    {
+      "name": "modelValue / v-model",
+      "sample": "start-end-step",
+      "type": "—",
+      "desc": "绑定值",
+      "defaultValue": "该属性的默认值为 {}"
+    },
     {
       "name": "size",
       "sample": "size",
@@ -21,13 +28,6 @@
       "desc": "是否将弹出框插入至 body 元素。在弹出框的定位出现问题时，可将该属性设置为 false (可参考 select 组件)",
       "defaultValue": "该属性的默认值为 true"
     },
-    {
-      "name": "modelValue / v-model",
-      "sample": "start-end-step",
-      "type": "—",
-      "desc": "绑定值",
-      "defaultValue": "该属性的默认值为 {}"
-    },
     {
       "name": "placeholder",
       "sample": "start-end-step",