@opentiny/vue-docs 2.2.20 → 2.2.22

package/demos/apis/action-menu.js

@@ -17,6 +17,17 @@ export default {
           mode: ['pc'],
           pcDemo: 'max-show-num'
         },
+        {
+          name: 'mode',
+          type: '"default" | "card"',
+          defaultValue: '"default"',
+          desc: {
+            'zh-CN': '菜单按钮模式',
+            'en-US': 'Card mode'
+          },
+          mode: ['pc'],
+          pcDemo: 'card-mode'
+        },
         {
           name: 'more-text',
           type: 'string',

package/demos/apis/cascader.js

@@ -376,6 +376,16 @@ export default {
           },
           mode: ['pc'],
           pcDemo: 'filterable'
+        },
+        {
+          name: 'no-data',
+          defaultValue: '',
+          desc: {
+            'zh-CN': '通过 <code>no-data</code> 插槽设置没有数据时显示的内容',
+            'en-US': 'Set what is displayed when there is no data via the <code>no-data</code> slot'
+          },
+          mode: ['pc'],
+          pcDemo: 'slot-nodata'
         }
       ]
     },

package/demos/apis/config-provider.js

@@ -21,7 +21,7 @@ export default {
           type: "'ltr' | 'rtl'",
           defaultValue: 'ltr',
           desc: {
-            'zh-CN': '文字排版方向',
+            'zh-CN': '文字样式方向',
             'en-US': 'Text layout direction'
           },
           mode: ['pc'],

package/demos/apis/date-picker.js

@@ -624,7 +624,7 @@ interface IPickerOptions {
       name: 'IType',
       type: 'type',
       code: `
-type IType = 'date' | 'dates' | 'daterange' | 'datetime' | 'datetimerange' | 'week' | 'month' | 'monthrange' | 'year' | 'years' | 'yearrange'
+type IType = 'date' | 'dates' | 'daterange' | 'datetime' | 'datetimerange' | 'week' | 'month' | 'monthrange' | 'quarter' | 'year' | 'years' | 'yearrange'
       `
     }
   ]

package/demos/apis/float-button.js

