@opentinyvue/vue-docs 3.28.3 → 3.29.0

package/demos/apis/drawer.js

@@ -236,6 +236,21 @@ export default {
           pcDemo: 'events',
           mfDemo: ''
         },
+        {
+          name: 'closed',
+          type: '() => void',
+          defaultValue: '',
+          desc: {
+            'zh-CN': '关闭抽屉动画结束时的事件',
+            'en-US': 'Event emitted when drawer closing animation ends'
+          },
+          mode: ['pc', 'mobile-first'],
+          pcDemo: 'events',
+          mfDemo: '',
+          meta: {
+            stable: '3.29.0'
+          }
+        },
         {
           name: 'confirm',
           type: '() => void',
@@ -371,6 +386,7 @@ interface IDrawerConfigs extends IDrawerProps {
   events: {
     // 监听事件
     close: () => void
+    closed: () => void
     confirm: () => void
     show: (instance: Component) => void
   },

package/demos/apis/dropdown.js

@@ -498,7 +498,40 @@ export default {
             'en-US': 'Sets the level-2 drop-down menu flag.'
           },
           mode: ['mobile-first']
-        }
+        },
+        {
+          name: 'tip',
+          type: 'string | Function',
+          defaultValue: '',
+          desc: {
+            'zh-CN': '提示信息内容，支持字符串或函数。函数接收参数 { itemData, vm }',
+            'en-US': 'Tooltip content, supports string or function. Function receives parameters { itemData, vm }'
+          },
+          mode: ['pc'],
+          pcDemo: 'tip'
+        },
+        {
+          name: 'tip-position',
+          type: 'string',
+          defaultValue: "'right'",
+          desc: {
+            'zh-CN': '提示信息的位置，可选值：top / right / bottom / left',
+            'en-US': 'Position of tooltip, optional values: top / right / bottom / left'
+          },
+          mode: ['pc'],
+          pcDemo: 'tip'
+        },
+        {
+          name: 'tip-effect',
+          type: 'string',
+          defaultValue: "'light'",
+          desc: {
+            'zh-CN': '提示信息的主题，可选值：light（浅色）/ dark（深色）',
+            'en-US': 'Theme of tooltip, optional values: light / dark'
+          },
+          mode: ['pc'],
+          pcDemo: 'tip'
+        },
       ],
       events: [],
       methods: [],
