@opentiny/vue-docs 2.2.18 → 2.2.20

package/demos/apis/card.js

@@ -1,5 +1,5 @@
 export default {
-  mode: ['mobile-first'],
+  mode: ['pc', 'mobile-first'],
   apis: [
     {
       name: 'Card',
@@ -14,7 +14,8 @@ export default {
             'en-US':
               'Indicates whether the card width is automatically expanded. After the setting, the card width is not fixed.'
           },
-          mode: ['mobile-first'],
+          mode: ['pc', 'mobile-first'],
+          pcDemo: '',
           mfDemo: 'card-auto-width'
         },
         {
@@ -26,7 +27,8 @@ export default {
             'en-US':
               'Set single-choice, multiple-choice, single-choice, and radio. Multi-choice/checkbox. You need to set the label at the same time.'
           },
-          mode: ['mobile-first'],
+          mode: ['pc', 'mobile-first'],
+          pcDemo: 'check-type-checkbox',
           mfDemo: 'check-type-checkbox'
         },
         {
@@ -37,7 +39,8 @@ export default {
             'zh-CN': '卡片的class',
             'en-US': 'Class of the card'
           },
-          mode: ['mobile-first'],
+          mode: ['pc', 'mobile-first'],
+          pcDemo: 'custom-class',
           mfDemo: 'card-custom-class'
         },
         {
@@ -48,7 +51,8 @@ export default {
             'zh-CN': '卡片禁用',
             'en-US': 'Card disabled'
           },
-          mode: ['mobile-first'],
+          mode: ['pc', 'mobile-first'],
+          pcDemo: 'card-disabled',
           mfDemo: 'card-disabled'
         },
         {
@@ -59,8 +63,9 @@ export default {
             'zh-CN': '卡片内容区域的高度',
             'en-US': 'Height of the card content area'
           },
-          mode: ['mobile-first'],
-          mfDemo: 'card-height'
+          mode: ['pc', 'mobile-first'],
+          mfDemo: 'card-height',
+          pcDemo: 'custom-class'
         },
         {
           name: 'icon-more',
@@ -70,7 +75,8 @@ export default {
             'zh-CN': '更多按钮图标，可传入一个svg图标对象进行替换',
             'en-US': 'More button icons can be replaced by a svg icon object.'
           },
-          mode: ['mobile-first'],
+          mode: ['pc', 'mobile-first'],
+          pcDemo: '',
           mfDemo: 'card-icon-more'
         },
         {
@@ -81,7 +87,8 @@ export default {
             'zh-CN': 'checkbox或radio的label',
             'en-US': 'Checkbox or radio label.'
           },
-          mode: ['mobile-first'],
+          mode: ['pc', 'mobile-first'],
+          pcDemo: 'check-type-checkbox',
           mfDemo: 'card-label'
         },
         {
@@ -92,7 +99,8 @@ export default {
             'zh-CN': '操作按钮配置',
             'en-US': ''
           },
-          mode: ['mobile-first'],
+          mode: ['pc', 'mobile-first'],
+          pcDemo: 'operate-bar',
           mfDemo: ''
         },
         {
@@ -103,7 +111,8 @@ export default {
             'zh-CN': '尺寸，支持large、medium、small、mini 4个尺寸，默认值为medium',
             'en-US': 'Size. The options are large, medium, small, and mini. The default value is medium.'
           },
-          mode: ['mobile-first'],
+          mode: ['pc', 'mobile-first'],
+          pcDemo: 'card-size',
           mfDemo: 'card-size'
         },
         {
@@ -114,7 +123,8 @@ export default {
             'zh-CN': '图片或者视频的地址',
             'en-US': 'Address of a picture or video.'
           },
-          mode: ['mobile-first'],
+          mode: ['pc', 'mobile-first'],
+          pcDemo: 'card-type',
           mfDemo: 'card-src'
         },
         {
@@ -125,7 +135,8 @@ export default {
             'zh-CN': '卡片状态，支持 success、warning、alerting、danger 4 种状态',
             'en-US': 'Card status. The value can be success, warning, alerting, or dangerous.'
           },
-          mode: ['mobile-first'],
+          mode: ['pc', 'mobile-first'],
+          pcDemo: 'card-status',
           mfDemo: 'card-status'
         },
         {
@@ -136,7 +147,8 @@ export default {
             'zh-CN': '卡片的标题',
             'en-US': 'The title of the card.'
           },
-          mode: ['mobile-first'],
+          mode: ['pc', 'mobile-first'],
+          pcDemo: 'card-status',
           mfDemo: 'card-title'
         },
         {
@@ -147,7 +159,8 @@ export default {
             'zh-CN': '设置卡片类型，支持 text、image、video、logo 4 种类型。',
             'en-US': 'Set the card type. The options are text, image, video, and logo.'
           },
-          mode: ['mobile-first'],
+          mode: ['pc', 'mobile-first'],
+          pcDemo: 'card-type',
           mfDemo: 'card-type'
         },
         {
@@ -158,7 +171,8 @@ export default {
             'zh-CN': '绑定值，默认为空',
             'en-US': ''
           },
-          mode: ['mobile-first'],
+          mode: ['pc', 'mobile-first'],
+          pcDemo: 'check-type-checkbox',
           mfDemo: ''
         }
       ],
@@ -171,7 +185,8 @@ export default {
             'zh-CN': '组件选中/取消选中事件',
             'en-US': 'Component check/uncheck event'
           },
-          mode: ['mobile-first'],
+          mode: ['pc', 'mobile-first'],
+          pcDemo: 'card-events',
           mfDemo: 'card-events'
         },
         {
@@ -182,8 +197,21 @@ export default {
             'zh-CN': '操作栏按钮点击事件',
             'en-US': 'Operation bar button click event'
           },
-          mode: ['mobile-first'],
+          mode: ['pc', 'mobile-first'],
+          pcDemo: 'card-events',
           mfDemo: 'card-events'
+        },
+        {
+          name: 'click',
+          type: 'Function()',
+          defaultValue: '',
+          desc: {
+            'zh-CN': '点击卡片事件',
+            'en-US': 'Click card event'
+          },
+          mode: ['pc', 'mobile-first'],
+          pcDemo: '',
+          mfDemo: ''
         }
       ],
       methods: [],
