@opentiny/vue-docs 3.26.7 → 3.27.0

package/demos/apis/base-select.js

@@ -333,6 +333,19 @@ export default {
           mode: ['pc'],
           pcDemo: 'filter-method'
         },
+        {
+          name: 'optimization',
+          type: 'boolean',
+          defaultValue: 'false',
+          desc: {
+            'zh-CN': '是否开启大数据虚拟滚动功能。仅配置式（使用 options 属性）时支持',
+            'en-US':
+              'Whether to enable the big data virtual scrolling feature. Supported only when configured (using the options attribute)'
+          },
+          mode: ['pc', 'mobile-first'],
+          pcDemo: 'optimization',
+          mfDemo: 'optimization'
+        },
         {
           name: 'options',
           typeAnchorName: 'IOption',

package/demos/apis/calendar-view.js

@@ -5,6 +5,18 @@ export default {
       name: 'calendar-view',
       type: 'component',
       props: [
+        {
+          name: 'day',
+          type: 'number',
+          defaultValue: '',
+          desc: {
+            'zh-CN': '指定日期，配合 year、month 使用',
+            'en-US': 'Specify the date, used with year and month'
+          },
+          mode: ['pc', 'mobile-first'],
+          pcDemo: 'basic-usage',
+          mfDemo: 'basic-usage'
+        },
         {
           name: 'day-times',
           type: 'Array',

package/demos/apis/color-picker.js

@@ -103,6 +103,22 @@ export default {
           meta: {
             stable: '3.19.0'
           }
+        },
+        {
+          name: 'colorMode',
+          type: 'monochrome | linear-gradient',
+          defaultValue: 'monochrome',
+          desc: {
+            'zh-CN':
+              '设定颜色模式, 如果为linear-gradient则为线性渐变. 如果为线性渐变, modelValue必须为一个合法的线性渐变表达式',
+            'en-US':
+              'Set the color mode. If it is linear-gradient, it is a linear gradient. If it is a linear gradient, modelValue must be a valid linear gradient expression'
+          },
+          mode: ['pc'],
+          pcDemo: 'color-mode',
+          meta: {
+            stable: '3.27.0'
+          }
         }
       ],
       events: [

package/demos/apis/color-select-panel.js

@@ -90,6 +90,20 @@ export default {
           meta: {
             stable: '3.19.0'
           }
+        },
+        {
+          name: 'colorMode',
+          type: "'linear-gradient' | 'monochrome'",
+          defaultValue: 'monochrome',
+          desc: {
+            'zh-CN':
+              '决定色彩选择面板的颜色模式, 如果为 <code>linear-gradient</code> 则表示是线性渐变. 如果是 <code>monochrome</code> 则表示是单色选择',
+            'en-US':
+              'Determine the color mode of the color selection panel. If it is<code>linear-gradient</code>, it means it is a linear gradient If it is<code>monochrome</code>, it means monochrome selection'
+          },
+          mode: ['pc'],
+          pcDemo: 'linear-gradient',
+          meta: { stable: '3.27.0' }
         }
       ],
       events: [

package/demos/apis/config-provider.js

@@ -51,7 +51,8 @@ export default {
             'en-US': 'Customized theme color, in {data:"tv-base-color-brand":"#595959",....} format.'
           },
           mode: ['pc'],
-          pcDemo: 'theme'
+          pcDemo: 'theme',
+          hideSaas: true // 当环境变量为tiny-vue-saas时隐藏该属性
         }
       ],
       events: [],

package/demos/apis/date-picker.js

@@ -215,6 +215,19 @@ export default {
           mode: ['pc'],
           pcDemo: 'custom-suffix-icon'
         },
+        {
+          name: 'popper-options',
+          typeAnchorName: 'IPopperOption',
+          type: 'IPopperOption',
+          defaultValue: ' { }',
+          desc: {
+            'zh-CN': '弹出层参数',
+            'en-US': 'Advanced parameters; Refer to the description of IPopperOption'
+          },
+          mode: ['pc', 'mobile-first'],
+          pcDemo: '',
+          mfDemo: ''
+        },
         {
           name: 'range-separator',
           type: 'string',
@@ -461,6 +474,30 @@ export default {
           mode: ['pc', 'mobile-first'],
           pcDemo: 'now',
           mfDemo: 'now'
+        },
+        {
+          name: 'footer',
+          type: 'scoped',
+          meta: { stable: '3.27.0' },
+          defaultValue: '',
+          desc: {
+            'zh-CN': '底部区域作用域插槽。',
+            'en-US': 'Scoped slot for footer area.'
+          },
+          mode: ['pc'],
+          pcDemo: 'slot'
+        },
+        {
+          name: 'confirm',
+          type: 'scoped',
+          meta: { stable: '3.27.0' },
+          defaultValue: '',
+          desc: {
+            'zh-CN': '仅覆盖“确认”按钮区域',
+            'en-US': 'Customize only the "confirm" button area'
+          },
+          mode: ['pc'],
+          pcDemo: 'slot'
         }
       ],
       format: [
@@ -642,6 +679,21 @@ interface IPickerOptions {
       code: `
 type IType = 'date' | 'dates' | 'daterange' | 'datetime' | 'datetimerange' | 'week' | 'month' | 'monthrange' | 'quarter' | 'year' | 'years' | 'yearrange'
       `
+    },
+    {
+      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
+}
+      `
     }
   ]
 }

package/demos/apis/dialog-box.js

@@ -289,19 +289,31 @@ export default {
           },
           mode: ['pc'],
           pcDemo: 'transition-effect'
+        },
+        {
+          name: 'before-close',
+          type: '(type) => boolean',
+          defaultValue: '',
+          desc: {
+            'zh-CN': '设置弹窗关闭前的回调函数，如果函数返回 `false`,可以拦截关闭弹窗',
+            'en-US':
+              'set the callback function before closing the pop-up. If the function returns `false`, the pop-up will not be closed'
+          },
+          mode: ['pc'],
+          pcDemo: 'before-close'
         }
       ],
       events: [
         {
           name: 'before-close',
-          type: '(arg:() => void) => void',
+          type: '(event, hideFn) => void',
           defaultValue: '',
           desc: {
-            'zh-CN': 'Dialog 关闭弹窗前，执行的事件',
-            'en-US': 'Event executed before a dialog window is closed.'
+            'zh-CN': 'Dialog 关闭弹窗前的事件，通过 event.preventDefault() 可以拦截关闭弹窗',
+            'en-US': 'Dialog event before closing the pop-up'
           },
           mode: ['pc'],
-          pcDemo: 'draggable'
+          pcDemo: 'before-close'
         },
         {
           name: 'close',

package/demos/apis/drawer.js

@@ -194,6 +194,19 @@ export default {
           },
           mode: ['pc'],
           pcDemo: 'z-index'
+        },
+        {
+          name: 'tips-props',
+          type: 'ITipsProps',
+          typeAnchorName: 'ITipsProps',
+          defaultValue: '',
+          desc: {
+            'zh-CN': '可自定义标题帮助提示信息',
+            'en-US': 'Customizable title help prompt information'
+          },
+          mode: ['pc'],
+          pcDemo: 'tips-props',
+          hideSaas: true
         }
       ],
       events: [
@@ -326,6 +339,15 @@ export default {
     }
   ],
   types: [
+    {
+      name: 'ITipsProps',
+      type: 'interface',
+      code: `interface ITipsProps {
+        content?: string
+        placement?: string
+        effect?: string
+      }`
+    },
     {
       name: 'IDrawerConfigs',
       type: 'interface',

package/demos/apis/exception.js

@@ -1,5 +1,5 @@
 export default {
-  mode: ['mobile-first'],
+  mode: ['pc', 'mobile-first'],
   apis: [
     {
       name: 'Exception',
@@ -10,11 +10,12 @@ export default {
           type: 'boolean',
           defaultValue: '',
           desc: {
-            'zh-CN': '设置组件级空态',
-            'en-US': 'Set component-level empty state'
+            'zh-CN': '设置组件级异常',
+            'en-US': 'Set component-level exception'
           },
-          mode: ['mobile-first'],
-          mfDemo: 'component-empty'
+          mode: ['pc', 'mobile-first'],
+          mfDemo: 'component-page',
+          pcDemo: 'component-page'
         },
         {
           name: 'exception-class',
@@ -24,19 +25,21 @@ export default {
             'zh-CN': '设置自定义类',
             'en-US': 'Setting Custom Classes'
           },
-          mode: ['mobile-first'],
-          mfDemo: ''
+          mode: ['pc', 'mobile-first'],
+          mfDemo: 'exception-class',
+          pcDemo: 'exception-class'
         },
         {
           name: 'page-empty',
           type: 'boolean',
           defaultValue: '',
           desc: {
-            'zh-CN': '设置页面级空态',
-            'en-US': ''
+            'zh-CN': '设置页面级异常',
+            'en-US': 'Set page-level exception'
           },
-          mode: ['mobile-first'],
-          mfDemo: ''
+          mode: ['pc', 'mobile-first'],
+          mfDemo: 'page-empty',
+          pcDemo: 'page-empty'
         },
         {
           name: 'sub-message',
@@ -46,20 +49,22 @@ export default {
             'zh-CN': '设置二级标题',
             'en-US': 'Set Level-2 Title'
           },
-          mode: ['mobile-first'],
-          mfDemo: 'sub-message'
+          mode: ['pc', 'mobile-first'],
+          mfDemo: 'sub-message',
+          pcDemo: 'sub-message'
         },
         {
           name: 'type',
-          type: 'string',
+          typeAnchorName: 'IType',
+          type: 'IType',
           defaultValue: 'nodata',
           desc: {
-            'zh-CN':
-              '<p>设置缺省页类型，默认为nodata,可选值有 weaknet || noperm || busy || build || weaknet || pcview</p>',
-            'en-US': 'display different button'
+            'zh-CN': '<p>设置缺省页类型，默认为nodata</p>',
+            'en-US': '<p>Set exception type, The default value is nodata</p>'
           },
-          mode: ['mobile-first'],
-          mfDemo: 'page-empty'
+          mode: ['pc', 'mobile-first'],
+          mfDemo: 'page-empty',
+          pcDemo: 'page-empty'
         }
       ],
       events: [],
@@ -71,23 +76,34 @@ export default {
           defaultValue: '',
           desc: {
             'zh-CN': '<p>设置内容</p>',
-            'en-US': 'Click'
+            'en-US': '<p>Set content</p>'
           },
-          mode: ['mobile-first'],
-          mfDemo: 'content-slot'
+          mode: ['pc', 'mobile-first'],
+          mfDemo: 'slot',
+          pcDemo: 'slot'
         },
         {
-          name: 'default',
+          name: 'icon',
           type: '',
           defaultValue: '',
           desc: {
-            'zh-CN': '默认插槽',
-            'en-US': 'Default Slot'
+            'zh-CN': '图标插槽',
+            'en-US': 'Icon Slot'
           },
-          mode: ['mobile-first'],
-          mfDemo: ''
+          mode: ['pc', 'mobile-first'],
+          mfDemo: 'slot',
+          pcDemo: 'slot'
         }
       ]
     }
+  ],
+  types: [
+    {
+      name: 'IType',
+      type: 'type',
+      code: `
+type IType = 'noperm' | 'nodata' | 'weaknet' | 'noresult' | 'nonews' | 'pagenoperm' | 'pageweaknet' | 'pagenothing' | 'pageservererror'
+`
+    }
   ]
 }

package/demos/apis/grid.js

@@ -159,6 +159,19 @@ export default {
           mode: ['pc', 'mobile-first'],
           pcDemo: 'grid-faq#custom-column'
         },
+        {
+          name: 'customs',
+          typeAnchorName: 'ICustomConfig',
+          type: 'ICustomConfig[]',
+          defaultValue: '',
+          desc: {
+            'zh-CN': '表格的初始化个性配置，可以控制表格列是否隐藏，设置列宽。优先级高于grid-column上的配置。',
+            'en-US':
+              'Initialize the table personalized configuration to control whether the table columns are hidden and set the column width. It takes precedence over the configuration on grid-column.'
+          },
+          mode: ['pc', 'mobile-first'],
+          pcDemo: 'grid-faq#custom-column'
+        },
         {
           name: 'data',
           typeAnchorName: 'IRow',
@@ -1986,8 +1999,13 @@ export default {
           type: '() => IRow[]',
           defaultValue: '',
           desc: {
-            'zh-CN':
-              '获取当前表格的数据（完整的全量表体数据、处理条件之后的全量表体数据、当前渲染中的表体数据、当前渲染中的表尾数据）',
+            'zh-CN': `
+            获取当前表格的数据（完整的全量表体数据、处理条件之后的全量表体数据、当前渲染中的表体数据、当前渲染中的表尾数据） <br/>
+            footerData: 表尾数据。 <br/>
+            fullData: 表格全量数据。  <br/>
+            visibleData: 经过筛选处理后，表格可视数据。 <br/>
+            tableData: 经过虚拟滚动剪切处理和筛选处理，表格实际用于渲染的数据。<br/>
+            `,
             'en-US':
               'Get the data of the current table (complete full body data, full body data after processing conditions, currently rendered body data, currently rendered footer data)'
           },
@@ -3429,7 +3447,9 @@ interface IKeyboardConfig {
       code: `
 interface IMouseConfig {
   // 是否开启左键选中单元格功能（只对 editConfig.mode=cell 有效），默认为 false
-  selected: boolean 
+  selected: boolean
+  // 悬浮是否显示对齐辅助线(3.27.0新增)
+  hover: boolean
 }
       `
     },
@@ -3514,6 +3534,8 @@ interface ITreeConfig {
 interface IValidConfig {
   // 校验提示类型，'inline'(内置提示)；'tooltip'(tooltip文字提示)
   message?: 'inline' | 'tooltip'
+  // 是否高亮已经校验过错误的单元格 (3.27.0新增)
+  highlightError?: boolean
 }
       `
     },
@@ -4212,6 +4234,19 @@ interface ICellClassNameArgs {
   // 单元格所在行的序号
   seq: number
   $seq: string // 已弃用
+}`
+    },
+    {
+      name: 'ICustomConfig',
+      type: 'type',
+      code: `
+interface ICustomConfig {
+  // 表格列字段
+  property: string
+  // 是否显示
+  visible?: boolean
+  // 列宽
+  width?: number | string
 }`
     }
   ]

package/demos/apis/guide.js

@@ -138,6 +138,20 @@ export default {
           },
           mode: ['pc'],
           pcDemo: 'size'
+        },
+        {
+          name: 'mask',
+          type: 'boolean',
+          defaultValue: 'false',
+          desc: {
+            'zh-CN': '是否显示遮罩层',
+            'en-US': ''
+          },
+          mode: ['pc'],
+          pcDemo: 'mask',
+          meta: {
+            stable: '3.27.0'
+          }
         }
       ],
       events: [],

package/demos/apis/pager.js

@@ -98,7 +98,7 @@ export default {
           defaultValue: "'total, prev, pager, next, jumper'",
           desc: {
             'zh-CN':
-              '组件布局，子组件名用英文逗号分隔，子组件类型有 sizes、 prev、 pager、 next、 jumper、 current、 total、 slot',
+              '组件布局，子组件名用英文逗号分隔，子组件类型有 sizes、 prev、 pager、simplest-pager、 next、 jumper、 current、 total、 slot',
             'en-US':
               'Component layout, with sub component names separated by commas; The optional values for this attribute are sizes, preview, pager, next, jumper, current, total, slot.'
           },
@@ -110,8 +110,8 @@ export default {
           type: "'number' | 'simple' | 'complete' | 'fixed' | 'simplest'",
           defaultValue: '',
           desc: {
-            'zh-CN': '设置分页组件显示模式，此属性优先级大于 layout, 3.19.0新增simplest',
-            'en-US': 'Set the display mode of pagination components, which takes priority over layout'
+            'zh-CN': '设置分页组件显示模式, 3.19.0新增simplest',
+            'en-US': 'Set the display mode of pagination components'
           },
           mode: ['pc'],
           pcDemo: 'pager-mode'