@@ -555,6 +588,11 @@ interface IItemData {
   label?: string
   disabled?: boolean
   divided?: boolean
+  tip?: string | ((params: { itemData: IItemData, vm: any }) => string)
+  tipPosition?: 'top' | 'right' | 'bottom' | 'left'
+  tipEffect?: 'light' | 'dark'
+  children?: IItemData[]
+  icon?: Component
 }
 `
     },

package/demos/apis/filter-panel.js

@@ -17,7 +17,15 @@ export default {
           pcDemo: 'tip'
         },
         {
-          mode: []
+          name: 'clearable',
+          type: 'boolean',
+          defaultValue: 'true',
+          desc: {
+            'zh-CN': '是否显示清空按钮',
+            'en-US': 'Whether to display the clear button'
+          },
+          mode: ['pc'],
+          pcDemo: 'tip'
         },
         {
           name: 'disabled',
@@ -76,6 +84,18 @@ export default {
           mode: ['pc'],
           pcDemo: 'popper-class'
         },
+        {
+          name: 'size',
+          type: "'medium'",
+          defaultValue: '',
+          desc: {
+            'zh-CN': '过滤器面板的尺寸，可选值：medium（中等尺寸），不设置则为默认尺寸',
+            'en-US': 'Size of the filter panel. Optional value: medium. If not set, the default size is used'
+          },
+          stable: '3.29.0',
+          mode: ['pc'],
+          pcDemo: 'size'
+        },
         {
           name: 'tip',
           type: 'string',

package/demos/apis/form.js

@@ -580,6 +580,17 @@ export default {
           mode: ['pc'],
           pcDemo: 'slot-label'
         },
+        {
+          name: 'label-line',
+          defaultValue: 2,
+          type: 'number',
+          desc: {
+            'zh-CN': '标签文本显示的行数',
+            'en-US': 'The number of lines displayed in the label text'
+          },
+          mode: ['mobile-first'],
+          pcDemo: 'slot-label'
+        },
         {
           name: 'error',
           defaultValue: '',

package/demos/apis/grid.js

@@ -30,6 +30,23 @@ export default {
           pcDemo: 'grid-data-source#data-source-auto-load',
           mfDemo: ''
         },
+        {
+          name: 'filter-popper-options',
+          typeAnchorName: 'IPopperOption',
+          type: 'IPopperOption',
+          defaultValue: '{}',
+          desc: {
+            'zh-CN': '过滤面板弹出层配置项；具体参考 IPopperOption 的描述',
+            'en-US':
+              'Configuration item for the filter panel pop-up layer; refer to the description of IPopperOption for details'
+          },
+          meta: {
+            stable: '3.29.0'
+          },
+          mode: ['pc'],
+          pcDemo: 'grid-filter#filter-default-filter',
+          mfDemo: ''
+        },
         {
           name: 'auto-resize',
           type: 'boolean',
@@ -3217,6 +3234,21 @@ export default {
     }
   ],
   types: [
+    {
+      name: 'IPopperOption',
+      type: 'interface',
+      code: `
+    interface IPopperOption {
+      bubbling: boolean // 是否监听元素所有上级有滚动元素的scroll事件，监听到则更新popper的位置。用于解决某些弹出层位置在页面滚动时，位置不正确的场景，默认false
+      followReferenceHide: boolean // 当触发源隐藏时，自动隐藏弹出层，默认true
+      removeOnDestroy: boolean // 弹出层消失后，是否移除弹出层的DOM元素，布尔false
+      updateHiddenPopperOnScroll: boolean  // 滚动过程中是否更新隐藏的弹出层位置
+      boundariesElement: 'viewport' | 'body' | HTMLElement // 滚动过程中,弹出层的碰撞边界。 默认值为： 'viewport'
+      ignoreBoundaries: boolean  // 忽略边界判断，弹出的位置始终是设置的 placement 值
+      scrollParent:  HTMLElement  // 指定滚动的父节点，优化级最高。 默认为null
+    }
+          `
+    },
     {
       name: 'IRow',
       type: 'interface',

package/demos/apis/guide.js

@@ -152,6 +152,20 @@ export default {
           meta: {
             stable: '3.27.0'
           }
+        },
+        {
+          name: 'show-close',
+          type: 'boolean',
+          defaultValue: 'true',
+          desc: {
+            'zh-CN': '是否显示关闭按钮',
+            'en-US': ''
+          },
+          mode: ['pc'],
+          pcDemo: 'show-close',
+          meta: {
+            stable: '3.29.0'
+          }
         }
       ],
       events: [],

package/demos/apis/message.js

@@ -1,5 +1,5 @@
 export default {
-  mode: ['mobile-first'],
+  mode: ['mobile-first', 'pc'],
   apis: [
     {
       name: 'message',
@@ -7,63 +7,89 @@ export default {
       props: [
         {
           name: 'duration',
-          type: 'String',
-          defaultValue: '',
+          type: 'string',
+          defaultValue: '3000',
           desc: {
             'zh-CN': '设置提示信息停留时间',
-            'en-US': ''
+            'en-US': 'Set the prompt information retention time'
           },
-          mode: ['mobile-first'],
-          mfDemo: ''
+          mode: ['mobile-first', 'pc'],
+          mfDemo: '',
+          pcDemo: 'message-duration'
         },
         {
           name: 'id',
-          type: 'String',
+          type: 'string',
           defaultValue: '',
           desc: {
             'zh-CN': '设置唯一的 id 防止重复提示，只对 type=message 有效',
-            'en-US': ''
+            'en-US': 'Set a unique id to prevent duplicate prompts, only valid for type=message'
           },
-          mode: ['mobile-first'],
-          mfDemo: ''
+          mode: ['mobile-first', 'pc'],
+          mfDemo: '',
+          pcDemo: 'prevent-duplicate'
         },
         {
           name: 'message',
-          type: 'String',
+          type: 'string',
           defaultValue: '',
           desc: {
             'zh-CN': '设置提示信息',
-            'en-US': ''
+            'en-US': 'Set the prompt information'
           },
-          mode: ['mobile-first'],
-          mfDemo: ''
+          mode: ['mobile-first', 'pc'],
+          mfDemo: '',
+          pcDemo: 'basic-usage'
         },
         {
           name: 'show-close',
-          type: 'String',
+          type: 'string',
           defaultValue: '',
           desc: {
             'zh-CN': '控制弹窗是否显示关闭图标',
-            'en-US': ''
+            'en-US': 'Whether to display the close icon'
           },
           mode: ['mobile-first'],
           mfDemo: ''
         },
+        {
+          name: 'message-closable',
+          type: 'boolean',
+          defaultValue: 'false',
+          desc: {
+            'zh-CN': '是否显示关闭按钮，默认值为 false',
+            'en-US': 'close button is displayed or not, the default value is false'
+          },
+          mode: ['pc'],
+          mfDemo: '',
+          pcDemo: 'message-close'
+        },
         {
           name: 'status',
-          type: 'String',
-          defaultValue: '',
+          typeAnchorName: 'IStatus',
+          type: 'IStatus',
+          defaultValue: "'info'",
           desc: {
-            'zh-CN': '设置消息状态，可选值有 info | success | warning | error',
-            'en-US': ''
+            'zh-CN': '设置消息状态',
+            'en-US': 'Set the message status'
           },
-          mode: ['mobile-first'],
-          mfDemo: ''
+          mode: ['mobile-first', 'pc'],
+          mfDemo: '',
+          pcDemo: 'basic-usage'
         }
       ],
       events: [],
       methods: [],
       slots: []
     }
+  ],
+  types: [
+    {
+      name: 'IStatus',
+      type: 'type',
+      code: `
+          type IStatus = 'info' | 'success' | 'warning' | 'error' | 'loading'
+      `
+    }
   ]
 }

package/demos/apis/modal.js

@@ -93,8 +93,9 @@ export default {
           type: 'number | string',
           defaultValue: '3000',
           desc: {
-            'zh-CN': "自动关闭的延时，仅当 type 为 'message' 有效",
-            'en-US': "Delay for automatic shutdown, only valid when type is 'message'"
+            'zh-CN': "自动关闭的延时，仅当 type 为 'message' 有效，如果设置为0则窗口不会自动关闭",
+            'en-US':
+              "Delay for automatic shutdown, only valid when type is 'message', If set to 0, the popup will not close automatically"
           },
           mode: ['pc', 'mobile-first'],
           pcDemo: 'message-close',

package/demos/apis/rate.js

@@ -282,6 +282,21 @@ export default {
           mode: ['pc', 'mobile-first'],
           pcDemo: 'not-selected-class',
           mfDemo: ''
+        },
+        {
+          name: 'clearable',
+          type: 'boolean',
+          defaultValue: 'false',
+          desc: {
+            'zh-CN': '是否可清空',
+            'en-US': 'Whether to clear'
+          },
+          mode: ['pc', 'mobile-first'],
+          pcDemo: 'clearable',
+          mfDemo: '',
+          meta: {
+            stable: '3.29.0'
+          }
         }
       ],
       events: [