@@ -1,21 +1,21 @@
 export default {
   mode: ['pc'],
+
   apis: [
     {
-      'name': 'button',
+      'name': 'float-button',
       'type': 'component',
       'props': [
         {
           'name': 'type',
-          'type': 'IButtonType',
-          'typeAnchorName': 'IButtonType',
+          'type': 'IFloatButtonType',
           'defaultValue': '--',
           'desc': {
             'zh-CN': '展示按钮不同的状态，设置为text则展示为文本按钮',
             'en-US': 'Display different states of buttons, set to text to display as text buttons'
           },
           mode: ['pc'],
-          pcDemo: 'basic-usage'
+          'pcDemo': 'basic-usage'
         },
         {
           'name': 'description',
@@ -26,7 +26,7 @@ export default {
             'en-US': 'Set the text displayed by the button'
           },
           mode: ['pc'],
-          pcDemo: 'basic-usage'
+          'pcDemo': 'basic-usage'
         },
         {
           'name': 'icon',
@@ -37,7 +37,7 @@ export default {
             'en-US': 'The icon displayed by the button is received as an Icon component'
           },
           mode: ['pc'],
-          pcDemo: 'icon'
+          'pcDemo': 'icon'
         },
         {
           'name': 'reset-time',
@@ -48,7 +48,7 @@ export default {
             'en-US': 'Set the button disable time, in milliseconds, to prevent repeated submission'
           },
           mode: ['pc'],
-          pcDemo: 'reset-time'
+          'pcDemo': 'reset-time'
         },
         {
           'name': 'trigger',
@@ -59,7 +59,7 @@ export default {
             'en-US': 'Set the menu trigger mode.'
           },
           mode: ['pc'],
-          pcDemo: 'trigger'
+          'pcDemo': 'trigger'
         },
         {
           'name': 'open',
@@ -70,7 +70,7 @@ export default {
             'en-US': 'Whether the settings menu opens.'
           },
           mode: ['pc'],
-          pcDemo: 'trigger'
+          'pcDemo': 'trigger'
         },
         {
           'name': 'shape',
@@ -81,7 +81,7 @@ export default {
             'en-US': 'Set Button shape.'
           },
           mode: ['pc'],
-          pcDemo: 'basic-usage'
+          'pcDemo': 'basic-usage'
         },
         {
           'name': 'backTop',
@@ -92,7 +92,7 @@ export default {
             'en-US': 'Set whether it is a back-to-top button.'
           },
           mode: ['pc'],
-          pcDemo: 'backTop'
+          'pcDemo': 'backTop'
         },
 
         {
@@ -104,7 +104,7 @@ export default {
             'en-US': 'When backTop is set to true, this property sets the scrolling element.'
           },
           mode: ['pc'],
-          pcDemo: 'backTop'
+          'pcDemo': 'backTop'
         },
         {
           'name': 'top',
@@ -115,7 +115,7 @@ export default {
             'en-US': 'The distance of the button from the top.'
           },
           mode: ['pc'],
-          pcDemo: 'basic-usage'
+          'pcDemo': 'basic-usage'
         },
         {
           'name': 'bottom',
@@ -126,7 +126,7 @@ export default {
             'en-US': 'The distance of the button from the bottom.'
           },
           mode: ['pc'],
-          pcDemo: 'basic-usage'
+          'pcDemo': 'basic-usage'
         },
         {
           'name': 'left',
@@ -137,7 +137,7 @@ export default {
             'en-US': 'The distance of the button from the left.'
           },
           mode: ['pc'],
-          pcDemo: 'basic-usage'
+          'pcDemo': 'basic-usage'
         },
         {
           'name': 'right',
@@ -148,7 +148,7 @@ export default {
             'en-US': 'The distance of the button from the right.'
           },
           mode: ['pc'],
-          pcDemo: 'basic-usage'
+          'pcDemo': 'basic-usage'
         },
         {
           'name': 'href',
@@ -159,7 +159,7 @@ export default {
             'en-US': 'button to jump to the page.'
           },
           mode: ['pc'],
-          pcDemo: 'jump'
+          'pcDemo': 'jump'
         },
         {
           'name': 'target',
@@ -170,7 +170,7 @@ export default {
             'en-US': 'The target attribute equivalent to the A tag, which takes effect when the href exists.'
           },
           mode: ['pc'],
-          pcDemo: 'jump'
+          'pcDemo': 'jump'
         }
       ],
       'events': [
@@ -183,7 +183,7 @@ export default {
             'en-US': 'Sets the callback function triggered when a button is clicked'
           },
           mode: ['pc'],
-          pcDemo: 'click'
+          'pcDemo': 'click'
         }
       ],
       'slots': [
@@ -196,16 +196,16 @@ export default {
             'en-US': 'Default slot, customize what the button is when expanded'
           },
           mode: ['pc'],
-          pcDemo: 'open'
+          'pcDemo': 'open'
         }
       ]
     }
   ],
   types: [
     {
-      name: 'IButtonType',
+      name: 'IFloatButtonType',
       type: 'interface',
-      code: `type IButtonType = 'primary' | 'success' | 'warning' | 'danger' | 'info' | 'text'`
+      code: `type IFloatButtonType = 'primary' | 'success' | 'warning' | 'danger' | 'info' | 'text'`
     }
   ]
 }

package/demos/apis/form.js

@@ -385,6 +385,17 @@ export default {
           mode: ['pc'],
           pcDemo: ''
         },
+        {
+          name: 'extra',
+          type: 'string',
+          defaultValue: '',
+          desc: {
+            'zh-CN': '表单项额外提示',
+            'en-US': 'Form item extra tip'
+          },
+          mode: ['pc'],
+          pcDemo: 'extra-tip'
+        },
         {
           name: 'inline-message',
           type: 'boolean',
@@ -581,6 +592,16 @@ export default {
           },
           mode: ['pc'],
           pcDemo: 'slot-label'
+        },
+        {
+          name: 'error',
+          defaultValue: '',
+          desc: {
+            'zh-CN': '错误提示内容',
+            'en-US': 'Error content'
+          },
+          mode: ['pc'],
+          pcDemo: 'error-label'
         }
       ]
     }

