@opentiny/vue-docs 2.2.17 → 2.2.19

package/demos/apis/grid.js

@@ -565,7 +565,7 @@ export default {
           type: 'number | string',
           defaultValue: '',
           desc: {
-            'zh-CN': '设置表格内容区域（不含表格头部，底部）的最小高度。',
+            'zh-CN': '设置表格内容区域（不含表格头部，底部）的最小高度',
             'en-US': 'Set the minimum height of the table content area (excluding the table header and bottom).'
           },
           mode: ['pc', 'mobile-first'],
@@ -1019,6 +1019,7 @@ export default {
         {
           name: 'tooltip-config',
           type: 'IToolTipConfig',
+          typeAnchorName: 'IToolTipConfig',
           defaultValue: '',
           desc: {
             'zh-CN': 'Grid 内置 tooltip 配置项，请参考 Tooltip 组件属性说明',
@@ -2497,7 +2498,7 @@ export default {
           type: '',
           defaultValue: '',
           desc: {
-            'zh-CN': '在表格中新增数据。 ',
+            'zh-CN': '在表格中新增数据',
             'en-US': ''
           },
           mode: ['mobile-first'],
@@ -3330,7 +3331,7 @@ export default {
           type: "'left' | 'center' | 'right'",
           defaultValue: "'left'",
           desc: {
-            'zh-CN': '列对其方式',
+            'zh-CN': '列对齐方式',
             'en-US': 'Column pair mode; The optional values for this property are left, center, right'
           },
           mode: ['pc'],
@@ -3416,7 +3417,7 @@ export default {
           type: 'IFormatConfig',
           defaultValue: '',
           desc: {
-            'zh-CN': '开启该列数据异步渲染。',
+            'zh-CN': '开启该列数据异步渲染',
             'en-US': 'Enable the asynchronous rendering of the column data'
           },
           mode: ['pc'],
@@ -3824,7 +3825,7 @@ export default {
           type: 'boolean',
           defaultValue: '',
           desc: {
-            'zh-CN': '工具栏组件开启表格刷新功能。',
+            'zh-CN': '工具栏组件开启表格刷新功能',
             'en-US': 'The table refresh function is enabled for the toolbar component.'
           },
           mode: ['pc'],
@@ -3898,7 +3899,7 @@ export default {
           type: '()=> void',
           defaultValue: '',
           desc: {
-            'zh-CN': '点击个性化面板的重置按钮触发该事件。',
+            'zh-CN': '点击个性化面板的重置按钮触发该事件',
             'en-US': 'Click the Reset button on the personalized panel to trigger the event.'
           },
           mode: ['pc'],
@@ -4030,6 +4031,21 @@ interface IToolbarConfig {
     code: string
     name: string
   }[]
+}
+      `
+    },
+    {
+      name: 'IToolTipConfig',
+      type: 'type',
+      code: `
+interface IToolTipConfig {
+  placement?: 'top' | 'top-start' | 'top-end' | 'bottom' | 'bottom-start' | 'bottom-end' | 'left' | 'left-start' | 'left-end' | 'right' | 'right-start' | 'right-end'
+  visibleArrow?: boolean
+  enterable?: boolean
+  type?: 'normal' | 'warning' | 'error' | 'info' | 'success'
+  effect?: 'dark' | 'light'
+  // 自定义提示内容
+  contentMethod?: ()=> string | VNode
 }
       `
     },
@@ -4379,27 +4395,11 @@ interface IToolbarButtonClickArgs {
       code: `
 interface ICellClickArgs {
   // 当前行
-  row: object,
+  row: IRow,
   // 当前行的下标
   rowIndex: number
   // 当前列
-  column: object
-  // 当前列的下标
-  columnIndex: number
-}
-      `
-    },
-    {
-      name: 'ICellClickArgs',
-      type: 'type',
-      code: `
-interface ICellClickArgs {
-  // 当前行
-  row: object
-  // 当前行的下标
-  rowIndex: number
-  // 当前列
-  column: object
+  column: IColumnConfig
   // 当前列的下标
   columnIndex: number
 }
@@ -4411,7 +4411,7 @@ interface ICellClickArgs {
       code: `
 interface ICellContextMenuArgs {
   // 当前行
-  row: object
+  row: IRow
 }
       `
     },
@@ -4421,11 +4421,11 @@ interface ICellContextMenuArgs {
       code: `
 interface ICellArgs {
   //当前行
-  row: object
+  row: IRow
   //当前行的下标
   rowIndex: number
   // 当前列 
-  column: object
+  column: IColumnConfig
   // 当前列的下标 
   columnIndex: number
 }
@@ -4437,7 +4437,7 @@ interface ICellArgs {
       code: `
 interface ICurrentChangeArgs {
   // 当前行
-  row: object
+  row: IRow
 }
       `
     },
@@ -4447,9 +4447,9 @@ interface ICurrentChangeArgs {
       code: `
 interface IEditActivedArgs {
   // 当前行
-  row: object
+  row: IRow
   // 当前列 
-  column: object
+  column: IColumnConfig
 }
       `
     },
@@ -4459,9 +4459,9 @@ interface IEditActivedArgs {
       code: `
 interface IEditClosedArgs {
   // 当前行
-  row: object
+  row: IRow
   // 当前列 
-  column: object
+  column: IColumnConfig
 }
       `
     },
@@ -4471,9 +4471,9 @@ interface IEditClosedArgs {
       code: `
 interface IEditDisabledArgs {
   //当前行
-  row: object
+  row: IRow
   // 当前列 
-  column: object
+  column: IColumnConfig
 }
       `
     },
@@ -4501,7 +4501,7 @@ interface IFooterCellClickArgs {
   // 当前单元格节点 
   cell: HTMLElement
   // 当前列信息
-  column: object
+  column: IColumnConfig
   columnIndex: number
 }
       `
@@ -4518,7 +4518,7 @@ interface IContextMenuArgs {
   // 当前单元格节点
   cell: HTMLElement
   // 当前列信息
-  column: object
+  column: IColumnConfig
   columnIndex: number
   // 配置清除等功能信息
   options: object[]
@@ -4539,7 +4539,7 @@ interface IFooterCellDblClickArgs {
   // 当前单元格节点
   cell: HTMLElement
   // 当前列信息
-  column: object
+  column: IColumnConfig
   columnIndex: number
 }
       `
@@ -4556,7 +4556,7 @@ interface IHeaderCellClickArgs {
   // 点击表头单元格
   cell: HTMLElement
   // 当前列信息
-  column: object
+  column: IColumnConfig
   columnIndex: number
   // 当前点击节点过滤标识
   triggerFilter: boolean
@@ -4571,7 +4571,7 @@ interface IHeaderCellClickArgs {
       code: `
 interface IHeaderCellDblClickArgs {
   // 列数据
-  column: object  
+  column: IColumnConfig  
   // 列索引
   columnIndex: number
   // table组件 vue实例 
@@ -4589,7 +4589,7 @@ interface IResizableChangeArgs {
   // table组件的vue 实例 
   $table: Component,
   // 列配置信息 
-  column: object 
+  column: IColumnConfig 
   // 拖动列的索引
   columnIndex: number
   // 是否固定列

package/demos/apis/ip-address.js

@@ -10,7 +10,7 @@ export default {
           type: 'Component',
           defaultValue: '',
           desc: {
-            'zh-CN': '设置IP段之间的分隔符，默认图标为IconDotIpv4',
+            'zh-CN': '设置 ip 段之间的分隔符，默认图标为 IconDotIpv4 ',
             'en-US': 'Set the separator between IP segments, default icon is icon-dot-ipv4'
           },
           mode: ['pc'],
@@ -54,7 +54,7 @@ export default {
           type: "'IPv4' | 'IPv6'",
           defaultValue: "'IPv4'",
           desc: {
-            'zh-CN': '设置 ip 地址输入框的 类型',
+            'zh-CN': '设置 ip 地址输入框的类型',
             'en-US': 'Sets the type attribute in the IpAddress box'
           },
           mode: ['pc'],
@@ -135,7 +135,7 @@ export default {
           name: 'default',
           defaultValue: '',
           desc: {
-            'zh-CN': '默认插槽，自定义IP段之间的分隔符',
+            'zh-CN': '默认插槽，自定义 ip 段之间的分隔符',
             'en-US': 'Separator between IP address segments'
           },
           mode: ['pc'],

package/demos/apis/multi-select.js

@@ -6,34 +6,104 @@ export default {
       type: 'component',
       props: [
         {
-          name: 'dataSource',
-          type: '[]',
-          defaultValue: '',
+          name: 'data-source',
+          type: 'IMultiSelectMenu[]',
+          typeAnchorName: 'IMultiSelectMenu',
+          defaultValue: '[]',
           desc: {
-            'zh-CN': '<p>数据</p>',
-            'en-US': 'display different button'
+            'zh-CN': '数据源',
+            'en-US': 'data source'
           },
           mode: ['mobile'],
           mobileDemo: 'basic-usage'
         },
         {
-          name: 'defaultSelectedArray',
-          type: '[]',
+          name: 'default-selected-array',
+          type: 'number[]',
           defaultValue: '',
           desc: {
-            'zh-CN': '<p>默认值</p>',
-            'en-US': 'display different button'
+            'zh-CN': `默认值，当 type='wheel' 时适用`,
+            'en-US': `default selected value, used when type='wheel'`
           },
           mode: ['mobile'],
-          mobileDemo: 'basic-usage'
+          mobileDemo: 'type-wheel'
         },
         {
-          name: 'v-model/modelValue',
-          type: '[]',
+          name: 'disabled',
+          type: 'Boolean',
+          defaultValue: 'false',
+          desc: {
+            'zh-CN': '禁用',
+            'en-US': 'disabled'
+          },
+          mode: ['mobile'],
+          mobileDemo: 'disabled'
+        },
+        {
+          name: 'filterable',
+          type: 'Boolean',
+          defaultValue: 'false',
+          desc: {
+            'zh-CN': '可筛选',
+            'en-US': 'filterable'
+          },
+          mode: ['mobile'],
+          mobileDemo: 'filter'
+        },
+        {
+          name: 'mask',
+          type: 'Boolean',
+          defaultValue: 'false',
+          desc: {
+            'zh-CN': '是否显示遮罩层',
+            'en-US': 'to show mask'
+          },
+          mode: ['mobile'],
+          mobileDemo: 'mask'
+        },
+        {
+          name: 'mask-options',
+          type: 'IMaskOptions',
+          typeAnchorName: 'IMaskOptions',
+          defaultValue: '{}',
+          desc: {
+            'zh-CN':
+              '遮罩层配置：<ul><li>zIndex: 遮罩层的层叠数值</li><li>cancelTouch: 是否禁用 touch 事件，禁用后点击遮罩层不能关闭下拉框</li></ul>',
+            'en-US':
+              'Mask layer settings, including the following properties: <p>zIndex: the stacking order value of the mask layer;</p><p>cancelTouch: whether to disable touch events.</p>'
+          },
+          mode: ['mobile'],
+          mobileDemo: 'mask-options'
+        },
+        {
+          name: 'search-placeholder',
+          type: 'string',
+          defaultValue: '搜索',
+          desc: {
+            'zh-CN': '搜索框默认提示',
+            'en-US': 'search input placeholder'
+          },
+          mode: ['mobile'],
+          mobileDemo: 'filter'
+        },
+        {
+          name: 'type',
+          type: `'list' | 'wheel'`,
           defaultValue: '',
+          desc: {
+            'zh-CN': '选项外观，其中 list：列表形式；wheel：滑轮模式',
+            'en-US': 'option appearance'
+          },
+          mode: ['mobile'],
+          mobileDemo: 'wheel'
+        },
+        {
+          name: 'v-model/modelValue',
+          type: '(string | string[])[]',
+          defaultValue: '[]',
           desc: {
             'zh-CN': '<p>选中值</p>',
-            'en-US': ''
+            'en-US': '<p>selected value</p>'
           },
           mode: ['mobile'],
           mobileDemo: 'basic-usage'
@@ -41,28 +111,77 @@ export default {
       ],
       events: [
         {
-          name: 'confim',
+          name: 'item-click',
+          type: '(option, headerIndex) => void',
+          desc: {
+            'zh-CN': '点击选项事件，当 type="list" 时适用',
+            'en-us': 'click option event, applicable when type = "list"'
+          },
+          mode: ['mobile'],
+          mobileDemo: 'event-click-item'
+        },
+        {
+          name: 'confirm',
+          type: '',
           defaultValue: '',
           desc: {
-            'zh-CN': '<p>确认事件</p>',
-            'en-US': 'display different button'
+            'zh-CN': `确认事件，当 type='wheel' 时适用`,
+            'en-US': `confirm selection event, applicable when the type = 'wheel'`
           },
           mode: ['mobile'],
-          mobileDemo: 'basic-usage'
+          mobileDemo: 'type-wheel'
         },
         {
           name: 'reset',
+          type: '',
           defaultValue: '',
           desc: {
-            'zh-CN': '<p>重置事件</p>',
-            'en-US': 'display different button'
+            'zh-CN': `重置事件，当 type='wheel' 时适用`,
+            'en-US': `reset selection event, applicable when the type = 'wheel'`
           },
           mode: ['mobile'],
-          mobileDemo: 'basic-usage'
+          mobileDemo: 'type-wheel'
         }
       ],
-      methods: [],
-      slots: []
+      slots: [
+        {
+          name: 'footer',
+          desc: {
+            'zh-CN': '选项底部插槽',
+            'en-US': 'slot under options'
+          },
+          mode: ['mobile'],
+          mobileDemo: 'slots'
+        }
+      ]
+    }
+  ],
+
+  types: [
+    {
+      name: 'IMultiSelectMenu',
+      type: 'interface',
+      code: `
+interface IMultiSelectMenu {
+  title: string, // 菜单项标题
+  options: IMultiSelectOption[], // 选项数据
+  multiple?: boolean, // 是否多选
+  disabled?: boolean, // 菜单项是否禁用
+  hasFooter?: boolean // 是否显示底部
+}
+`
+    },
+    {
+      name: 'IMultiSelectOption',
+      type: 'interface',
+      code: `
+interface IMultiSelectOption {
+  label: string, // 选项内容
+  value: string, // 选项值
+  disabled?: boolean, // 是否禁用
+  children?: IMultiSelectOption[], // 子选项数据
+}
+`
     }
   ]
 }

package/demos/apis/numeric.js

@@ -369,6 +369,19 @@ export default {
           pcDemo: 'basic-usage',
           mfDemo: ''
         },
+        {
+          name: 'change-compat',
+          type: 'boolean',
+          defaultValue: 'false',
+          desc: {
+            'zh-CN': '设置除加减按钮及直接输入数值之外，值改变后是否触发change事件',
+            'en-US':
+              'Set whether to trigger the change event after the value is changed, except for the plus and minus buttons and direct input of values.'
+          },
+          mode: ['pc', 'mobile-first', 'mobile'],
+          pcDemo: 'change-event',
+          mfDemo: ''
+        },
         {
           name: 'validate-event',
           type: 'Boolean',

package/demos/apis/popeditor.js

@@ -96,8 +96,8 @@ export default {
         },
         {
           name: 'grid-op',
-          typeAnchorName: 'grid#IGridOp',
-          type: 'IGridOp',
+          typeAnchorName: 'grid#API',
+          type: `InstanceType&#60typeof TinyGrid&#62['$props']`,
           defaultValue: '',
           desc: {
             'zh-CN': '设置弹出面板中表格组件的配置信息',
@@ -141,8 +141,8 @@ export default {
         },
         {
           name: 'pager-op',
-          typeAnchorName: 'pager#IPagerOp',
-          type: 'IPagerOp',
+          typeAnchorName: 'pager#API',
+          type: `InstanceType&#60typeof TinyPager&#62['$props']`,
           defaultValue: '',
           desc: {
             'zh-CN': '设置分页配置',
@@ -165,7 +165,7 @@ export default {
         {
           name: 'popseletor',
           type: 'string',
-          defaultValue: 'grid',
+          defaultValue: `'grid'`,
           desc: {
             'zh-CN': '设置弹出面板中可显示的树或者表格组件',
             'en-US': 'Set the tree or table components that can be displayed in the pop-up panel.'
@@ -198,7 +198,8 @@ export default {
         },
         {
           name: 'remote-search',
-          type: '({ page, conditions }) => void',
+          type: 'IRemoteSearch',
+          typeAnchorName: 'IRemoteSearch',
           defaultValue: '',
           desc: {
             'zh-CN': '配置远程搜索',
@@ -220,8 +221,8 @@ export default {
         },
         {
           name: 'selected-box-op',
-          typeAnchorName: 'ISelectedBoxOp',
-          type: 'ISelectedBoxOp',
+          typeAnchorName: 'dialog-select#ISelectedBoxOption',
+          type: 'ISelectedBoxOption',
           defaultValue: '',
           desc: {
             'zh-CN': '通过属性 selected-box-op 指定 SelectedBox 组件配置，可以把已选表格显示为已选栏',
@@ -301,7 +302,7 @@ export default {
         {
           name: 'tabindex',
           type: 'string',
-          defaultValue: '1',
+          defaultValue: `'1'`,
           desc: {
             'zh-CN': '设置通过 Tab 键获焦及获焦顺序（readonly 属性设置为 false 时有效）',
             'en-US':
@@ -313,7 +314,7 @@ export default {
         {
           name: 'text-field',
           type: 'string',
-          defaultValue: 'label',
+          defaultValue: `'label'`,
           desc: {
             'zh-CN': '设置输入框中显示文本的字段，提交数据时，不提交该显示文本',
             'en-US': 'Set the text field in the text box. When data is submitted, the text is not submitted.'
@@ -324,7 +325,7 @@ export default {
         {
           name: 'text-split',
           type: 'string',
-          defaultValue: '/',
+          defaultValue: `'/'`,
           desc: {
             'zh-CN': '在多选的情况下，设置输入框中要显示多个数据时的分隔符',
             'en-US': 'Separator for displaying multiple records in the text box when multiple records are selected.'
@@ -359,7 +360,7 @@ export default {
         {
           name: 'value-field',
           type: 'string',
-          defaultValue: 'id',
+          defaultValue: `'id'`,
           desc: {
             'zh-CN': '设置输入框要提交数据的字段',
             'en-US': 'Set the field to which data is to be submitted in the text box.'
@@ -370,7 +371,7 @@ export default {
         {
           name: 'value-split',
           type: 'string',
-          defaultValue: ';',
+          defaultValue: `';'`,
           desc: {
             'zh-CN': '在多选的情况下，设置输入框要提交多个数据时的分隔符',
             'en-US':
@@ -395,7 +396,7 @@ export default {
       events: [
         {
           name: 'change',
-          type: '(commitValue, selectedDatas) => void',
+          type: '(commitValue: number, selectedDatas: Object) => void',
           defaultValue: '',
           desc: {
             'zh-CN':
@@ -476,6 +477,11 @@ interface IConditions {
   label: string
 }
       `
+    },
+    {
+      name: 'IRemoteSearch',
+      type: 'type',
+      code: `type IRemoteSearch = ({ page: { currentPage: number, pageSize: number }, conditions: { [K in IConditions['field']]: string } }) => void`
     }
   ]
 }

package/demos/apis/search.js

@@ -74,6 +74,17 @@ export default {
           pcDemo: 'events',
           mfDemo: ''
         },
+        {
+          name: 'maxlength',
+          type: 'number',
+          defaultValue: '',
+          desc: {
+            'zh-CN': 'input 框的原生属性，限制最大输入字符数【3.14.0新增】',
+            'en-US': 'The native properties of the input box limit the maximum number of input characters[New 3.14.0]'
+          },
+          mode: ['pc'],
+          pcDemo: 'basic-usage'
+        },
         {
           name: 'mini',
           type: 'boolean',

package/demos/apis/slider.js

@@ -111,8 +111,8 @@ export default {
           type: 'boolean',
           defaultValue: 'false',
           desc: {
-            'zh-CN': '是否显示输入框，仅在非范围选择时有效',
-            'en-US': 'Indicates whether to display the text box. This parameter is valid only for non-range selection'
+            'zh-CN': '是否显示输入框',
+            'en-US': 'Indicates whether to display the text box.'
           },
           mode: ['pc', 'mobile', 'mobile-first'],
           pcDemo: 'show-input',
@@ -203,6 +203,17 @@ export default {
           mode: ['mobile'],
           mobileDemo: ''
         },
+        {
+          name: 'marks',
+          type: `{ [key:number]: string }`,
+          defaultValue: '',
+          desc: {
+            'zh-CN': '<p>设置滑杆的刻度值</p>',
+            'en-US': 'Set the scale value of the slide bar'
+          },
+          mode: ['pc'],
+          pcDemo: 'marks'
+        },
         {
           name: 'vertical',
           type: 'boolean',

package/demos/apis/steps.js

@@ -41,8 +41,8 @@ export default {
         },
         {
           name: 'data',
-          typeAnchorName: 'IStepsItem[]',
-          type: 'IStepsItem',
+          typeAnchorName: 'IStepsItem',
+          type: 'IStepsItem[]',
           defaultValue: '[]',
           desc: {
             'zh-CN': '步骤条的数据',
@@ -227,11 +227,11 @@ export default {
       type: 'interface',
       code: `
 interface IStepsItem {
-  // 条形步骤条数据项
+  // 节点数据
   name: string, // 节点名称
-  description: string, // 描述，仅用于单链型步骤条
-  status: IStepsStatus, // 节点状态，取值见下面IStepsStatus类型说明
-  count: number // 节点右上角徽标计数，仅用于默认条形步骤条
+  status?: IStepsStatus, // 节点状态，取值见下面IStepsStatus类型说明
+  description?: string, // 描述，仅用于单链型步骤条
+  count?: number // 节点右上角徽标计数，仅用于默认条形步骤条
 }
       `
     },