@opentiny/vue-docs 3.20.7 → 3.21.0

package/cp-component-md.sh

@@ -0,0 +1,7 @@
+#!/bin/bash
+
+for file in ./examples/sites/dist/\@demos/app/*
+do
+  component=${file##*/}
+  cp ./examples/sites/dist/\@demos/app/${component}/webdoc/*.md ./_site/\@demos/app/${component}/webdoc
+done

package/demos/apis/actionsheet.js

@@ -37,6 +37,17 @@ export default {
           },
           mode: ['mobile'],
           mobileDemo: 'ellipsis'
+        },
+        {
+          name: 'content-position',
+          type: 'Boolean',
+          defaultValue: 'false',
+          desc: {
+            'zh-CN': '是否显示action插槽',
+            'en-US': 'Whether to display action slots '
+          },
+          mode: ['mobile'],
+          mobileDemo: 'slot-action'
         }
       ],
       events: [
@@ -70,12 +81,22 @@ export default {
           name: 'action',
           defaultValue: '',
           desc: {
-            'zh-CN': '<p>自定义操作项内容</p>',
+            'zh-CN': '<p>action插槽</p>',
             'en-US': 'Click'
           },
           mode: ['mobile'],
           mobileDemo: 'slot-action'
         },
+        {
+          name: 'item',
+          defaultValue: '',
+          desc: {
+            'zh-CN': '<p>item插槽</p>',
+            'en-US': 'Click'
+          },
+          mode: ['mobile'],
+          mobileDemo: 'slot-item'
+        },
         {
           mode: []
         }

package/demos/apis/alert.js

@@ -118,6 +118,20 @@ export default {
           pcDemo: 'show-icon',
           mfDemo: ''
         },
+        {
+          name: 'show-title',
+          type: 'boolean',
+          defaultValue: 'true',
+          desc: {
+            'zh-CN': '是否显示标题，在 size 为 large 时有效',
+            'en-US': 'Display title,valid when size is large'
+          },
+          mode: ['pc', 'mobile-first'],
+          pcDemo: 'title',
+          meta: {
+            stable: '3.21.0'
+          }
+        },
         {
           name: 'single-line',
           type: 'String',

package/demos/apis/dialog-box.js

@@ -246,6 +246,36 @@ export default {
           mode: ['pc'],
           pcDemo: 'dialog-width'
         },
+        {
+          name: 'custom-style',
+          type: 'string',
+          defaultValue: ``,
+          desc: {
+            'zh-CN': '自定义实现双层抽屉',
+            'en-US': 'Custom Styles'
+          },
+          meta: {
+            stable: '3.21.0'
+          },
+          mode: ['pc', 'mobile-first'],
+          pcDemo: 'double-dialog-height',
+          mfDemo: 'double-dialog-height'
+        },
+        {
+          name: 'no-animation',
+          type: 'string',
+          defaultValue: ``,
+          desc: {
+            'zh-CN': '是否开启动画',
+            'en-US': 'Indicates whether to enable animation'
+          },
+          meta: {
+            stable: '3.21.0'
+          },
+          mode: ['pc', 'mobile-first'],
+          pcDemo: 'double-dialog-height',
+          mfDemo: 'double-dialog-height'
+        },
         {
           name: 'dialog-transition',
           type: 'string',

package/demos/apis/divider.js

@@ -10,11 +10,13 @@ export default {
           type: 'string',
           defaultValue: "'solid'",
           desc: {
-            'zh-CN': '设置分隔线的样式，该属性的可选值为 solid / dashed',
-            'en-US': 'Set the style of the separator line, with optional values of solid/dashed for this property'
+            'zh-CN': '设置分隔线的样式，该属性的可选值为 solid / dashed / dotted',
+            'en-US':
+              'Set the style of the separator line, with optional values of solid/dashed/dotted for this property'
           },
-          mode: ['pc'],
-          pcDemo: 'custom-style'
+          mode: ['pc', 'mobile-first'],
+          pcDemo: 'custom-style',
+          mfDemo: 'type'
         },
         {
           name: 'color',
@@ -24,8 +26,9 @@ export default {
             'zh-CN': '设置分隔线的颜色',
             'en-US': 'Set the color of the divider.'
           },
-          mode: ['pc'],
-          pcDemo: 'custom-style'
+          mode: ['pc', 'mobile-first'],
+          pcDemo: 'custom-style',
+          mfDemo: 'color'
         },
         {
           name: 'content-background-color',
@@ -58,8 +61,9 @@ export default {
             'en-US':
               'Set the position of the separator text, with optional values of left/center/right for this attribute'
           },
-          mode: ['pc'],
-          pcDemo: 'content-position'
+          mode: ['pc', 'mobile-first'],
+          pcDemo: 'content-position',
+          mfDemo: 'content-position'
         },
         {
           name: 'direction',
@@ -70,8 +74,83 @@ export default {
             'en-US':
               'Set the direction of the divider; the possible values for this property are "horizontal" or "vertical"'
           },
+          mode: ['pc', 'mobile-first'],
+          pcDemo: 'direction',
+          mfDemo: 'vertical'
+        },
+        {
+          name: 'margin',
+          type: 'string',
+          defaultValue: '',
+          desc: {
+            'zh-CN': '设置分割线上下左右的边距',
+            'en-US': 'Sets the margins of the split line'
+          },
+          meta: {
+            stable: '3.21.0'
+          },
+          mode: ['pc', 'mobile-first'],
+          pcDemo: 'custom-style',
+          mfDemo: 'divider-margin'
+        },
+        {
+          name: 'offset',
+          type: 'string',
+          defaultValue: '',
+          desc: {
+            'zh-CN': '设置文本位置偏移量，需同时配合`text-position`属性使用，以确定偏移的方向',
+            'en-US':
+              'Sets the text position offset. This parameter must be used together with the `text-position` attribute to determine the offset direction'
+          },
+          meta: {
+            stable: '3.21.0'
+          },
+          mode: ['pc', 'mobile-first'],
+          pcDemo: 'content-position',
+          mfDemo: 'offset'
+        },
+        {
+          name: 'height',
+          type: 'string',
+          defaultValue: '',
+          desc: {
+            'zh-CN': '设置整体的高度',
+            'en-US': 'Sets the overall height'
+          },
+          meta: {
+            stable: '3.21.0'
+          },
+          mode: ['pc'],
+          pcDemo: 'custom-style'
+        },
+        {
+          name: 'font-size',
+          type: 'string',
+          defaultValue: '14px',
+          desc: {
+            'zh-CN': '文本字体大小',
+            'en-US': 'Text font size'
+          },
+          meta: {
+            stable: '3.21.0'
+          },
           mode: ['pc'],
-          pcDemo: 'direction'
+          pcDemo: 'custom-style'
+        },
+        {
+          name: 'status',
+          type: 'string',
+          defaultValue: '',
+          desc: {
+            'zh-CN': '分割线状态',
+            'en-US': 'Splitting Line Status'
+          },
+          meta: {
+            stable: '3.21.0'
+          },
+          mode: ['pc', 'mobile-first'],
+          pcDemo: 'status',
+          mfDemo: 'status'
         }
       ],
       events: [],

package/demos/apis/dropdown.js

@@ -371,7 +371,10 @@ export default {
             'en-US': 'Menu pop-up location '
           },
           mode: ['pc'],
-          pcDemo: 'basic-usage'
+          pcDemo: 'placement',
+          meta: {
+            experimental: '3.21.0'
+          }
         },
         {
           name: 'popper-class',
@@ -551,7 +554,7 @@ type IButtonType = 'default' | 'primary' | 'success' | 'warning' | 'danger' | 'i
       name: 'IPlacementType',
       type: 'type',
       code: `        
-type IPlacementType =  'top' | 'top-start' | 'top-end' | 'bottom' | 'bottom-start' | 'bottom-end'
+type IPlacementType =  'bottom-start' | 'bottom-end'
 `
     }
   ]

package/demos/apis/file-upload.js

@@ -15,7 +15,7 @@ export default {
           },
           mode: ['pc', 'mobile', 'mobile-first'],
           pcDemo: 'accept-file-image',
-          mobileDemo: 'accept-file-image',
+          mobileDemo: 'accept-file',
           mfDemo: ''
         },
         {
@@ -71,7 +71,7 @@ export default {
           },
           mode: ['pc', 'mobile', 'mobile-first'],
           pcDemo: 'prevent-delete-file',
-          mobileDemo: 'custom-prefix',
+          mobileDemo: 'prevent-delete-file',
           mfDemo: ''
         },
         {
@@ -86,7 +86,7 @@ export default {
           },
           mode: ['pc', 'mobile', 'mobile-first'],
           pcDemo: 'before-upload-limit',
-          mobileDemo: 'custom-prefix',
+          mobileDemo: 'upload-request',
           mfDemo: ''
         },
         {
@@ -159,7 +159,7 @@ export default {
             'en-US': 'display different button'
           },
           mode: ['mobile'],
-          mobileDemo: 'manual-upload'
+          mobileDemo: ''
         },
         {
           name: 'display-only',
@@ -218,17 +218,6 @@ export default {
           mode: ['pc'],
           pcDemo: 'encrypt-config'
         },
-        {
-          name: 'ext-icons',
-          type: 'Object',
-          defaultValue: '',
-          desc: {
-            'zh-CN': '<p>设置自定义文件类型图标，根据扩展名定义，默认由组件内部提供。</p>',
-            'en-US': 'display different button'
-          },
-          mode: ['mobile'],
-          mobileDemo: 'placeholder'
-        },
         {
           name: 'file-icon-list',
           type: 'Array',
@@ -275,7 +264,7 @@ export default {
             'en-US': 'display different button'
           },
           mode: ['mobile'],
-          mobileDemo: 'file-title'
+          mobileDemo: 'header-show'
         },
         {
           name: 'header-show',
@@ -304,8 +293,8 @@ export default {
         },
         {
           name: 'http-request',
-          type: '(file: IFile) => Promise<any>',
-          typeAnchorName: 'IFile',
+          type: '(file: ICustomParam) => Promise<any>',
+          typeAnchorName: 'ICustomParam',
           defaultValue: '',
           desc: {
             'zh-CN': '覆盖默认的上传行为，可以自定义上传的实现; 由于 TinyVue 官网为 Mock 上传不能执行上传',
@@ -386,7 +375,7 @@ export default {
           },
           mode: ['pc', 'mobile', 'mobile-first'],
           pcDemo: 'max-file-count',
-          mobileDemo: 'upload-limit',
+          mobileDemo: 'max-file-count',
           mfDemo: ''
         },
         {
@@ -411,20 +400,9 @@ export default {
           },
           mode: ['pc', 'mobile', 'mobile-first'],
           pcDemo: 'upload-file-list-thumb',
-          mobileDemo: 'file-picture-card',
+          mobileDemo: 'picture-card',
           mfDemo: ''
         },
-        {
-          name: 'max_file_count',
-          type: 'Number',
-          defaultValue: 'Infinity',
-          desc: {
-            'zh-CN': '<p>设置文件上传数量的最大值，默认无限制，要大于0的正整数。</p>',
-            'en-US': 'display different button'
-          },
-          mode: ['mobile'],
-          mobileDemo: ''
-        },
         {
           name: 'max-name-length',
           type: 'number',
@@ -614,7 +592,7 @@ export default {
           },
           mode: ['pc', 'mobile', 'mobile-first'],
           pcDemo: 'upload-file-list',
-          mobileDemo: 'upload-user-head',
+          mobileDemo: 'upload-file-list',
           mfDemo: ''
         },
         {
@@ -670,7 +648,7 @@ export default {
             'en-US': 'display different button'
           },
           mode: ['mobile'],
-          mobileDemo: ''
+          mobileDemo: 'prevent-delete-file'
         },
         {
           name: 'thumb-option',
@@ -919,7 +897,7 @@ export default {
           },
           mode: ['pc', 'mobile', 'mobile-first'],
           pcDemo: 'abort-quest',
-          mobileDemo: 'event',
+          mobileDemo: 'abort-quest',
           mfDemo: ''
         },
         {
@@ -1059,6 +1037,22 @@ interface IFile {
 }
       `
     },
+    {
+      name: 'ICustomParam',
+      type: 'interface',
+      code: `
+interface ICustomParam {
+  action: string
+  data: IData // 上传时附带的额外参数
+  file: IFile
+  filename: string
+  headers: object // 头部请求信息
+  onError: (error: any) => void // 上传失败回调函数，自定义入参
+  onProgress: (event: any) => void // 上传中回调函数
+  onSuccess: (res: any) => void // 上传成功回调函数
+  withCredentials: boolean // 是否支持发送 cookie 凭证信息
+}`
+    },
     {
       name: 'IEncryptConfig',
       type: 'interface',

package/demos/apis/fluent-editor.js

@@ -5,6 +5,19 @@ export default {
       name: 'fluent-editor',
       type: 'component',
       props: [
+        {
+          name: 'before-editor-init',
+          type: '(FluentEditor) => void',
+          defaultValue: '',
+          meta: {
+            stable: '3.21.0'
+          },
+          desc: {
+            'zh-CN': 'FluentEditor 初始化之前执行的钩子，用于注册自定义 FluentEditor 模块和格式。',
+            'en-US': ''
+          },
+          pcDemo: 'before-editor-init'
+        },
         {
           name: 'data-type',
           type: 'boolean',
@@ -64,7 +77,7 @@ export default {
         {
           name: 'options',
           type: 'object',
-          defaultValue: "",
+          defaultValue: '',
           desc: {
             'zh-CN': '编辑器配置项，参考 Quill 文档：https://quilljs.com/docs/configuration#options',
             'en-US': ''
@@ -75,7 +88,7 @@ export default {
         {
           name: 'zIndex',
           type: 'number',
-          defaultValue: "",
+          defaultValue: '',
           desc: {
             'zh-CN': '编辑器的 z-index',
             'en-US': ''
@@ -105,6 +118,6 @@ interface IImageUploadOptions {
   fail: (serverError: string) => void // 上传失败回调信息
 }
       `
-    },
+    }
   ]
 }

package/demos/apis/form.js

@@ -219,10 +219,10 @@ export default {
         },
         {
           name: 'validate-on-rule-change',
-          type: 'boolean',
+          type: 'boolean | "deep"',
           defaultValue: 'true',
           desc: {
-            'zh-CN': '是否在 rules 属性改变后立即触发一次验证',
+            'zh-CN': '是否在 rules 属性改变后立即触发一次验证（"deep"选项新增于3.21.0）',
             'en-US': 'Whether to trigger a verification immediately after the rules attribute is changed'
           },
           mode: ['pc', 'mobile', 'mobile-first'],