package/demos/apis/hui.js

@@ -0,0 +1,49 @@
+export default {
+  mode: ['pc'],
+  apis: [
+    {
+      name: 'chart',
+      type: 'component',
+      props: [
+        {
+          name: 'options',
+          type: 'object',
+          defaultValue: '--',
+          desc: {
+            'zh-CN': '图表参数',
+            'en-US': 'Whether to disable container detection during resize'
+          },
+          mode: ['pc'],
+          pcDemo: 'chart/question#question-base'
+        }
+      ],
+      events: [],
+      methods: [],
+      slots: []
+    }
+  ],
+  types: [
+    {
+      name: 'options',
+      type: 'interface',
+      code: `
+interface options {
+  theme: string // 主题
+  color: array | string // 颜色
+  padding: array // 图表内边距值
+  tipHtml: function // 悬浮提示框内容配置
+  event: object // 图表事件
+  data: array // 图表数据
+  name: string // 图表名称(必填)
+  unit: string // 进度图右侧文本单位
+  barWidth: number // 进度图柱形宽度
+  minWidth: string // 进度图单项数据的最小宽度
+  calibrationValue: number // 进度图标定值
+  label: object // 堆叠进度图图表图元文本样式
+  state: object // 根据状态设置颜色
+  title: object // 进度图图表标题样式
+  text: object // 进度图图表右侧文本样式
+}`
+    }
+  ]
+}

package/demos/apis/image.js