@@ -196,7 +224,8 @@ export default {
             'zh-CN': '组件默认插槽',
             'en-US': 'Component Default Slot'
           },
-          mode: ['mobile-first'],
+          mode: ['pc', 'mobile-first'],
+          pcDemo: 'slot',
           mfDemo: 'slot'
         },
         {
@@ -207,7 +236,8 @@ export default {
             'zh-CN': '组件默认插槽',
             'en-US': 'Component Default Slot'
           },
-          mode: ['mobile-first'],
+          mode: ['pc', 'mobile-first'],
+          pcDemo: 'slot',
           mfDemo: 'slot'
         },
         {
@@ -218,7 +248,8 @@ export default {
             'zh-CN': '标题插槽',
             'en-US': 'Header Slot'
           },
-          mode: ['mobile-first'],
+          mode: ['pc', 'mobile-first'],
+          pcDemo: 'slot',
           mfDemo: 'slot'
         },
         {
@@ -229,7 +260,8 @@ export default {
             'zh-CN': '标题左侧插槽',
             'en-US': 'Header Left Slot'
           },
-          mode: ['mobile-first'],
+          mode: ['pc', 'mobile-first'],
+          pcDemo: 'slot',
           mfDemo: 'slot'
         },
         {
@@ -240,7 +272,8 @@ export default {
             'zh-CN': '标题右侧插槽',
             'en-US': 'Header right slot'
           },
-          mode: ['mobile-first'],
+          mode: ['pc', 'mobile-first'],
+          pcDemo: 'slot',
           mfDemo: 'slot'
         }
       ]

package/demos/apis/dialog-box.js

@@ -61,6 +61,14 @@ export default {
           mode: ['pc'],
           pcDemo: 'destroy-on-close'
         },
