@opentiny/vue-docs 3.22.3 → 3.23.1

package/demos/apis/anchor.js

@@ -56,6 +56,21 @@ export default {
           pcDemo: 'set-container',
           mfDemo: 'set-container'
         },
+        // 添加offset-top属性文档
+        {
+          name: 'offset-top',
+          type: 'number',
+          defaultValue: '0',
+          desc: {
+            'zh-CN': '锚点距离顶部的偏移量，用于调整滚动定位的位置',
+            'en-US': 'Offset from the top of the anchor, used to adjust the scroll position'
+          },
+          meta: {
+            stable: '3.19.0'
+          },
+          mode: ['pc'],
+          pcDemo: 'offset-top'
+        },
         {
           name: 'type',
           type: "'line' | 'dot'",

package/demos/apis/calendar-view.js

@@ -149,6 +149,20 @@ export default {
           pcDemo: 'basic-usage',
           mfDemo: 'basic-usage'
         },
+        {
+          name: 'show-tip-time',
+          type: 'Boolean',
+          defaultValue: 'true',
+          desc: {
+            'zh-CN': '显示日程tips时间',
+            'en-US': 'Show schedule tips time'
+          },
+          meta: {
+            stable: '3.23.0'
+          },
+          mode: ['pc', 'mobile-first'],
+          mfDemo: ''
+        },
         {
           name: 'v-model',
           type: 'String',
@@ -238,6 +252,19 @@ export default {
           pcDemo: 'multi-select',
           mfDemo: 'multi-select'
         },
+        {
+          name: 'date-click',
+          desc: {
+            'zh-CN': '日期点击事件，回调参数为当前点击日期和日程事件',
+            'en-US': 'Date click event, The callback parameters are the current click date and schedule event'
+          },
+          mode: ['pc', 'mobile-first'],
+          pcDemo: 'calendar-event',
+          mfDemo: 'calendar-event',
+          meta: {
+            stable: '3.23.0'
+          }
+        },
         {
           name: 'week-change',
           desc: {

package/demos/apis/config-provider.js

@@ -38,6 +38,20 @@ export default {
           },
           mode: ['pc'],
           pcDemo: 'tag'
+        },
+        {
+          name: 'theme',
+          type: 'object',
+          defaultValue: '--',
+          meta: {
+            stable: '3.23.0'
+          },
+          desc: {
+            'zh-CN': '自定义主题色,格式：{data:{"tv-base-color-brand":"#595959",....}}',
+            'en-US': 'Customized theme color, in {data:"tv-base-color-brand":"#595959",....} format.'
+          },
+          mode: ['pc'],
+          pcDemo: 'theme'
         }
       ],
       events: [],

package/demos/apis/float-button.js

@@ -3,200 +3,200 @@ export default {
 
   apis: [
     {
-      'name': 'float-button',
-      'type': 'component',
+      name: 'float-button',
+      type: 'component',
       'props': [
         {
-          'name': 'type',
-          'type': 'IFloatButtonType',
-          'defaultValue': '--',
-          'desc': {
+          name: 'type',
+          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',
-          'type': 'string',
-          'defaultValue': '--',
-          'desc': {
+          name: 'description',
+          type: 'string',
+          defaultValue: '--',
+          desc: {
             'zh-CN': '按钮显示的文本',
             'en-US': 'Set the text displayed by the button'
           },
           mode: ['pc'],
-          'pcDemo': 'basic-usage'
+          pcDemo: 'basic-usage'
         },
         {
-          'name': 'icon',
-          'type': 'Component',
-          'defaultValue': '--',
-          'desc': {
+          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'
+          pcDemo: 'icon'
         },
         {
-          'name': 'reset-time',
-          'type': 'number',
-          'defaultValue': '1000',
-          'desc': {
+          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'
+          pcDemo: 'reset-time'
         },
         {
-          'name': 'trigger',
-          'type': 'string',
-          'defaultValue': 'click',
-          'desc': {
+          name: 'trigger',
+          type: 'string',
+          defaultValue: 'click',
+          desc: {
             'zh-CN': '设置菜单触发模式。',
             'en-US': 'Set the menu trigger mode.'
           },
           mode: ['pc'],
-          'pcDemo': 'trigger'
+          pcDemo: 'trigger'
         },
         {
-          'name': 'open',
-          'type': 'boolean',
-          'defaultValue': false,
-          'desc': {
+          name: 'open',
+          type: 'boolean',
+          defaultValue: false,
+          desc: {
             'zh-CN': '设置菜单是否打开。',
             'en-US': 'Whether the settings menu opens.'
           },
           mode: ['pc'],
-          'pcDemo': 'trigger'
+          pcDemo: 'trigger'
         },
         {
-          'name': 'shape',
-          'type': "'circle'|'square'",
-          'defaultValue': 'circle',
-          'desc': {
+          name: 'shape',
+          type: "'circle'|'square'",
+          defaultValue: 'circle',
+          desc: {
             'zh-CN': '设置按钮形状。',
             'en-US': 'Set Button shape.'
           },
           mode: ['pc'],
-          'pcDemo': 'basic-usage'
+          pcDemo: 'basic-usage'
         },
         {
-          'name': 'backTop',
-          'type': 'boolean',
-          'defaultValue': false,
-          'desc': {
+          name: 'backTop',
+          type: 'boolean',
+          defaultValue: false,
+          desc: {
             'zh-CN': '设置是否是回到顶部按钮。',
             'en-US': 'Set whether it is a back-to-top button.'
           },
           mode: ['pc'],
-          'pcDemo': 'backTop'
+          pcDemo: 'backTop'
         },
 
         {
-          'name': 'element',
-          'type': 'HTMLElement',
-          'defaultValue': 'document.body',
-          'desc': {
+          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'
+          pcDemo: 'backTop'
         },
         {
-          'name': 'top',
-          'type': 'string',
-          'defaultValue': '',
-          'desc': {
+          name: 'top',
+          type: 'string',
+          defaultValue: '',
+          desc: {
             'zh-CN': '按钮与顶部的距离。',
             'en-US': 'The distance of the button from the top.'
           },
           mode: ['pc'],
-          'pcDemo': 'basic-usage'
+          pcDemo: 'basic-usage'
         },
         {
-          'name': 'bottom',
-          'type': 'string',
-          'defaultValue': '20px',
-          'desc': {
+          name: 'bottom',
+          type: 'string',
+          defaultValue: '20px',
+          desc: {
             'zh-CN': '按钮与底部的距离。',
             'en-US': 'The distance of the button from the bottom.'
           },
           mode: ['pc'],
-          'pcDemo': 'basic-usage'
+          pcDemo: 'basic-usage'
         },
         {
-          'name': 'left',
-          'type': 'string',
-          'defaultValue': '',
-          'desc': {
+          name: 'left',
+          type: 'string',
+          defaultValue: '',
+          desc: {
             'zh-CN': '按钮与左边的距离。',
             'en-US': 'The distance of the button from the left.'
           },
           mode: ['pc'],
-          'pcDemo': 'basic-usage'
+          pcDemo: 'basic-usage'
         },
         {
-          'name': 'right',
-          'type': 'string',
-          'defaultValue': '20px',
-          'desc': {
+          name: 'right',
+          type: 'string',
+          defaultValue: '20px',
+          desc: {
             'zh-CN': '按钮与右边的距离。',
             'en-US': 'The distance of the button from the right.'
           },
           mode: ['pc'],
-          'pcDemo': 'basic-usage'
+          pcDemo: 'basic-usage'
         },
         {
-          'name': 'href',
-          'type': 'string',
-          'defaultValue': '',
-          'desc': {
+          name: 'href',
+          type: 'string',
+          defaultValue: '',
+          desc: {
             'zh-CN': '按钮点击后跳转的页面。',
             'en-US': 'button to jump to the page.'
           },
           mode: ['pc'],
-          'pcDemo': 'jump'
+          pcDemo: 'jump'
         },
         {
-          'name': 'target',
-          'type': 'string',
-          'defaultValue': '',
-          'desc': {
+          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'
+          pcDemo: 'jump'
         }
       ],
       'events': [
         {
-          'name': 'click',
-          'type': '(event: PointEvent) => void',
-          'defaultValue': '--',
-          'desc': {
+          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'
+          pcDemo: 'click'
         }
       ],
       'slots': [
         {
-          'name': 'default',
-          'type': '',
-          'defaultValue': '--',
-          'desc': {
+          name: 'default',
+          type: '',
+          defaultValue: '--',
+          desc: {
             'zh-CN': '默认插槽，自定义按钮展开时的内容',
             'en-US': 'Default slot, customize what the button is when expanded'
           },
           mode: ['pc'],
-          'pcDemo': 'open'
+          pcDemo: 'open'
         }
       ]
     }

package/demos/apis/grid.js

@@ -3544,6 +3544,9 @@ interface IDropConfig {
   filter?: string
   // 如果变动了树层级，可以指定是否需要刷新数据
   refresh?: boolean
+  // 配置 filter 时，设置为 false 可以允许输入框正常聚焦
+  preventOnFilter?: boolean
+  // 更多其余参数请参考 sortablejs 插件配置
   }
       `
     },
@@ -4096,8 +4099,9 @@ interface IExportCsvOptions {
 interface IEditorConfig {
   // 内置组件名称或者自定义组件实例
   component: 'input' | 'select' | Component
-  // 传递给组件的事件集合
+  // 传递给组件的事件集合(v3.23.0开始支持)
   events?: {
+    // change、click等
     [event]: () => void
   }
   // 传递给编辑器组件的属性集合

package/demos/apis/number-animation.js

@@ -0,0 +1,104 @@
+export default {
+  mode: ['pc'],
+  apis: [
+    {
+      name: 'number-animation',
+      type: 'component',
+      props: [
+        {
+          name: 'active',
+          type: 'boolean',
+          defaultValue: 'true',
+          desc: {
+            'zh-CN': '是否开始动画',
+            'en-US': 'Whether or not start animation'
+          },
+          mode: ['pc'],
+          pcDemo: 'basic-usage'
+        },
+        {
+          name: 'duration',
+          type: 'number',
+          defaultValue: '3000',
+          desc: {
+            'zh-CN': '动画持续时间',
+            'en-US': 'Animation duration'
+          },
+          mode: ['pc'],
+          pcDemo: 'basic-usage'
+        },
+        {
+          name: 'from',
+          type: 'number',
+          defaultValue: '0',
+          desc: {
+            'zh-CN': '数值动画起始值',
+            'en-US': 'Starting value of numerical animation'
+          },
+          mode: ['pc'],
+          pcDemo: 'basic-usage'
+        },
+        {
+          name: 'to',
+          type: 'number',
+          defaultValue: '',
+          desc: {
+            'zh-CN': '目标值',
+            'en-US': 'Target value'
+          },
+          mode: ['pc'],
+          pcDemo: 'basic-usage'
+        },
+        {
+          name: 'precision',
+          type: 'number',
+          defaultValue: '0',
+          desc: {
+            'zh-CN': '精度，保留小数点后几位',
+            'en-US': 'Precision, rounded to a few decimal places.'
+          },
+          mode: ['pc'],
+          pcDemo: 'precision'
+        },
+        {
+          name: 'separator',
+          type: 'string',
+          defaultValue: ',',
+          desc: {
+            'zh-CN': '千分位分隔符',
+            'en-US': 'Thousandth separator'
+          },
+          mode: ['pc'],
+          pcDemo: 'separator'
+        }
+      ],
+      events: [
+        {
+          name: 'finish',
+          type: '() => void',
+          defaultValue: '',
+          desc: {
+            'zh-CN': '动画结束后的回调',
+            'en-US': 'The callback after the animation ends.'
+          },
+          mode: ['pc'],
+          pcDemo: 'finish-events'
+        }
+      ],
+      methods: [
+        {
+          name: 'play',
+          type: '() => void',
+          defaultValue: '',
+          desc: {
+            'zh-CN': '播放动画',
+            'en-US': 'Play Animation'
+          },
+          mode: ['pc'],
+          pcDemo: 'finish-events'
+        }
+      ],
+      slots: []
+    }
+  ]
+}

package/demos/apis/popconfirm.js

@@ -162,12 +162,27 @@ export default {
           defaultValue: '',
           desc: {
             'zh-CN': '底部插槽',
-            'en-US': 'default slot'
+            'en-US': 'footer slot'
           },
           mode: ['pc', 'mobile-first'],
           pcDemo: 'slot-footer',
           mfDemo: ''
         },
+        {
+          name: 'message',
+          type: '',
+          defaultValue: '',
+          meta: {
+            stable: '3.22.2'
+          },
+          desc: {
+            'zh-CN': '信息插槽',
+            'en-US': 'message slot'
+          },
+          mode: ['pc', 'mobile-first'],
+          pcDemo: 'slot-message',
+          mfDemo: ''
+        },
         {
           name: 'reference',
           type: '',

package/demos/apis/popeditor.js

@@ -444,6 +444,36 @@ export default {
       ],
       methods: [],
       slots: [
+        {
+          name: 'title-selection',
+          defaultValue: '',
+          desc: {
+            'zh-CN': '已选择数据标题插槽',
+            'en-US': ''
+          },
+          mode: ['pc'],
+          pcDemo: ''
+        },
+        {
+          name: 'title-history',
+          defaultValue: '',
+          desc: {
+            'zh-CN': '历史数据标题插槽',
+            'en-US': ''
+          },
+          mode: ['pc'],
+          pcDemo: ''
+        },
+        {
+          name: 'title-source',
+          defaultValue: '',
+          desc: {
+            'zh-CN': '所有数据标题插槽',
+            'en-US': ''
+          },
+          mode: ['pc'],
+          pcDemo: ''
+        },
         {
           name: 'footer',
           defaultValue: '',

package/demos/apis/steps.js

@@ -31,7 +31,7 @@ export default {
         },
         {
           name: 'content-center',
-          type: 'string',
+          type: 'boolean',
           defaultValue: 'false',
           desc: {
             'zh-CN': '使步骤条内容默认居中显示',

package/demos/apis/tabs.js

@@ -138,6 +138,17 @@ export default {
           pcDemo: 'size',
           mfDemo: ''
         },
+        {
+          name: 'swipeable',
+          type: 'boolean',
+          defaultValue: 'false',
+          desc: {
+            'zh-CN': '是否开启滑动内容切换标签页',
+            'en-US': 'Do you want to enable the sliding content switching tab function'
+          },
+          mode: ['mobile-first'],
+          mfDemo: 'swipeable'
+        },
         {
           name: 'stretch',
           type: 'boolean',

package/demos/apis/tag.js

@@ -100,7 +100,7 @@ export default {
             'zh-CN': '是否有边框',
             'en-US': 'Whether there is a border stroke'
           },
-          mode: ['pc', 'mobile-first'],
+          mode: ['mobile-first'],
           pcDemo: 'color3',
           mfDemo: ''
         },

package/demos/apis/transfer.js

@@ -287,6 +287,51 @@ export default {
           },
           mode: ['pc'],
           pcDemo: 'basic-usage'
+        },
+        {
+          name: 'panel-style',
+          type: 'Object',
+          defaultValue: '',
+          desc: {
+            'zh-CN': '指定左右面板容器的样式,当面板的宽度大于外部容器的50%宽度时，面板会自适应容器的宽度。',
+            'en-US':
+              "Specify the style of the left and right panel containers. When the width of the panel is greater than 50% of the external container's width, the panel will adapt to the width of the container"
+          },
+          mode: ['pc'],
+          pcDemo: 'custom-size',
+          meta: {
+            stable: '3.23.0'
+          }
+        },
+        {
+          name: 'panel-body-style',
+          type: 'Object',
+          defaultValue: '',
+          desc: {
+            'zh-CN': '指定面板内容区域的样式',
+            'en-US': 'Specify the style of the content area of the designated panel.'
+          },
+          mode: ['pc'],
+          pcDemo: 'custom-size',
+          meta: {
+            stable: '3.23.0'
+          }
+        },
+        {
+          name: 'panel-table-height',
+          type: 'String',
+          defaultValue: '',
+          desc: {
+            'zh-CN':
+              '嵌套表格时，设置表格的高度值。嵌套表格的默认高度为400px, 当自定义面板内容区域的高度之后，可能会与表格高度不匹配。 可以通过该属性设置一个匹配的表格高度。',
+            'en-US':
+              'When nesting tables, set the height value of the table. The default height of a nested table is 400px. After customizing the height of the panel content area, it may not match the height of the table. You can use this property to set a matching table height.'
+          },
+          mode: ['pc'],
+          pcDemo: 'custom-size',
+          meta: {
+            stable: '3.23.0'
+          }
         }
       ],
       events: [

package/demos/apis/tree-menu.js

@@ -286,6 +286,7 @@ export default {
         },
         {
           name: 'only-check-children',
+          type: 'boolean',
           defaultValue: 'false',
           desc: {
             'zh-CN': '父级是否不可选，只能展开不能跳转',