@opentiny/vue-docs 2.2.7 → 2.2.9

package/demos/pc/app/time-select/webdoc/time-select.js

@@ -5,28 +5,35 @@ export default {
     {
       'demoId': 'basic-usage',
       'name': { 'zh-CN': '基本用法', 'en-US': 'Basic Usage' },
-      'desc': { 'zh-CN': '详细用法参考如下示例', 'en-US': 'For details, see the following example.' },
+      'desc': { 'zh-CN': '详细用法参考如下示例。', 'en-US': 'For details, see the following example.' },
       'codeFiles': ['basic-usage.vue']
     },
     {
       'demoId': 'range-placeholder',
       'name': { 'zh-CN': '固定时间范围', 'en-US': 'Fixed Time Range' },
-      'desc': { 'zh-CN': '详细用法参考如下示例', 'en-US': 'For details, see the following example.' },
+      'desc': {
+        'zh-CN': '如果先选中了开始（或结束）时间，则结束（或开始）时间的状态也将会随之改变。',
+        'en-US': 'For details, see the following example.'
+      },
       'codeFiles': ['range-placeholder.vue']
     },
     {
       'demoId': 'default-value',
-      'name': { 'zh-CN': '选择器打开时默认时间设置', 'en-US': 'Default time setting when the selector is enabled' },
+      'name': { 'zh-CN': '设置打开默认时间', 'en-US': 'Default time setting when the selector is enabled' },
       'desc': {
-        'zh-CN': '<p>通过 <code>default-value</code> 设置选择器打开显示默认时间</p>\n',
+        'zh-CN': '<p>通过 <code>default-value</code> 设置选择器打开显示默认时间。</p>\n',
         'en-US': '<p>Use <code>default-value</code> to set the selector to open the default display time</p>\n'
       },
       'codeFiles': ['default-value.vue']
     },
     {
       'demoId': 'picker-options',
-      'name': { 'zh-CN': '指定时间点', 'en-US': 'Specified time point' },
-      'desc': { 'zh-CN': '<p>picker-options 设置时间点</p>\n', 'en-US': '<p>picker-options Set Time</p>\n' },
+      'name': { 'zh-CN': '固定时间点', 'en-US': 'Specified time point' },
+      'desc': {
+        'zh-CN':
+          '<p>提供固定时间点，可通过 picker-options 对象中的 start、end、step、minTime、maxTime 设置起始时间、结束时间、步长、最小有效时间和最大有效时间。</p>\n',
+        'en-US': '<p>picker-options Set Time</p>\n'
+      },
       'codeFiles': ['picker-options.vue']
     },
     {
@@ -42,30 +49,20 @@ export default {
     },
     {
       'demoId': 'clear-icon',
-      'name': { 'zh-CN': '自定义清空图标', 'en-US': 'Customized Clear Icon' },
+      'name': { 'zh-CN': '清空图标', 'en-US': 'Customized Clear Icon' },
       'desc': {
-        'zh-CN': '<p>通过 <code>clear-icon</code> 自定义清空图标</p>\n',
+        'zh-CN':
+          '<p>通过 <code>clearable</code> 显示清空图标，通过 <code>clear-icon</code> 自定义清空图标，通过 <code>popper-class</code> 自定义原生属性。</p>',
         'en-US': '<p>Clear the icon by <code>clear-icon</code></p>\n'
       },
       'codeFiles': ['clear-icon.vue']
     },
-    {
-      'demoId': 'clearable',
-      'name': { 'zh-CN': '显示清除按钮', 'en-US': 'Display the Clear button' },
-      'desc': { 'zh-CN': '详细用法参考如下示例', 'en-US': 'For details, see the following example.' },
-      'codeFiles': ['clear-icon.vue']
-    },
-    {
-      'demoId': 'name',
-      'name': { 'zh-CN': '原生属性', 'en-US': 'Native Attribute' },
-      'desc': { 'zh-CN': '详细用法参考如下示例', 'en-US': 'For details, see the following example.' },
-      'codeFiles': ['clear-icon.vue']
-    },
     {
       'demoId': 'event-blur',
       'name': { 'zh-CN': '事件', 'en-US': 'Event' },
       'desc': {
-        'zh-CN': '<p><code>focus</code> input 框聚焦时触发，<code>blur</code> input 框失焦时触发</p>\n',
+        'zh-CN':
+          '<p><code>focus</code> input 框聚焦时触发，<code>blur</code> input 框失焦时触发，<code>change</code> input 绑定值改变时触发。</p>\n',
         'en-US':
           'Triggered when the <p><code>focus</code> input frame is focused and when the input frame is out of focus</p>\n'
       },
@@ -81,40 +78,22 @@ export default {
       },
       'codeFiles': ['editable.vue']
     },
-    {
-      'demoId': 'disabled',
-      'name': { 'zh-CN': '禁用', 'en-US': 'Disabled' },
-      'desc': { 'zh-CN': '详细用法参考如下示例', 'en-US': 'For details, see the following example.' },
-      'codeFiles': ['disabled.vue']
-    },
-    {
-      'demoId': 'popper-class',
-      'name': { 'zh-CN': '自定义类名', 'en-US': 'Customized class name' },
-      'desc': { 'zh-CN': '详细用法参考如下示例', 'en-US': 'For details, see the following example.' },
-      'codeFiles': ['popper-class.vue']
-    },
-    {
-      'demoId': 'size-mini',
-      'name': { 'zh-CN': 'mini 尺寸', 'en-US': 'mini size' },
-      'desc': { 'zh-CN': '详细用法参考如下示例', 'en-US': 'For details, see the following example.' },
-      'codeFiles': ['size-mini.vue']
-    },
-    {
-      'demoId': 'size-small',
-      'name': { 'zh-CN': 'small 尺寸', 'en-US': 'small size' },
-      'desc': { 'zh-CN': '详细用法参考如下示例', 'en-US': 'For details, see the following example.' },
-      'codeFiles': ['size-small.vue']
-    },
     {
       'demoId': 'size-medium',
-      'name': { 'zh-CN': 'medium 尺寸', 'en-US': 'medium Size' },
-      'desc': { 'zh-CN': '详细用法参考如下示例', 'en-US': 'For details, see the following example.' },
+      'name': { 'zh-CN': '尺寸', 'en-US': 'medium Size' },
+      'desc': {
+        'zh-CN': '通过修改 size 的属性值可调整输入框尺寸，提供 medium、small、mini三个固定属性值。',
+        'en-US': 'For details, see the following example.'
+      },
       'codeFiles': ['size-medium.vue']
     },
     {
       'demoId': 'focus',
       'name': { 'zh-CN': '手动获取焦点', 'en-US': 'Manually obtaining the focus' },
-      'desc': { 'zh-CN': '详细用法参考如下示例', 'en-US': 'For details, see the following example.' },
+      'desc': {
+        'zh-CN': '通过给组件设置 ref 手动调用触发 focus 事件。',
+        'en-US': 'For details, see the following example.'
+      },
       'codeFiles': ['focus.vue']
     }
   ],
@@ -126,9 +105,9 @@ export default {
         {
           'name': 'modelValue / v-model',
           'type': 'date(DatePicker) / array(DateRangePicker)',
-          'defaultValue': '日期选择器选中的日期值，可设置选择器的初始值',
+          'defaultValue': '',
           'desc': {
-            'zh-CN': '绑定值',
+            'zh-CN': '日期选择器选中的日期值，可设置选择器的初始值',
             'en-US': 'Date value selected by the date selector. You can set the initial value of the selector.'
           },
           'demoId': 'basic-usage'
@@ -136,55 +115,55 @@ export default {
         {
           'name': 'disabled',
           'type': 'boolean',
-          'defaultValue': '该属性的默认值为 false',
-          'desc': { 'zh-CN': '禁用', 'en-US': 'Disabled' },
-          'demoId': 'disabled'
+          'defaultValue': ' false',
+          'desc': { 'zh-CN': '时间选择器是否禁用', 'en-US': 'Disabled' },
+          'demoId': ''
         },
         {
           'name': 'editable',
           'type': 'boolean',
-          'defaultValue': '该属性的默认值为 true',
-          'desc': { 'zh-CN': '文本框可输入', 'en-US': 'The text box can be entered.' },
-          'demoId': 'basic-usage'
+          'defaultValue': ' true',
+          'desc': { 'zh-CN': '文本框是否可手动输入', 'en-US': 'The text box can be entered.' },
+          'demoId': 'editable'
         },
         {
           'name': 'clearable',
           'type': 'boolean',
-          'defaultValue': '该属性的默认值为 true',
-          'desc': { 'zh-CN': '是否显示清除按钮', 'en-US': 'Display Clear Button' },
+          'defaultValue': ' true',
+          'desc': { 'zh-CN': '清除按钮是否显示', 'en-US': 'Display Clear Button' },
           'demoId': 'clear-icon'
         },
         {
           'name': 'size',
           'type': 'string',
-          'defaultValue': '',
+          'defaultValue': '--',
           'desc': {
-            'zh-CN': '输入框尺寸;该属性的可选值为 medium,small, mini',
+            'zh-CN': '输入框尺寸;该属性的可选值为 medium、small、mini',
             'en-US': 'Text box size; The values of this attribute are medium, small, and mini'
           },
-          'demoId': 'size-mini'
+          'demoId': 'size-medium'
         },
         {
           'name': 'placeholder',
           'type': 'string',
-          'defaultValue': '该属性的默认值为空',
-          'desc': { 'zh-CN': '非范围选择时的占位内容', 'en-US': 'Placeholder content for non-range selection' },
+          'defaultValue': '--',
+          'desc': { 'zh-CN': '输入框的提示占位内容', 'en-US': 'Placeholder content for non-range selection' },
           'demoId': 'basic-usage'
         },
         {
           'name': 'popper-class',
           'type': 'string',
-          'defaultValue': '',
+          'defaultValue': '--',
           'desc': {
             'zh-CN': 'TimePicker 下拉框的 class 类名',
             'en-US': 'Class name of the TimePicker drop-down list box'
           },
-          'demoId': 'popper-class'
+          'demoId': ''
         },
         {
           'name': 'picker-options',
           'type': 'object',
-          'defaultValue': '该属性的默认值为 {}',
+          'defaultValue': '{}',
           'desc': {
             'zh-CN': '当前时间日期选择器特有的选项参考下表',
             'en-US': 'The following table lists the options of the current time and date selector.'
@@ -194,7 +173,7 @@ export default {
         {
           'name': 'default-value',
           'type': 'Date',
-          'defaultValue': '',
+          'defaultValue': '--',
           'desc': {
             'zh-CN': '可选，当选中的日期值为空时，选择器面板打开时默认显示的时间，需设置为可被new Date()解析的值',
             'en-US':
@@ -205,28 +184,28 @@ export default {
         {
           'name': 'name',
           'type': 'string',
-          'defaultValue': '',
+          'defaultValue': '--',
           'desc': { 'zh-CN': '原生属性', 'en-US': 'Native attribute' },
-          'demoId': 'name'
+          'demoId': 'clear-icon'
         },
         {
           'name': 'suffix-icon',
           'type': 'string',
-          'defaultValue': '该自定后置图标，该属性的默认值为 IconCalendar',
+          'defaultValue': 'IconCalendar',
           'desc': { 'zh-CN': '自定义头部图标', 'en-US': 'Custom header icon' },
           'demoId': 'suffix-icon'
         },
         {
           'name': 'clear-icon',
           'type': 'string',
-          'defaultValue': '该属性的默认值为 IconOperationfaild',
+          'defaultValue': 'IconOperationfaild',
           'desc': { 'zh-CN': '自定义清空图标', 'en-US': 'Customized clear icon' },
           'demoId': 'clear-icon'
         },
         {
           'name': 'popper-append-to-body',
           'type': 'boolean',
-          'defaultValue': '该属性的默认值为 true',
+          'defaultValue': 'true',
           'desc': {
             'zh-CN': '是否将弹出框插入至 body 元素。在弹出框的定位出现问题时，可将该属性设置为 false',
             'en-US':
@@ -238,17 +217,17 @@ export default {
       'events': [
         {
           'name': 'change',
-          'type': '',
+          'type': '(value: string) => void',
           'defaultValue': '',
           'desc': {
-            'zh-CN': '用户确认选定的值时触发',
+            'zh-CN': '当 input 绑定的值发生改变时触发',
             'en-US': 'This event is triggered when the user confirms the selected value.'
           },
           'demoId': 'event-blur'
         },
         {
           'name': 'blur',
-          'type': '',
+          'type': '( ) => void',
           'defaultValue': '',
           'desc': {
             'zh-CN': '当 input 失去焦点时触发',
@@ -258,7 +237,7 @@ export default {
         },
         {
           'name': 'focus',
-          'type': '',
+          'type': '( ) => void',
           'defaultValue': '',
           'desc': { 'zh-CN': '当 input 获得焦点时触发', 'en-US': 'This event is triggered when the input is focused.' },
           'demoId': 'event-blur'
@@ -267,8 +246,8 @@ export default {
       'slots': [],
       'methods': [
         {
-          'name': 'focus',
-          'type': '',
+          'name': 'handleFocus',
+          'type': '( ) => void',
           'defaultValue': '',
           'desc': { 'zh-CN': '使 input 获取焦点', 'en-US': 'Enable input to focus.' },
           'demoId': 'focus'

package/demos/pc/app/toggle-menu/webdoc/toggle-menu.js

@@ -310,9 +310,9 @@ export default {
           'defaultValue': '',
           'desc': {
             'zh-CN':
-              '展开节点后的事件。;节点被展开时触发的事件;//参数arg1:\n{children: 点击节点的子节点, id: 点击节点的id, label: 点击节点的title}\n//参数arg2:\nVueComponent 点击节点的componet对象信息\n//参数arg3:\n{ children: 点击节点的子节点id: 点击节点的id, label: 点击节点的title}',
+              '展开节点后的事件。;节点被展开时触发的事件;//参数arg1:\n{children: 点击节点的子节点, id: 点击节点的id, label: 点击节点的title}\n//参数arg2:\nComponent 点击节点的componet对象信息\n//参数arg3:\n{ children: 点击节点的子节点id: 点击节点的id, label: 点击节点的title}',
             'en-US':
-              'Event after a node is expanded. ; Event triggered when a node is expanded; / / Parameter arg1:\n{children: child node of the clicked node, id: ID of the clicked node, label: title of the clicked node}\n//Parameter arg2:\nVueComponent Componet object information of the clicked node\n//Parameter arg3:\n{children: subnode ID of the clicked node: ID of the clicked node, label: Click title} of the node'
+              'Event after a node is expanded. ; Event triggered when a node is expanded; / / Parameter arg1:\n{children: child node of the clicked node, id: ID of the clicked node, label: title of the clicked node}\n//Parameter arg2:\nComponent Componet object information of the clicked node\n//Parameter arg3:\n{children: subnode ID of the clicked node: ID of the clicked node, label: Click title} of the node'
           },
           'demoId': 'node-expand'
         },

package/demos/pc/app/transfer/basic-usage.spec.ts

@@ -1,6 +1,6 @@
 import { test, expect } from '@playwright/test'
 
-test('基本用法', async ({ page }) => {
+test('测试基本用法', async ({ page }) => {
   page.on('pageerror', (exception) => expect(exception).toBeNull())
   await page.goto('transfer#basic-usage')
   const preview = page.locator('.pc-demo-container')

package/demos/pc/app/transfer/before-transfer.spec.ts

@@ -1,6 +1,6 @@
 import { test, expect } from '@playwright/test'
 
-test('基本用法', async ({ page }) => {
+test('测试穿梭拦截的功能', async ({ page }) => {
   page.on('pageerror', (exception) => expect(exception).toBeNull())
   await page.goto('transfer#basic-usage')
   const preview = page.locator('.pc-demo-container')

package/demos/pc/app/transfer/custom-btns.spec.ts

@@ -1,6 +1,6 @@
 import { test, expect } from '@playwright/test'
 
-test('自定义按钮测试', async ({ page }) => {
+test('测试自定义按钮的文字', async ({ page }) => {
   page.on('pageerror', (exception) => expect(exception).toBeNull())
   await page.goto('transfer#custom-btns')
 

package/demos/pc/app/transfer/custom-filter.spec.ts

@@ -1,6 +1,6 @@
 import { test, expect } from '@playwright/test'
 
-test('自定义过滤方法', async ({ page }) => {
+test('测试自定义过滤方法', async ({ page }) => {
   page.on('pageerror', (exception) => expect(exception).toBeNull())
   await page.goto('transfer#custom-filter')
 

package/demos/pc/app/transfer/custom-footer.spec.ts

@@ -1,7 +1,8 @@
 import { test, expect } from '@playwright/test'
 
-test('自定义列表底部', async ({ page }) => {
+test('测试自定义列表底部', async ({ page }) => {
   page.on('pageerror', (exception) => expect(exception).toBeNull())
   await page.goto('transfer#custom-footer')
+
   await expect(page.getByRole('button', { name: '操作' })).toHaveCount(2)
 })

package/demos/pc/app/transfer/custom-render.spec.ts

@@ -1,6 +1,6 @@
 import { test, expect } from '@playwright/test'
 
-test('判断是否可以选中自定义数据项', async ({ page }) => {
+test('测试是否可以选中自定义数据项', async ({ page }) => {
   page.on('pageerror', (exception) => expect(exception).toBeNull())
   await page.goto('transfer#custom-render')
 

package/demos/pc/app/transfer/custom-titles.spec.ts

@@ -1,6 +1,6 @@
 import { test, expect } from '@playwright/test'
 
-test('自定义列表标题', async ({ page }) => {
+test('测试自定义列表标题', async ({ page }) => {
   page.on('pageerror', (exception) => expect(exception).toBeNull())
   await page.goto('transfer#custom-titles')
   const preview = page.locator('.pc-demo-container')

package/demos/pc/app/transfer/default-checked.spec.ts

@@ -1,6 +1,6 @@
 import { test, expect } from '@playwright/test'
 
-test('判断面板是否有默认勾选项', async ({ page }) => {
+test('测试面板的默认勾选项', async ({ page }) => {
   page.on('pageerror', (exception) => expect(exception).toBeNull())
   await page.goto('transfer#default-checked')
 

package/demos/pc/app/transfer/drop-config.spec.ts

@@ -1,6 +1,6 @@
 import { test, expect } from '@playwright/test'
 
-test('尝试拖拽', async ({ page }) => {
+test('测试可拖拽功能', async ({ page }) => {
   page.on('pageerror', (exception) => expect(exception).toBeNull())
   await page.goto('transfer#drop-config')
   const preview = page.locator('.pc-demo-container')

package/demos/pc/app/transfer/nested-table.spec.ts

@@ -1,6 +1,6 @@
 import { test, expect } from '@playwright/test'
 
-test('判断数据交换', async ({ page }) => {
+test('测试嵌套表格', async ({ page }) => {
   page.on('pageerror', (exception) => expect(exception).toBeNull())
   await page.goto('transfer#nested-table')
   const preview = page.locator('.pc-demo-container')

package/demos/pc/app/transfer/nested-tree.spec.ts

@@ -1,6 +1,6 @@
 import { test, expect } from '@playwright/test'
 
-test('嵌套树', async ({ page }) => {
+test('测试嵌套树', async ({ page }) => {
   page.on('pageerror', (exception) => expect(exception).toBeNull())
   await page.goto('transfer#nested-tree')
   const preview = page.locator('.pc-demo-container')

package/demos/pc/app/transfer/target-order.spec.ts

@@ -1,6 +1,6 @@
 import { test, expect } from '@playwright/test'
 
-test('判断交换左侧备选项后是否位于右侧面板首位', async ({ page }) => {
+test('测试排序策略', async ({ page }) => {
   page.on('pageerror', (exception) => expect(exception).toBeNull())
   await page.goto('transfer#target-order')
   const preview = page.locator('.pc-demo-container')

package/demos/pc/app/transfer/transfer-events.spec.ts

@@ -1,6 +1,6 @@
 import { test, expect } from '@playwright/test'
 
-test('判断是否触发了不同事件', async ({ page }) => {
+test('测试事件', async ({ page }) => {
   page.on('pageerror', (exception) => expect(exception).toBeNull())
   await page.goto('transfer#transfer-events')
   const preview = page.locator('.pc-demo-container')

package/demos/pc/app/transfer/webdoc/transfer.cn.md

@@ -4,4 +4,4 @@ title: Transfer 穿梭框
 
 # Transfer 穿梭框
 
-<div>穿梭框，实现2个表格数据的双向交换的组件。</div>
+<div>穿梭框，实现左右表格数据的双向交换的组件。</div>

package/demos/pc/app/transfer/webdoc/transfer.en.md

@@ -1,7 +1,7 @@
 ---
-title: Transfer shuttle box
+title: Transfer
 ---
 
-# Transfer shuttle box
+# Transfer
 
-<div>Shuttle box, a component that realizes the two-way exchange of data between two tables.</div>
+<div>Transfer realizes the two-way exchange of data between two tables.</div>