+        {
+          name: 'drag-outside-window',
+          type: 'boolean',
+          defaultValue: 'false',
+          desc: { 'zh-CN': '可将弹窗拖出窗口', 'en-US': 'Pop ups can be dragged out of the window' },
+          mode: ['pc'],
+          pcDemo: 'draggable'
+        },
         {
           name: 'dialog-class',
           type: 'string',
@@ -200,8 +208,7 @@ export default {
           defaultValue: '',
           desc: {
             'zh-CN': '弹出框标题',
-            'en-US':
-              'Height between the pop-up box and the top of the window. The default value is 15% of the screen height'
+            'en-US': 'Pop-up Box Title'
           },
           mode: ['pc'],
           pcDemo: 'custom-dialog-title'
@@ -209,10 +216,10 @@ export default {
         {
           name: 'top',
           type: 'string',
-          defaultValue: '15vh',
+          defaultValue: `'15vh'`,
           desc: {
             'zh-CN': '设置弹出框距离窗口顶部的高度',
-            'en-US': 'Display and close pop-up boxes'
+            'en-US': 'Set the height of the popup from the top of the window'
           },
           mode: ['pc'],
           pcDemo: 'dialog-top-height'
@@ -231,7 +238,7 @@ export default {
         {
           name: 'width',
           type: 'string',
-          defaultValue: '500px',
+          defaultValue: `'500px'`,
           desc: {
             'zh-CN': '弹出框的宽度',
             'en-US': 'Wideness of the dialog box that is displayed'

package/demos/apis/fall-menu.js

@@ -7,10 +7,10 @@ export default {
       props: [
         {
           name: 'data',
-          type: 'object | object[]',
+          type: 'Array',
           defaultValue: '',
           desc: {
-            'zh-CN': '设置瀑布菜单的数据。',
+            'zh-CN': '设置瀑布菜单的数据',
             'en-US': 'Set the waterfall menu data. ;Set the data of the waterfall menu.'
           },
           mode: ['pc'],

package/demos/apis/file-upload.js

@@ -303,7 +303,8 @@ export default {
         },
         {
           name: 'http-request',
-          type: '() => Promise',
+          type: '(file: IFile) => Promise<any>',
+          typeAnchorName: 'IFile',
           defaultValue: '',
           desc: {
             'zh-CN': '覆盖默认的上传行为，可以自定义上传的实现; 由于 TinyVue 官网为 Mock 上传不能执行上传',

package/demos/apis/float-button.js

@@ -0,0 +1,211 @@
+export default {
+  mode: ['pc'],
+  apis: [
+    {
+      'name': 'button',
+      'type': 'component',
+      'props': [
+        {
+          'name': 'type',
+          'type': 'IButtonType',
+          'typeAnchorName': 'IButtonType',
+          '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'
+        },
+        {
+          'name': 'description',
+          'type': 'string',
+          'defaultValue': '--',
+          'desc': {
+            'zh-CN': '按钮显示的文本',
+            'en-US': 'Set the text displayed by the button'
+          },
+          mode: ['pc'],
+          pcDemo: 'basic-usage'
+        },
+        {
+          'name': 'icon',
+          'type': 'Component',
+          'defaultValue': '--',
+          'desc': {
+            'zh-CN': '按钮展示的图标，接收为Icon组件',
+            'en-US': 'The icon displayed by the button is received as an Icon component'
+          },
+          mode: ['pc'],
+          pcDemo: 'icon'
+        },
+        {
+          'name': 'reset-time',
+          'type': 'number',
+          'defaultValue': '1000',
+          'desc': {
+            'zh-CN': '设置按钮禁用时间，防止重复提交，单位毫秒',
+            'en-US': 'Set the button disable time, in milliseconds, to prevent repeated submission'
+          },
+          mode: ['pc'],
+          pcDemo: 'reset-time'
+        },
+        {
+          'name': 'trigger',
+          'type': 'string',
+          'defaultValue': 'click',
+          'desc': {
+            'zh-CN': '设置菜单触发模式。',
+            'en-US': 'Set the menu trigger mode.'
+          },
+          mode: ['pc'],
+          pcDemo: 'trigger'
+        },
+        {
+          'name': 'open',
+          'type': 'boolean',
+          'defaultValue': false,
+          'desc': {
+            'zh-CN': '设置菜单是否打开。',
+            'en-US': 'Whether the settings menu opens.'
+          },
+          mode: ['pc'],
+          pcDemo: 'trigger'
+        },
+        {
+          'name': 'shape',
+          'type': "'circle'|'square'",
+          'defaultValue': 'circle',
+          'desc': {
+            'zh-CN': '设置按钮形状。',
+            'en-US': 'Set Button shape.'
+          },
+          mode: ['pc'],
+          pcDemo: 'basic-usage'
+        },
+        {
+          'name': 'backTop',
+          'type': 'boolean',
+          'defaultValue': false,
+          'desc': {
+            'zh-CN': '设置是否是回到顶部按钮。',
+            'en-US': 'Set whether it is a back-to-top button.'
+          },
+          mode: ['pc'],
+          pcDemo: 'backTop'
+        },
+
+        {
+          'name': 'element',
+          'type': 'HTMLElement',
+          'defaultValue': 'document.body',
+          'desc': {
+            'zh-CN': '当backTop设置为true时，此属性设置滚动元素。',
+            'en-US': 'When backTop is set to true, this property sets the scrolling element.'
+          },
+          mode: ['pc'],
+          pcDemo: 'backTop'
+        },
+        {
+          'name': 'top',
+          'type': 'string',
+          'defaultValue': '',
+          'desc': {
+            'zh-CN': '按钮与顶部的距离。',
+            'en-US': 'The distance of the button from the top.'
+          },
+          mode: ['pc'],
+          pcDemo: 'basic-usage'
+        },
+        {
+          'name': 'bottom',
+          'type': 'string',
+          'defaultValue': '20px',
+          'desc': {
+            'zh-CN': '按钮与底部的距离。',
+            'en-US': 'The distance of the button from the bottom.'
+          },
+          mode: ['pc'],
+          pcDemo: 'basic-usage'
+        },
+        {
+          'name': 'left',
+          'type': 'string',
+          'defaultValue': '',
+          'desc': {
+            'zh-CN': '按钮与左边的距离。',
+            'en-US': 'The distance of the button from the left.'
+          },
+          mode: ['pc'],
+          pcDemo: 'basic-usage'
+        },
+        {
+          'name': 'right',
+          'type': 'string',
+          'defaultValue': '20px',
+          'desc': {
+            'zh-CN': '按钮与右边的距离。',
+            'en-US': 'The distance of the button from the right.'
+          },
+          mode: ['pc'],
+          pcDemo: 'basic-usage'
+        },
+        {
+          'name': 'href',
+          'type': 'string',
+          'defaultValue': '',
+          'desc': {
+            'zh-CN': '按钮点击后跳转的页面。',
+            'en-US': 'button to jump to the page.'
+          },
+          mode: ['pc'],
+          pcDemo: 'jump'
+        },
+        {
+          'name': 'target',
+          'type': 'string',
+          'defaultValue': '',
+          'desc': {
+            'zh-CN': '相当于<code>a</code> 标签的 <code>target</code> 属性，<code>href</code> 存在时生效。',
+            'en-US': 'The target attribute equivalent to the A tag, which takes effect when the href exists.'
+          },
+          mode: ['pc'],
+          pcDemo: 'jump'
+        }
+      ],
+      'events': [
+        {
+          'name': 'click',
+          'type': '(event: PointEvent) => void',
+          'defaultValue': '--',
+          'desc': {
+            'zh-CN': '当按钮被点击时触发的回调函数',
+            'en-US': 'Sets the callback function triggered when a button is clicked'
+          },
+          mode: ['pc'],
+          pcDemo: 'click'
+        }
+      ],
+      'slots': [
+        {
+          'name': 'default',
+          'type': '',
+          'defaultValue': '--',
+          'desc': {
+            'zh-CN': '默认插槽，自定义按钮展开时的内容',
+            'en-US': 'Default slot, customize what the button is when expanded'
+          },
+          mode: ['pc'],
+          pcDemo: 'open'
+        }
+      ]
+    }
+  ],
+  types: [
+    {
+      name: 'IButtonType',
+      type: 'interface',
+      code: `type IButtonType = 'primary' | 'success' | 'warning' | 'danger' | 'info' | 'text'`
+    }
+  ]
+}