@opentiny/vue-docs 2.2.7 → 2.2.9

package/demos/pc/app/transfer/webdoc/transfer.js

@@ -213,24 +213,30 @@ export default {
           'name': 'filterable',
           'type': 'boolean',
           'defaultValue': 'false',
-          'desc': { 'zh-CN': '是否可搜索', 'en-US': 'Filterable or not' },
+          'desc': {
+            'zh-CN': '是否启用搜索的功能',
+            'en-US': 'Whether to enable the search function'
+          },
           'demoId': 'custom-filter'
         },
         {
           'name': 'filter-placeholder',
           'type': 'string',
           'defaultValue': '',
-          'desc': { 'zh-CN': '搜索框占位符', 'en-US': 'Search box placeholder' },
+          'desc': {
+            'zh-CN': '启用搜索时，搜索框占位符',
+            'en-US': "When Search, filter box's placeholder"
+          },
           'demoId': 'custom-filter'
         },
         {
           'name': 'filter-method',
-          'type': '(query:string ,  item:object) => boolean',
+          'type': '(query:string, item:object) => boolean',
           'defaultValue': '',
           'desc': {
             'zh-CN': `
-              设置穿梭框的搜索过滤函数，仅在默认列表和嵌套表时有效; <br>
-              嵌套树时，请使用treeConfig进行搜索配置;<br> 
+              设置穿梭框的搜索过滤函数，仅在默认列表和嵌套表时有效。<br>
+              嵌套树时，请使用treeConfig进行搜索配置。<br> 
             `,
             'en-US': `
               Set the search filter function for the transfer to work only for default lists and nested tables. <br>
@@ -245,9 +251,9 @@ export default {
           'defaultValue': '[]',
           'desc': {
             'zh-CN':
-              '自定义列表标题;不设置titles时，左右列表的标题默认显示为： <code> 列表 1</code><code> 列表 2</code>',
+              '自定义列表的标题;不设置titles时，左右列表的标题默认显示为： <code> 列表 1</code>，<code> 列表 2</code>',
             'en-US':
-              'Custom list titles When titles are not set, the titles of the left and right lists are displayed by default: <code> list 1</code><code> list 2</code>'
+              'Custom list titles When titles are not set, the titles of the left and right lists are displayed by default: <code> list 1</code>,<code> list 2</code>'
           },
           'demoId': 'custom-titles'
         },
@@ -255,7 +261,11 @@ export default {
           'name': 'button-texts',
           'type': 'string[]',
           'defaultValue': '[]',
-          'desc': { 'zh-CN': '自定义按钮文案', 'en-US': 'Custom Button Text' },
+          'desc': {
+            'zh-CN': '通过传入一个2值的字符串数组，自定义左右穿梭按钮的文案',
+            'en-US':
+              'Customize the copy of the left and right shuttle button by passing in an array of 2-valued strings'
+          },
           'demoId': 'custom-btns'
         },
         {
@@ -263,8 +273,8 @@ export default {
           'type': '(h: Vue.h, item: any) => vnode',
           'defaultValue': '',
           'desc': {
-            'zh-CN': '自定义数据项渲染函数',
-            'en-US': 'Custom data item rendering function; Its type is declared as: (h, item) => vnode'
+            'zh-CN': '数据项的自定义渲染函数',
+            'en-US': 'Custom data item rendering function'
           },
           'demoId': 'custom-render'
         },
@@ -273,8 +283,11 @@ export default {
           'type': 'object',
           'defaultValue':
             // eslint-disable-next-line no-template-curly-in-string
-            "{ <br>&nbsp; noChecked:'${checked}/${total}', <br>&nbsp; hasChecked: '${checked}/${total}' <br>}",
-          'desc': { 'zh-CN': '列表顶部勾选状态文案', 'en-US': 'Check the status copy at the top of the list' },
+            "{ <br>&nbsp;&nbsp; noChecked:'${checked}/${total}', <br>&nbsp;&nbsp; hasChecked: '${checked}/${total}' <br>}",
+          'desc': {
+            'zh-CN': '列表顶部勾选状态文案',
+            'en-US': 'Check the status copy at the top of the list'
+          },
           'demoId': 'custom-titles'
         },
         {
@@ -292,8 +305,8 @@ export default {
           'type': 'string[]',
           'defaultValue': '[]',
           'desc': {
-            'zh-CN': '初始状态下左侧列表的已勾选项的 key 数组',
-            'en-US': 'Initially, the key array of the checked items in the left list'
+            'zh-CN': '默认左侧列表的已勾选项的 key 数组',
+            'en-US': 'The key array of the checked items in the left list'
           },
           'demoId': 'default-checked'
         },
@@ -302,8 +315,8 @@ export default {
           'type': 'string[]',
           'defaultValue': '[]',
           'desc': {
-            'zh-CN': '初始状态下右侧列表的已勾选项的 key 数组',
-            'en-US': 'Initially, the key array of the checked items in the right list'
+            'zh-CN': '默认右侧列表的已勾选项的 key 数组',
+            'en-US': 'The key array of the checked items in the right list'
           },
           'demoId': 'default-checked'
         },
@@ -312,13 +325,13 @@ export default {
           'type': 'string',
           'defaultValue': '"original"',
           'desc': {
-            'zh-CN': ` 右侧列表元素的插入排序策略,该属性的可选值为 original / push / unshift;<br>
-                &nbsp; 若为 original，则保持与数据源相同的顺序；<br>
-                &nbsp; 若为 push，则新加入的元素排在最后；<br>
-                &nbsp; 若为 unshift，则新加入的元素排在最前;`,
-            'en-US': `The insertion sort strategy for the elements in the list on the right, with the optional values original/push/unshift; <br>
-                &nbsp;  If original, it maintains the same order as the data source. <br>
-                &nbsp;  If it is a push, the new element is listed last. <br>
+            'zh-CN': ` 右侧列表元素的插入排序策略,该属性的可选值为 original / push / unshift; <br>
+                &nbsp; 若为 original，则保持与数据源相同的顺序； <br>
+                &nbsp; 若为 push，则新加入的元素排在最后； <br>
+                &nbsp; 若为 unshift，则新加入的元素排在最前。`,
+            'en-US': `The insertion sort strategy for the elements in the list on the right, with the optional values original/push/unshift;<br>
+                &nbsp;  If original, it maintains the same order as the data source.<br>
+                &nbsp;  If it is a push, the new element is listed last.<br>
                 &nbsp;  If unshift is used, the new element is listed first.
               `
           },
@@ -348,7 +361,10 @@ export default {
           'name': 'show-all-btn',
           'type': 'boolean',
           'defaultValue': 'false',
-          'desc': { 'zh-CN': '是否展示全部移动按钮', 'en-US': 'Whether to show all move buttons' },
+          'desc': {
+            'zh-CN': '是否显示全部移动按钮',
+            'en-US': 'Whether to show all move buttons'
+          },
           'demoId': 'custom-btns'
         },
         {
@@ -357,8 +373,8 @@ export default {
           'typeAnchorName': 'IDropConfig',
           'defaultValue': '',
           'desc': {
-            'zh-CN': '设置穿梭框列表项可拖拽',
-            'en-US': 'Make the transfer list item draggable'
+            'zh-CN': '设置穿梭框列表项可拖拽的参数，参见sortablejs插件',
+            'en-US': 'To set drag-and-drop parameters for shuttle list items, see sortablejs plugin'
           },
           'demoId': 'drop-config'
         },
@@ -368,7 +384,7 @@ export default {
           'typeAnchorName': 'grid#IColumnConfig',
           'defaultValue': '',
           'desc': {
-            'zh-CN': '在渲染类型为 table 时，设置穿梭框的表格列配置',
+            'zh-CN': '在渲染类型为 table 时，设置穿梭框表格的列配置',
             'en-US': `When the render type is table, set the transfer's table column configuration`
           },
           'demoId': 'nested-table'
@@ -378,7 +394,7 @@ export default {
           'type': 'boolean',
           'defaultValue': 'false',
           'desc': {
-            'zh-CN': '在渲染类型为 table 时，设置是否显示分页',
+            'zh-CN': '在渲染类型为 table 时，设置表格是否显示分页',
             'en-US': 'Sets whether pagination should be displayed when the render type is table.'
           },
           'demoId': 'nested-table'
@@ -389,7 +405,7 @@ export default {
           'typeAnchorName': 'IPagerOp',
           'defaultValue': "{ mode: 'fixed',pageVO: {currentPage: 1,pageSize: 10}",
           'desc': {
-            'zh-CN': '在渲染类型为 table 时，设置分页配置',
+            'zh-CN': '在渲染类型为 table 时，设置表格的分页配置',
             'en-US': 'When the render type is table, set the paging configuration'
           },
           'demoId': 'nested-table'
@@ -400,9 +416,9 @@ export default {
           'defaultValue': '',
           'desc': {
             'zh-CN':
-              '设置左右区域的渲染类型,Table 和 Tree 对象需要从组件包中引入相应的组件变量。该属性值的plugin设置为Table时设置渲染为表格;该属性值的pluginplugin设置为Tree渲染为树',
+              '设置左右区域的渲染类型,Table 和 Tree 对象需要从组件包中引入相应的组件变量。<br>该属性值的plugin设置为Table时设置渲染为表格;该属性值的pluginplugin设置为Tree渲染为树',
             'en-US':
-              'Sets the rendering type for the left and right regions. This property renders to a Table when plugin is set to table; The value of the pluginplugin set to Tree renders as a tree'
+              'Sets the rendering type for the left and right regions. <br>This property renders to a Table when plugin is set to table; The value of the pluginplugin set to Tree renders as a tree'
           },
           'demoId': 'nested-table'
         },
@@ -424,7 +440,7 @@ export default {
           'type': '(value:string[], move:string, keyArray:string[])=>void',
           'defaultValue': '',
           'desc': {
-            'zh-CN': `右侧列表元素变化时触发;<br>
+            'zh-CN': `右侧列表元素变化时触发的事件;<br>
                 value: 穿梭框右侧数据值列表<br>
                 move: 数据移动方向，是left或者right<br>
                 keyArray: 被移动的数据值列表`,
@@ -441,7 +457,7 @@ export default {
           'type': '(checked:string[], statusChanged:string[]) => void',
           'defaultValue': '',
           'desc': {
-            'zh-CN': `左侧列表元素被用户选中 / 取消选中时触发;<br>
+            'zh-CN': `左侧列表元素选择时触发的事件;<br>
               checked: 穿梭框左侧被选中的数据值列表<br>
               statusChanged: 穿梭框左侧选中状态发生变化的数据值列表`,
             'en-US': `Triggered when an element in the left list is selected/unselected by the user. <br>
@@ -455,7 +471,7 @@ export default {
           'type': '(checked:string[], statusChanged:string[]) => void',
           'defaultValue': '',
           'desc': {
-            'zh-CN': `右侧列表元素被用户选中 / 取消选中时触发;<br>
+            'zh-CN': `右侧列表元素选择时触发的事件;<br>
               checked: 穿梭框右侧被选中的数据值列表<br>
               statusChanged: 穿梭框右侧选中状态发生变化的数据值列表`,
             'en-US': `Triggered when an element in the list on the right is selected/unselected by the user <br>
@@ -480,35 +496,50 @@ export default {
           'name': 'left-footer',
           'type': '',
           'defaultValue': '',
-          'desc': { 'zh-CN': '左侧列表底部的内容插槽', 'en-US': 'Content at the bottom of the left list' },
+          'desc': {
+            'zh-CN': '左侧列表底部的内容插槽',
+            'en-US': 'Content at the bottom of the left list'
+          },
           'demoId': 'custom-footer'
         },
         {
           'name': 'right-footer',
           'type': '',
           'defaultValue': '',
-          'desc': { 'zh-CN': '右侧列表底部的内容插槽', 'en-US': 'Content at the bottom of the right list' },
+          'desc': {
+            'zh-CN': '右侧列表底部的内容插槽',
+            'en-US': 'Content at the bottom of the right list'
+          },
           'demoId': 'custom-footer'
         },
         {
           'name': 'button-panel',
           'type': '',
           'defaultValue': '',
-          'desc': { 'zh-CN': '穿梭按钮插槽', 'en-US': 'Customized transfer button' },
+          'desc': {
+            'zh-CN': '穿梭按钮插槽',
+            'en-US': 'Customized transfer button'
+          },
           'demoId': ''
         },
         {
           'name': 'left-panel',
           'type': '',
           'defaultValue': '',
-          'desc': { 'zh-CN': '左侧自定义内容插槽', 'en-US': 'Customized content on the left' },
+          'desc': {
+            'zh-CN': '左侧自定义内容插槽',
+            'en-US': 'Customized content on the left'
+          },
           'demoId': ''
         },
         {
           'name': 'right-panel',
           'type': '',
           'defaultValue': '',
-          'desc': { 'zh-CN': '右侧自定义内容插槽', 'en-US': 'Customized content on the right' },
+          'desc': {
+            'zh-CN': '右侧自定义内容插槽',
+            'en-US': 'Customized content on the right'
+          },
           'demoId': ''
         }
       ],
@@ -517,7 +548,10 @@ export default {
           'name': 'clearQuery',
           'type': '(name: string) => void',
           'defaultValue': '',
-          'desc': { 'zh-CN': '清空某个面板的搜索关键词', 'en-US': 'Clear the search keywords of a panel.' },
+          'desc': {
+            'zh-CN': '开启过滤功能时，清空左右面板的搜索关键词',
+            'en-US': 'When the filtering function is enabled, clear the search keywords on the left and right panels'
+          },
           'demoId': 'custom-filter'
         }
       ]
@@ -529,7 +563,7 @@ export default {
       type: 'interface',
       code: `
 interface IDropConfig {
-  plugin: object // 指定拖放排序的插件， 一般是通过 import Sortable from 'sortablejs' 导入
+  plugin: object // 指定拖放排序的插件Sortable, 该变量通过 import Sortable from 'sortablejs' 导入
 }
       `
     },
@@ -544,8 +578,7 @@ interface IPagerOp {
     currentPage: number
     pageSize: number
     pageSizes: number[]
-    // 分页组件布局默认值：'total, prev, pager, next, jumper, sizes'
-    layout: string 
+    layout: string   // 分页组件布局默认值：'total, prev, pager, next, jumper, sizes'
   }
 }
       `

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

@@ -1,6 +1,6 @@
 import { test, expect } from '@playwright/test'
 
-test('tree组件基本使用', async ({ page }) => {
+test('测试基本使用', async ({ page }) => {
   page.on('pageerror', (exception) => expect(exception).toBeNull())
   await page.goto('tree#basic-usage')
 

package/demos/pc/app/tree/check-op.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('tree#check-op')
 

package/demos/pc/app/tree/checkbox.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('tree#checkbox')
 

package/demos/pc/app/tree/contextmenu.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('tree#contextmenu')
 

package/demos/pc/app/tree/drag.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('tree#drag')
 

package/demos/pc/app/tree/edit.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('tree#edit')
 

package/demos/pc/app/tree/expand-control.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('tree#expand-control')
 

package/demos/pc/app/tree/filter-view.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('tree#filter-view')
 

package/demos/pc/app/tree/icons.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('tree#icons')
 

package/demos/pc/app/tree/lazy.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('tree#lazy')
 

package/demos/pc/app/tree/node-hl.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('tree#node-hl')
 

package/demos/pc/app/tree/node-op.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('tree#node-op')
 

package/demos/pc/app/tree/other.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('tree#other')
 

package/demos/pc/app/tree/props.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('tree#props')
 

package/demos/pc/app/tree/radio.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('tree#radio')
 

package/demos/pc/app/tree/slot.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('tree#slot')
 

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

@@ -4,4 +4,4 @@ title: Tree 树形控件
 
 # Tree 树形控件
 
-<div>可进行展示有父子层级的数据，支持选择，异步加载等功能。</div>
+<div>可进行展示有父子层级的数据，支持选择，懒加载，拖拽和编辑节点等功能。</div>

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

@@ -4,4 +4,4 @@ title: Tree control
 
 # Tree control
 
-<div>Data with parent and child levels can be displayed. Functions such as selection and asynchronous loading are supported.</div>
+<div>Can display parent-child level data, support selection, lazy loading, drag and drop and edit nodes and other functions.</div>