@opentiny/vue-docs 3.16.2 → 3.17.0

package/demos/apis/breadcrumb.js

@@ -170,6 +170,7 @@ interface IOptionsItemTo {
     {
       name: 'IOptionsItem',
       type: 'interface',
+      depTypes: ['IOptionsItemTo'],
       code: `
 interface IOptionsItem {
   label?: string
@@ -181,6 +182,7 @@ interface IOptionsItem {
     {
       name: 'ISelectValue',
       type: 'interface',
+      depTypes: ['IOptionsItem', 'IOptionsItemTo'],
       code: `
 interface ISelectValue {
   event: Event

package/demos/apis/button-group.js

@@ -172,6 +172,17 @@ export default {
           mode: ['pc', 'mobile-first'],
           pcDemo: 'slot-default',
           mfDemo: ''
+        },
+        {
+          name: 'empty',
+          type: '',
+          defaultValue: '',
+          desc: {
+            'zh-CN': '自定义数据为空时展示内容',
+            'en-US': 'customize content when data is empty'
+          },
+          mode: ['pc'],
+          pcDemo: 'slot-empty'
         }
       ]
     }
@@ -185,6 +196,7 @@ interface IButtonGroupData {
   text: string // 显示文本
   value: number | number // 选中的值
   disabled?: boolean // 是否禁用
+  tip?: string // 按钮悬浮提示 v3.17.0版本增加此功能
   // 配置选块角标
   sup?: {
     text: string // 角标文本

package/demos/apis/calendar.js

@@ -7,8 +7,8 @@ export default {
       props: [
         {
           name: 'events',
-          typeAnchorName: 'eventLists',
-          type: 'eventLists[]',
+          typeAnchorName: 'ICalendarEvent',
+          type: 'ICalendarEvent[]',
           defaultValue: '',
           desc: {
             'zh-CN': '事件列表',
@@ -90,15 +90,17 @@ export default {
   ],
   types: [
     {
-      name: 'eventLists',
+      name: 'ICalendarEvent',
       type: 'interface',
       code: `
-      interface eventLists [{
-        time: 1534297845236, // 指定需要展示事件的日期
-        title: '消息', // 指定事件标题
-        content: '这是一条消息', // 指定事件的具体内容
-        type: 'info' // 事件主题类型，包括 warning、error、info、success。
-      }]`
+type ICalendarEventType = 'info' | 'warning' | 'error' | 'info' | 'success'
+
+interface ICalendarEvent {
+    time: number, // 指定需要展示事件的日期的时间戳
+    title: string, // 指定事件标题
+    content: string, // 指定事件的具体内容
+    type: ICalendarEventType // 事件主题类型
+}`
     }
   ]
 }

package/demos/apis/card.js

@@ -7,7 +7,7 @@ export default {
       props: [
         {
           name: 'auto-width',
-          type: 'Boolean',
+          type: 'boolean',
           defaultValue: '',
           desc: {
             'zh-CN': '卡片的宽度是否自动撑开，设置后将不再给卡片设置固定宽度',
@@ -20,7 +20,7 @@ export default {
         },
         {
           name: 'check-type',
-          type: 'String',
+          type: 'string',
           defaultValue: '',
           desc: {
             'zh-CN': '设置卡片单选、多选，单选/radio；多选/checkbox，需同时设置 label。',
@@ -33,7 +33,7 @@ export default {
         },
         {
           name: 'custom-class',
-          type: 'String',
+          type: 'string',
           defaultValue: '',
           desc: {
             'zh-CN': '卡片的class',
@@ -45,8 +45,8 @@ export default {
         },
         {
           name: 'disabled',
-          type: 'Boolean',
-          defaultValue: '',
+          type: 'boolean',
+          defaultValue: 'false',
           desc: {
             'zh-CN': '卡片禁用',
             'en-US': 'Card disabled'
@@ -57,7 +57,7 @@ export default {
         },
         {
           name: 'height',
-          type: 'String',
+          type: 'string',
           defaultValue: '',
           desc: {
             'zh-CN': '卡片内容区域的高度',
@@ -69,7 +69,7 @@ export default {
         },
         {
           name: 'icon-more',
-          type: 'Object',
+          type: "'iconxxx' | Component",
           defaultValue: '',
           desc: {
             'zh-CN': '更多按钮图标，可传入一个svg图标对象进行替换',
@@ -81,7 +81,7 @@ export default {
         },
         {
           name: 'label',
-          type: 'String / Number',
+          type: 'string / number',
           defaultValue: '',
           desc: {
             'zh-CN': 'checkbox或radio的label',
@@ -93,7 +93,8 @@ export default {
         },
         {
           name: 'options',
-          type: 'Array',
+          typeAnchorName: 'IOptions',
+          type: 'IOptions',
           defaultValue: '',
           desc: {
             'zh-CN': '操作按钮配置',
@@ -105,8 +106,8 @@ export default {
         },
         {
           name: 'size',
-          type: 'String',
-          defaultValue: '',
+          type: 'string',
+          defaultValue: 'medium',
           desc: {
             'zh-CN': '尺寸，支持large、medium、small、mini 4个尺寸，默认值为medium',
             'en-US': 'Size. The options are large, medium, small, and mini. The default value is medium.'
@@ -117,7 +118,7 @@ export default {
         },
         {
           name: 'src',
-          type: 'String',
+          type: 'string',
           defaultValue: '',
           desc: {
             'zh-CN': '图片或者视频的地址',
@@ -129,8 +130,8 @@ export default {
         },
         {
           name: 'status',
-          type: 'String',
-          defaultValue: '',
+          type: 'string',
+          defaultValue: 'default',
           desc: {
             'zh-CN': '卡片状态，支持 success、warning、alerting、danger 4 种状态',
             'en-US': 'Card status. The value can be success, warning, alerting, or dangerous.'
@@ -141,7 +142,7 @@ export default {
         },
         {
           name: 'title',
-          type: 'String',
+          type: 'string',
           defaultValue: '',
           desc: {
             'zh-CN': '卡片的标题',
@@ -153,10 +154,10 @@ export default {
         },
         {
           name: 'type',
-          type: 'String',
-          defaultValue: '',
+          type: 'string',
+          defaultValue: 'text',
           desc: {
-            'zh-CN': '设置卡片类型，支持 text、image、video、logo 4 种类型。',
+            'zh-CN': '设置卡片类型，支持 text、image、video、logo 4 种类型',
             'en-US': 'Set the card type. The options are text, image, video, and logo.'
           },
           mode: ['pc', 'mobile-first'],
@@ -165,7 +166,7 @@ export default {
         },
         {
           name: 'v-model',
-          type: 'String',
+          type: 'string',
           defaultValue: '',
           desc: {
             'zh-CN': '绑定值，默认为空',
@@ -174,12 +175,24 @@ export default {
           mode: ['pc', 'mobile-first'],
           pcDemo: 'check-type-checkbox',
           mfDemo: ''
+        },
+        {
+          name: 'check-mode',
+          type: 'string',
+          defaultValue: 'normal',
+          desc: {
+            'zh-CN': '卡片被选中后的呈现模式，可选值为：normal | simple | badge',
+            'en-US': 'Display mode of a selected card. The options are as follows: normal | simple | badge'
+          },
+          mode: ['pc', 'mobile-first'],
+          pcDemo: 'check-mode',
+          mfDemo: ''
         }
       ],
       events: [
         {
           name: 'change',
-          type: 'Function()',
+          type: '() => {}',
           defaultValue: '',
           desc: {
             'zh-CN': '组件选中/取消选中事件',
@@ -191,7 +204,7 @@ export default {
         },
         {
           name: 'icon-click',
-          type: 'Function()',
+          type: '() => {}',
           defaultValue: '',
           desc: {
             'zh-CN': '操作栏按钮点击事件',
@@ -203,7 +216,7 @@ export default {
         },
         {
           name: 'click',
-          type: 'Function()',
+          type: '() => {}',
           defaultValue: '',
           desc: {
             'zh-CN': '点击卡片事件',
@@ -278,5 +291,33 @@ export default {
         }
       ]
     }
+  ],
+  types: [
+    {
+      name: 'IOptions',
+      type: 'interface',
+      code: `
+interface IOptions [
+  {
+    text: '删除列表',
+    icon: IconDel()
+  },
+  {
+    text: '编辑',
+    icon: IconWriting(),
+    disabled: true
+  },
+  {
+    text: '排序',
+    icon: IconAscending()
+  },
+  {
+    text: '分享',
+    icon: IconShare(),
+    disabled: true
+  }
+]
+`
+    }
   ]
 }

package/demos/apis/carousel.js

@@ -146,6 +146,44 @@ export default {
           mode: ['pc', 'mobile-first'],
           pcDemo: 'card-mode',
           mfDemo: ''
+        },
+        {
+          name: 'swipeable',
+          type: 'boolean',
+          defaultValue: 'false',
+          desc: {
+            'zh-CN': '是否支持触屏轮播',
+            'en-US': 'Support Touchscreen Carousel'
+          },
+          mode: ['mobile-first'],
+          pcDemo: '',
+          mfDemo: ''
+        },
+        {
+          name: 'lite',
+          type: 'boolean',
+          defaultValue: 'false',
+          desc: {
+            'zh-CN': '是否打开精简模式，不显示切换按钮和指示器',
+            'en-US':
+              'Indicates whether to enable the simplified mode. The switch button and indicator are not displayed.'
+          },
+          mode: ['pc', 'mobile-first'],
+          pcDemo: 'swipeable',
+          mfDemo: ''
+        },
+        {
+          name: 'beforeSwipe',
+          type: '(newIndex,oldIndex) => boolean',
+          defaultValue: '',
+          desc: {
+            'zh-CN': '触摸轮播前，通过返回值控制某个图是否可轮播显示',
+            'en-US':
+              'Controls whether a graph can be displayed in rotation based on the return value before the rotation is touched.'
+          },
+          mode: ['pc', 'mobile-first'],
+          pcDemo: 'swipeable',
+          mfDemo: ''
         }
       ],
       events: [
@@ -255,7 +293,7 @@ export default {
             'en-US': 'Default slot'
           },
           mode: ['pc'],
-          pcDemo: 'manual-play'
+          pcDemo: 'card-show'
         }
       ]
     }

package/demos/apis/cascader-panel.js

@@ -252,6 +252,7 @@ export default {
     {
       name: 'ICascaderPanelNodePropValue',
       type: 'type',
+      depTypes: ['ICascaderPanelNodeValue'],
       code: `
 type ICascaderPanelNodePropValue =
   | ICascaderPanelNodeValue
@@ -261,6 +262,7 @@ type ICascaderPanelNodePropValue =
     {
       name: 'ICascaderPanelData',
       type: 'type',
+      depTypes: ['ICascaderPanelNodeValue'],
       code: `
 type ICascaderPanelData = {
   value?: ICascaderPanelNodeValue
@@ -274,6 +276,7 @@ type ICascaderPanelData = {
     {
       name: 'ICascaderPanelConfig',
       type: 'interface',
+      depTypes: ['ICascaderPanelNode', 'ICascaderPanelData'],
       code: `
 interface ICascaderPanelConfig {
   emitPath: boolean
@@ -296,6 +299,7 @@ interface ICascaderPanelConfig {
     {
       name: 'ICascaderPanelNode',
       type: 'type',
+      depTypes: ['ICascaderPanelData', 'ICascaderPanelConfig', 'ICascaderPanelNodeValue'],
       code: `
 type ICascaderPanelNode = {
   parent: ICascaderPanelNode | null
@@ -320,6 +324,7 @@ type ICascaderPanelNode = {
     {
       name: 'ICascaderPanelLazyLoad',
       type: 'type',
+      depTypes: ['ICascaderPanelNode', 'ICascaderPanelData'],
       code: `
 type ICascaderPanelLazyLoad = (node: ICascaderPanelNode, resolve: (dataList: ICascaderPanelData[]) => void) => void
       `

package/demos/apis/cascader.js

@@ -536,6 +536,7 @@ export default {
     {
       name: 'ICascaderPanelNodePropValue',
       type: 'type',
+      depTypes: ['ICascaderPanelNodeValue'],
       code: `
 type ICascaderPanelNodePropValue =
   | ICascaderPanelNodeValue
@@ -545,6 +546,7 @@ type ICascaderPanelNodePropValue =
     {
       name: 'ICascaderPanelData',
       type: 'type',
+      depTypes: ['ICascaderPanelNodeValue'],
       code: `
 type ICascaderPanelData = {
   value?: ICascaderPanelNodeValue
@@ -558,6 +560,7 @@ type ICascaderPanelData = {
     {
       name: 'ICascaderPanelConfig',
       type: 'interface',
+      depTypes: ['ICascaderPanelNode', 'ICascaderPanelData'],
       code: `
 interface ICascaderPanelConfig {
   emitPath: boolean
@@ -580,6 +583,7 @@ interface ICascaderPanelConfig {
     {
       name: 'ICascaderPanelNode',
       type: 'type',
+      depTypes: ['ICascaderPanelNode', 'ICascaderPanelData', 'ICascaderPanelConfig', 'ICascaderPanelNodeValue'],
       code: `
 type ICascaderPanelNode = {
   parent: ICascaderPanelNode | null
@@ -604,6 +608,7 @@ type ICascaderPanelNode = {
     {
       name: 'ICascaderPanelLazyLoad',
       type: 'type',
+      depTypes: ['ICascaderPanelNode', 'ICascaderPanelData'],
       code: `
 type ICascaderPanelLazyLoad = (node: ICascaderPanelNode, resolve: (dataList: ICascaderPanelData[]) => void) => void
       `

package/demos/apis/collapse.js

@@ -142,6 +142,17 @@ export default {
           },
           mode: ['pc'],
           pcDemo: 'title'
+        },
+        {
+          name: 'expand-icon',
+          type: 'Component',
+          defaultValue: '',
+          desc: {
+            'zh-CN': '自定义icon 图标',
+            'en-US': 'Customized icon'
+          },
+          mode: ['pc'],
+          pcDemo: 'icon'
         }
       ],
       events: [],

package/demos/apis/color-picker.js

@@ -65,7 +65,7 @@ export default {
       events: [
         {
           name: 'cancel',
-          type: '()=>void',
+          type: '() =>void',
           defaultValue: '',
           desc: {
             'zh-CN': '按下取消或点击外部的时触发该事件',

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

@@ -52,7 +52,7 @@ export default {
       events: [
         {
           name: 'cancel',
-          type: '()=>void',
+          type: '() =>void',
           defaultValue: '',
           desc: {
             'zh-CN': '按下取消或点击外部的时触发该事件',

package/demos/apis/currency.js

@@ -10,8 +10,8 @@ export default {
           type: 'boolean',
           defaultValue: '该属性的默认值为 true',
           desc: {
-            'zh-CN': '是否显示清除按钮;是否可清空',
-            'en-US': 'Whether to display the Clear button; Clearable'
+            'zh-CN': '是否显示清除按钮',
+            'en-US': 'Whether to display the Clear button'
           },
           mode: ['pc', 'mobile-first'],
           pcDemo: 'custom-service',
@@ -19,7 +19,7 @@ export default {
         },
         {
           name: 'disabled',
-          type: 'Boolen',
+          type: 'boolean',
           defaultValue: '该属性的默认值为 false',
           desc: {
             'zh-CN': '禁用',
@@ -116,14 +116,88 @@ export default {
           mfDemo: ''
         },
         {
-          name: 'v-model',
-          type: 'String / Number',
+          name: 'set-default',
+          type: 'boolean',
+          defaultValue: 'false',
+          desc: {
+            'zh-CN': '是否开启设置默认币种，默认值为 false',
+            'en-US':
+              'Indicates whether to enable the function of setting the default currency. The default value is false.'
+          },
+          mode: ['pc', 'mobile-first'],
+          pcDemo: 'set-default',
+          mfDemo: ''
+        },
+        {
+          name: 'set-default-currency',
+          type: 'function',
+          defaultValue: '',
+          desc: {
+            'zh-CN': '设置默认币种的自定义方法',
+            'en-US': 'Custom Method for Setting Default Currency'
+          },
+          mode: ['pc', 'mobile-first'],
+          pcDemo: 'set-default-custom-service',
+          mfDemo: ''
+        },
+        {
+          name: 'fetch-default-currency',
+          type: 'function',
+          defaultValue: '',
+          desc: {
+            'zh-CN': '设置默认币种的服务',
+            'en-US': 'Services that set the default currency'
+          },
+          mode: ['pc', 'mobile-first'],
+          pcDemo: 'set-default-custom-service',
+          mfDemo: ''
+        },
+        {
+          name: 'label',
+          type: 'string',
+          defaultValue: '',
+          desc: {
+            'zh-CN': `显示标题，设置 shape='filter' 属性切换至过滤器模式时有效，可参考 FilterBox 组件属性`,
+            'en-US': `Display title. This parameter is valid when shape='filter' is set to switch to the filter mode. For details, see the attributes of the FilterBox component.`
+          },
+          mode: ['pc', 'mobile-first'],
+          pcDemo: 'filter',
+          mfDemo: ''
+        },
+        {
+          name: 'drop-style',
+          type: 'object',
+          defaultValue: '{}',
+          desc: {
+            'zh-CN': '自定义下拉选项样式',
+            'en-US': 'Custom drop-down options style'
+          },
+          mode: ['pc', 'mobile-first'],
+          pcDemo: 'filter',
+          mfDemo: ''
+        },
+        {
+          name: 'shape',
+          type: 'string',
+          defaultValue: '',
+          desc: {
+            'zh-CN': `通过 shape='filter' 属性切换至过滤器模式`,
+            'en-US': `Switch to the filter mode by using the shape='filter' attribute.`
+          },
+          mode: ['pc', 'mobile-first'],
+          pcDemo: 'filter',
+          mfDemo: ''
+        },
+        {
+          name: 'tip',
+          type: 'string',
           defaultValue: '',
           desc: {
-            'zh-CN': '设置下拉框的值',
-            'en-US': ''
+            'zh-CN': `显示提示信息，设置 shape='filter' 属性切换至过滤器模式时有效，可参考 FilterBox 组件属性`,
+            'en-US': `Displays a message. This parameter is valid when shape='filter' is set to switch to the filter mode. For details, see the attributes of the FilterBox component.`
           },
-          mode: ['mobile-first'],
+          mode: ['pc', 'mobile-first'],
+          pcDemo: 'filter',
           mfDemo: ''
         }
       ],
@@ -131,13 +205,19 @@ export default {
         {
           name: 'change',
           type: '',
-          defaultValue: '',
+          defaultValue: '(arg1,arg2) => void',
           desc: {
-            'zh-CN':
-              'arg1:{Any|Array 单选并且未指定渲染类型时，是选中项的值字段，此时没有arg2参数；多选并且未指定渲染类型时，是选中项值字段组成的数组，此时没有arg2参数；单选并且渲染类型为树或者表格时，是选中项对象，此时没有arg2参数；多选并且渲染类型为树或者表格时，是选中项对象值字段组成的数组，此时有arg2参数；}，arg2:{Array 多选并且渲染类型为树或者表格时，是选中项对象组成的数组}',
-            'en-US': ''
+            'zh-CN': `
+              arg1:{Any|Array 单选并且未指定渲染类型时，是选中项的值字段，此时没有arg2参数；多选并且未指定渲染类型时，是选中项值字段组成的数组，此时没有arg2参数；单选并且渲染类型为树或者表格时，是选中项对象，此时没有arg2参数；多选并且渲染类型为树或者表格时，是选中项对象值字段组成的数组，此时有arg2参数；}，<br>
+              arg2:{Array 多选并且渲染类型为树或者表格时，是选中项对象组成的数组}
+            `,
+            'en-US': `
+              When arg1:{Any|Array is selected and the rendering type is not specified, this is the value field of the selected item. In this case, the arg2 parameter is not provided. If multiple options are selected and the rendering type is not specified, the value field of the selected items is an array. In this case, the arg2 parameter is not provided. If you select a single item and the rendering type is tree or table, the object is selected. In this case, the arg2 parameter is not provided. When multiple selections are selected and the rendering type is tree or table, the array is composed of the selected object value fields. In this case, the arg2 parameter is available.},<br>
+              arg2:{An array consisting of selected items when multiple Arrays are selected and the rendering type is tree or table}
+            `
           },
-          mode: ['mobile-first'],
+          mode: ['pc', 'mobile-first'],
+          pcDemo: '',
           mfDemo: ''
         }
       ],

package/demos/apis/dialog-select.js

@@ -502,6 +502,7 @@ interface IDialogOption {
     {
       name: 'IGridOption',
       type: 'interface',
+      depTypes: ['IColumnConfig'],
       code: `
 interface IGridOption {
   // 表格列配置

package/demos/apis/directives.js

@@ -0,0 +1,3 @@
+export default {
+  apis: []
+}