@@ -19,7 +19,7 @@ export default {
         },
         {
           name: 'image-size',
-          type: 'String',
+          type: 'string',
           defaultValue: '',
           desc: {
             'zh-CN': '设置预览的图片的大小',
@@ -54,7 +54,7 @@ export default {
         },
         {
           name: 'preview-visible',
-          type: 'String',
+          type: 'string',
           defaultValue: '',
           desc: {
             'zh-CN': '开启移动端预览大图的功能',
@@ -65,7 +65,7 @@ export default {
         },
         {
           name: 'round',
-          type: 'String',
+          type: 'string',
           defaultValue: '',
           desc: {
             'zh-CN': '通过 round 设置是否展示圆形',
@@ -90,7 +90,7 @@ export default {
         },
         {
           name: 'show-hover',
-          type: 'String',
+          type: 'string',
           defaultValue: '',
           desc: {
             'zh-CN': '设置预览的图片的悬浮效果',
@@ -101,14 +101,15 @@ export default {
         },
         {
           name: 'show-index',
-          type: 'String',
+          type: 'boolean',
           defaultValue: '',
           desc: {
             'zh-CN': '开启图片序列号展示',
             'en-US': 'Enable the display of image serial numbers.'
           },
-          mode: ['mobile-first'],
-          mfDemo: 'preview-src-list'
+          mode: ['pc', 'mobile-first'],
+          mfDemo: 'preview-src-list',
+          pcDemo: 'preview'
         },
         {
           name: 'src',
@@ -133,6 +134,18 @@ export default {
           mode: ['pc', 'mobile-first'],
           pcDemo: '',
           mfDemo: ''
+        },
+        {
+          name: 'keep-style',
+          type: 'boolean',
+          defaultValue: '',
+          desc: {
+            'zh-CN': '保持图片样式属性',
+            'en-US': 'Preserve Picture Style Properties'
+          },
+          mode: ['pc', 'mobile-first'],
+          pcDemo: 'keep-style',
+          mfDemo: ''
         }
       ],
       events: [
@@ -197,6 +210,18 @@ export default {
           mode: ['pc', 'mobile-first'],
           pcDemo: 'slot',
           mfDemo: ''
+        },
+        {
+          name: 'count',
+          type: '',
+          defaultValue: '',
+          desc: {
+            'zh-CN': '设置图片计数插槽',
+            'en-US': 'Set Picture Count Slot'
+          },
+          mode: ['pc', 'mobile-first'],
+          pcDemo: 'count-slot',
+          mfDemo: ''
         }
       ]
     }

package/demos/apis/mind-map.js

@@ -7,24 +7,26 @@ export default {
       props: [
         {
           name: 'modelValue',
-          type: 'NodeObj',
+          type: 'Object',
           defaultValue: '{}',
           desc: {
             'zh-CN': '默认节点数据',
             'en-US': 'Default node data'
           },
           mode: ['pc'],
-          pcDemo: 'basic-usage'
+          pcDemo: 'export-data'
         },
         {
           name: 'options',
-          type: 'Options',
+          typeAnchorName: 'IMindMaoOptions',
+          type: 'IMindMaoOptions',
           defaultValue: '{contextMenu: false,toolBar: false,nodeMenu: false}',
           desc: {
             'zh-CN': '配置项',
             'en-US': 'options'
           },
-          mode: ['pc']
+          mode: ['pc'],
+          pcDemo: 'export-data'
         }
       ],
       events: [
@@ -57,7 +59,8 @@ export default {
         },
         {
           name: 'expandNode',
-          type: 'onExpandNode',
+          typeAnchorName: 'IMindExpandNode',
+          type: 'IMindnExpandNode',
           desc: {
             'zh-CN': '展开节点时会触发该事件',
             'en-US': 'This event will be triggered when expanding a node'
@@ -66,7 +69,8 @@ export default {
         },
         {
           name: 'operation',
-          type: 'onOperation',
+          typeAnchorName: 'IMindMapOperation',
+          type: 'IMindMapOperation',
           desc: {
             'zh-CN': '节点重新计算时, 例如将节点A拖拽到节点B, 使得节点A是节点B的子节点',
             'en-US':
@@ -76,7 +80,8 @@ export default {
         },
         {
           name: 'selectNewNode',
-          type: 'onSelectNewNode',
+          typeAnchorName: 'IMindMapSelectNewNode',
+          type: 'IMindMapSelectNewNode',
           desc: {
             'zh-CN': '创建新节点时',
             'en-US': 'when create new node'
@@ -85,7 +90,8 @@ export default {
         },
         {
           name: 'selectNode',
-          type: 'onSelectNode',
+          typeAnchorName: 'IMindMapSelectNode',
+          type: 'IMindMapSelectNode',
           desc: {
             'zh-CN': '选择任意一个节点时, 会触发该事件',
             'en-US': 'When selecting any node, this event will be triggered'
@@ -94,7 +100,8 @@ export default {
         },
         {
           name: 'selectNodes',
-          type: 'onSelectNodes',
+          typeAnchorName: 'IMindMapSelectNodes',
+          type: 'IMindMapSelectNodes',
           desc: {
             'zh-CN': '选择多个节点的时候会触发该事件',
             'en-US': 'When selecting multiple nodes, this event will be triggered'
@@ -103,7 +110,8 @@ export default {
         },
         {
           name: 'unselectNode',
-          type: 'onUnselectNode',
+          typeAnchorName: 'IMindMapUnselectNode',
+          type: 'IMindMapUnselectNode',
           desc: {
             'zh-CN': '取消选择的时候会触发该事件',
             'en-US': 'When deselecting, this event will be triggered'
@@ -112,7 +120,8 @@ export default {
         },
         {
           name: 'unselectNodes',
-          type: 'onUnselectNode',
+          typeAnchorName: 'IMindMapUnselectNodes',
+          type: 'IMindMapUnselectNodes',
           desc: {
             'zh-CN': '取消选择多个节点时会触发该事件',
             'en-US': 'This event will be triggered when multiple nodes are unselected'
@@ -126,10 +135,10 @@ export default {
   ],
   types: [
     {
-      name: 'Options',
+      name: 'IMindMaoOptions',
       type: 'interface',
       code: `
-interface Options {
+interface options {
   direction?: number
   locale?: string
   draggable?: boolean
@@ -152,53 +161,39 @@ interface Options {
 `
     },
     {
-      name: 'onOperation',
+      name: 'IMindMapOperation',
       type: 'type',
-      code: `
-type onOperation = ({render, info}: {render:MindElixirInstance, info: Operation}) => void
-`
+      code: `type onOperation = ({render, info}: {render:MindElixirInstance, info: Operation}) => void`
     },
     {
-      name: 'onSelectNode',
+      name: 'IMindMapSelectNode',
       type: 'type',
-      code: `
-type onSelectNode = ({render,nodeObj}: {render:MindElixirInstance,nodeObj:NodeObj}, e?: MouseEvent) => void
-`
+      code: `type onSelectNode = ({render,nodeObj}: {render:MindElixirInstance,nodeObj:NodeObj}, e?: MouseEvent) => void`
     },
     {
-      name: 'onSelectNewNode',
+      name: 'IMindMapSelectNewNode',
       type: 'type',
-      code: `
-type selectNewNode: ({render,nodeObj}: {render:MindElixirInstance,nodeObj:NodeObj}) => void
-`
+      code: `type selectNewNode: ({render,nodeObj}: {render:MindElixirInstance,nodeObj:NodeObj}) => void`
     },
     {
-      name: 'onSelectNodes',
+      name: 'IMindMapSelectNodes',
       type: 'type',
-      code: `
-type selectNodes: ({render,nodeObj}: {render:MindElixirInstance,nodeObj:NodeObj[]}) => void
-`
+      code: `type selectNodes: ({render,nodeObj}: {render:MindElixirInstance,nodeObj:NodeObj[]}) => void`
     },
     {
-      name: 'onUnselectNode',
+      name: 'IMindMapUnselectNode',
       type: 'type',
-      code: `
-type unselectNodes: ({render}: {render: MindElixirInstance}) => void
-`
+      code: `type unselectNodes: ({render}: {render: MindElixirInstance}) => void`
     },
     {
-      name: 'onUnselectNodes',
+      name: 'IMindMapUnselectNodes',
       type: 'type',
-      code: `
-type unselectNodes: ({render}: {render: MindElixirInstance}) => void
-`
+      code: `type unselectNodes: ({render}: {render: MindElixirInstance}) => void`
     },
     {
-      name: 'onExpandNode',
+      name: 'IMindExpandNode',
       type: 'type',
-      code: `
-type expandNode: ({render,nodeObj}: {render:MindElixirInstance,nodeObj:NodeObj}) => void
-`
+      code: `type expandNode: ({render,nodeObj}: {render:MindElixirInstance,nodeObj:NodeObj}) => void`
     },
     {
       name: 'NodeObj',

package/demos/apis/numeric.js

@@ -17,6 +17,18 @@ export default {
           pcDemo: 'allow-empty',
           mfDemo: ''
         },
+        {
+          name: 'empty-value',
+          type: 'any',
+          defaultValue: 'undefined',
+          desc: {
+            'zh-CN': '设置计数器在可清空下，清空后组件的绑定值',
+            'en-US': 'Sets the bound value of the cleared component when the counter can be cleared.'
+          },
+          mode: ['pc', 'mobile-first'],
+          pcDemo: 'empty-value',
+          mfDemo: 'empty-value'
+        },
         {
           name: 'blank',
           type: 'string',

package/demos/apis/popeditor.js

@@ -229,7 +229,7 @@ export default {
             'en-US': ''
           },
           mode: ['pc'],
-          pcDemo: 'selected-box-op'
+          pcDemo: 'selected-box'
         },
         {
           name: 'show-clear-btn',

package/demos/apis/roles.js

@@ -16,6 +16,19 @@ export default {
           },
           mode: ['pc'],
           pcDemo: 'fetch-role'
+        },
+        {
+          name: 'popper-append-to-body',
+          type: 'boolean',
+          defaultValue: 'true',
+          desc: {
+            'zh-CN':
+              '是否将弹出框插入至 body 元素。在弹出框的定位出现问题时，可将该属性设置为 false (可参考 select 组件)',
+            'en-US':
+              'Indicates whether to insert the pop-up box to the body element. If a fault occurs in locating the fault in the dialog box that is displayed, you can set this attribute to false (for details, see the select component).'
+          },
+          mode: ['pc'],
+          pcDemo: 'base'
         }
       ],
       events: [