@opentiny/vue-docs 2.1.8 → 2.1.9

package/demos/mobile-first/app/standard-list-item/webdoc/standard-list-item.js

@@ -11,7 +11,7 @@ export default {
       desc: {
         'zh-CN':
           '<p>通过设置`:show-image="true"`可以显示图片区域<br>`user-head` 属性可以配置头像的类型、大小、背景色等，具体可查看 UserHead 用户头像组件的属性配置<br>传入`icon` 属性可以将头像区域替换为 icon 图标</p>',
-        'en-US': '<p>button type</p>'
+        'en-US': '<p>You can set `:show-image="true"` to display the image area.<br>The `user-head` attribute can be used to configure the avatar type, size, and background color. For details, see the attribute configuration of the UserHead avatar component. <br>The `icon` attribute can be transferred to replace the avatar area with an icon.</p>'
       },
       codeFiles: ['basic-usage.vue']
     },
@@ -20,11 +20,11 @@ export default {
       demoId: 'type',
       name: {
         'zh-CN': '设置类型',
-        'en-US': 'events'
+        'en-US': 'Setting Type'
       },
       desc: {
-        'zh-CN': '<p>通过 `type` 属性可以设置标准列表项的模式，支持 card 和 list 两种模式。<p>',
-        'en-US': '<p>bbutton click</p>'
+        'zh-CN': '<p>通过 `type` 属性可以设置标准列表项的模式，支持 card 和 list 两种模式。</p>',
+        'en-US': '<p>You can use the `type` attribute to set the mode of a standard list item. The card and list modes are supported.</p>'
       },
       codeFiles: ['type.vue']
     },
@@ -32,11 +32,11 @@ export default {
       demoId: 'content-slot',
       name: {
         'zh-CN': '内容区插槽',
-        'en-US': 'events'
+        'en-US': 'Content Area Slot'
       },
       desc: {
-        'zh-CN': '<p>通过 `#default` 可以设置内容区插槽，`#tag` 可以设置标签插槽。<p>',
-        'en-US': '<p>bbutton click</p>'
+        'zh-CN': '<p>通过 `#default` 可以设置内容区插槽，`#tag` 可以设置标签插槽。</p>',
+        'en-US': '<p>You can use `#default` to set the content area slot and `#tag` to set the label slot.</p>'
       },
       codeFiles: ['content-slot.vue']
     },
@@ -44,11 +44,11 @@ export default {
       demoId: 'icon-click-event',
       name: {
         'zh-CN': '操作列按钮点击事件',
-        'en-US': 'events'
+        'en-US': 'Clicking a button in the operation column'
       },
       desc: {
-        'zh-CN': '<p>通过 `icon-click` 给按钮加点击事件。<p>',
-        'en-US': '<p>bbutton click</p>'
+        'zh-CN': '<p>通过 `icon-click` 给按钮加点击事件。</p>',
+        'en-US': '<p>Add a click event to a button through `icon-click`.</p>'
       },
       codeFiles: ['icon-click-event.vue']
     },
@@ -56,11 +56,11 @@ export default {
       demoId: 'icon-disabled',
       name: {
         'zh-CN': '操作列按钮隐藏与禁用',
-        'en-US': 'events'
+        'en-US': 'Hide or Disable Buttons in the Operation Column'
       },
       desc: {
-        'zh-CN': '<p>操作列配置项 `options` 中添加属性 hidden 可以隐藏按钮，可以通过 disabled 属性禁用操作按钮。<p>',
-        'en-US': '<p>bbutton click</p>'
+        'zh-CN': '<p>操作列配置项 `options` 中添加属性 hidden 可以隐藏按钮，可以通过 disabled 属性禁用操作按钮。</p>',
+        'en-US': '<p>The hidden attribute is added to the `options` configuration item in the Operation column to hide the button. The disabled attribute can be used to disable the operation button.</p>'
       },
       codeFiles: ['icon-disabled.vue']
     },
@@ -71,11 +71,167 @@ export default {
         'en-US': 'events'
       },
       desc: {
-        'zh-CN': '<p>通过 `#image` 可以设置头像插槽，通过 `#operate` 可以设置操作列插槽。<p>',
-        'en-US': '<p>bbutton click</p>'
+        'zh-CN': '<p>通过 `#image` 可以设置头像插槽，通过 `#operate` 可以设置操作列插槽。</p>',
+        'en-US': '<p>Avatar and Action Column Slots</p>'
       },
       codeFiles: ['image-operate-slot.vue']
     }
   ],
-  apis: []
+  apis: [
+    {
+      'name': 'StandardListItem',
+      'type': 'component',
+      'props': [
+        {
+          'name': 'data',
+          'type': 'Object',
+          'defaultValue': '',
+          'desc': {
+            'zh-CN': '列表数据源',
+            'en-US': 'List Data Sources'
+          },
+          'demoId': ''
+        },
+        {
+          'name': 'icon',
+          'type': 'Object',
+          'defaultValue': '',
+          'desc': {
+            'zh-CN': 'icon配置项',
+            'en-US': 'icon configuration item'
+          },
+          'demoId': ''
+        },
+        {
+          'name': 'icon-more',
+          'type': 'Object',
+          'defaultValue': '',
+          'desc': {
+            'zh-CN': '更多按钮图标，可传入一个svg图标对象进行替换',
+            'en-US': 'More button icons can be replaced by a svg icon object.'
+          },
+          'demoId': ''
+        },
+        {
+          'name': 'options',
+          'type': 'Array',
+          'defaultValue': '',
+          'desc': {
+            'zh-CN': '操作按钮配置项',
+            'en-US': 'Operation button configuration item'
+          },
+          'demoId': ''
+        },
+        {
+          'name': 'selected',
+          'type': 'Boolean',
+          'defaultValue': '',
+          'desc': {
+            'zh-CN': '是否选中列表项，为true表示选中列表项。',
+            'en-US': 'Indicates whether to select a list item. The value true indicates that a list item is selected.'
+          },
+          'demoId': ''
+        },
+        {
+          'name': 'show-image',
+          'type': 'Boolean',
+          'defaultValue': '',
+          'desc': {
+            'zh-CN': '显示图片',
+            'en-US': 'Show Pictures'
+          },
+          'demoId': ''
+        },
+        {
+          'name': 'tag',
+          'type': 'Object',
+          'defaultValue': '',
+          'desc': {
+            'zh-CN': '标签配置项',
+            'en-US': 'Label configuration items'
+          },
+          'demoId': ''
+        },
+        {
+          'name': 'title-option',
+          'type': 'Object',
+          'defaultValue': '',
+          'desc': {
+            'zh-CN': '标题配置项',
+            'en-US': 'Title configuration item'
+          },
+          'demoId': ''
+        },
+        {
+          'name': 'type',
+          'type': 'String',
+          'defaultValue': '',
+          'desc': {
+            'zh-CN': '类型，支持 card 和 list 两种模式',
+            'en-US': 'Indicates the type. The options are card and list.'
+          },
+          'demoId': 'type'
+        },
+        {
+          'name': 'user-head',
+          'type': 'Object',
+          'defaultValue': '',
+          'desc': {
+            'zh-CN': '用户头像配置项',
+            'en-US': 'User avatar configuration items'
+          },
+          'demoId': ''
+        }
+      ],
+      'events': [
+        {
+          'name': 'icon-click',
+          'type': 'Function()',
+          'defaultValue': '',
+          'desc': {
+            'zh-CN': '操作栏按钮点击事件',
+            'en-US': 'Operation bar button click event'
+          },
+          'demoId': 'icon-click-event'
+        }
+      ],
+      'slot': [
+        {
+          'name': 'default',
+          'type': '',
+          'defaultValue': '',
+          'desc': { 'zh-CN': '组件默认插槽', 'en-US': 'Component Default Slot' },
+          'demoId': 'content-slot'
+        },
+        {
+          'name': 'image',
+          'type': '',
+          'defaultValue': '',
+          'desc': { 'zh-CN': '图片插槽', 'en-US': 'Picture Slot' },
+          'demoId': 'image-operate-slot'
+        },
+        {
+          'name': 'operate',
+          'type': '',
+          'defaultValue': '',
+          'desc': { 'zh-CN': '操作栏插槽', 'en-US': 'Action Bar Slots' },
+          'demoId': 'image-operate-slot'
+        },
+        {
+          'name': 'tag',
+          'type': '',
+          'defaultValue': '',
+          'desc': { 'zh-CN': '标签插槽', 'en-US': 'Label Slot' },
+          'demoId': 'content-slot'
+        },
+        {
+          'name': 'title',
+          'type': '',
+          'defaultValue': '',
+          'desc': { 'zh-CN': '标题插槽', 'en-US': 'Header Slot' },
+          'demoId': ''
+        }
+      ],
+    },
+  ]
 }

package/demos/mobile-first/app/steps/webdoc/steps.js

@@ -6,11 +6,11 @@ export default {
       demoId: 'data-resource',
       name: {
         'zh-CN': '横向单链型',
-        'en-US': 'basic usage'
+        'en-US': 'transverse single-stranded type'
       },
       desc: {
         'zh-CN': '<p>默认显示横向单链型</p>',
-        'en-US': '<p>button type</p>'
+        'en-US': '<p>he horizontal single-chain type is displayed by default.</p>'
       },
       codeFiles: ['data-resource.vue']
     },
@@ -18,11 +18,12 @@ export default {
       demoId: 'vertical',
       name: {
         'zh-CN': '垂直单链型',
-        'en-US': 'button round'
+        'en-US': 'vertical single-stranded type'
       },
       desc: {
         'zh-CN': '<p>添加 `vertical` 属性开启垂直单链型，通过 `visible-num` 属性设置显示的节点数，默认为 5。</p>',
-        'en-US': '<p>button round</p>'
+        'en-US':
+          '<p>Add the `vertical` attribute to enable the vertical single-link mode. Use the `visible-num` attribute to set the number of nodes to be displayed. The default value is 5.</p>'
       },
       codeFiles: ['vertical.vue']
     },
@@ -30,11 +31,11 @@ export default {
       demoId: 'advanced-steps',
       name: {
         'zh-CN': '高级向导1',
-        'en-US': ''
+        'en-US': 'Advanced Wizard 1'
       },
       desc: {
-        'zh-CN': '<p>添加属性 `advanced` 启用高级向导功能。<p>',
-        'en-US': '<p>bbutton click</p>'
+        'zh-CN': '<p>添加属性 `advanced` 启用高级向导功能。</p>',
+        'en-US': '<p>Add the attribute `advanced` to enable the advanced wizard feature</p>'
       },
       codeFiles: ['advanced-steps.vue']
     },
@@ -42,11 +43,12 @@ export default {
       demoId: 'advanced-flex',
       name: {
         'zh-CN': '高级向导2',
-        'en-US': ''
+        'en-US': 'Advanced Wizard 2'
       },
       desc: {
-        'zh-CN': '<p>添加属性 `flex` 开启总宽度响应，节点等宽，撑满父容器，节点名称超出省略，默认值为 `false`。<p>',
-        'en-US': '<p>bbutton click</p>'
+        'zh-CN': '<p>添加属性 `flex` 开启总宽度响应，节点等宽，撑满父容器，节点名称超出省略，默认值为 `false`。</p>',
+        'en-US':
+          '<p>added attributes flex ,Enable the response to the total width. Nodes have the same width and are full of the parent container. If the node name exceeds the maximum, omit the node name. The default value is `false`</p>'
       },
       codeFiles: ['advanced-flex.vue']
     },
@@ -54,12 +56,13 @@ export default {
       demoId: 'advanced-no-arrow',
       name: {
         'zh-CN': '高级向导3',
-        'en-US': ''
+        'en-US': 'Advanced Wizard 3'
       },
       desc: {
         'zh-CN':
-          '<p>添加属性 `no-arrow` 隐藏左右箭头，在 PC 端按住 `shift+鼠标滚轮` 进行节点左右滚动，移动端触屏左右滑动即可。<p>',
-        'en-US': '<p>bbutton click</p>'
+          '<p>添加属性 `no-arrow` 隐藏左右箭头，在 PC 端按住 `shift+鼠标滚轮` 进行节点左右滚动，移动端触屏左右滑动即可。</p>',
+        'en-US':
+          '<p>Add the attribute `no-arrow` to hide the left and right arrows. On the PC, press and hold `shift+mouse wheel` to scroll the node left and right. On the mobile end, swipe left and right on the touch screen.</p>'
       },
       codeFiles: ['advanced-no-arrow.vue']
     },
@@ -68,11 +71,11 @@ export default {
       demoId: 'slot-item',
       name: {
         'zh-CN': '插槽1',
-        'en-US': ''
+        'en-US': 'slot 1'
       },
       desc: {
-        'zh-CN': '<p>`item` 节点插槽。<p>',
-        'en-US': '<p>bbutton click</p>'
+        'zh-CN': '<p>`item` 节点插槽。</p>',
+        'en-US': '<p>`item`Node Slot</p>'
       },
       codeFiles: ['slot-item.vue']
     },
@@ -80,11 +83,11 @@ export default {
       demoId: 'slot',
       name: {
         'zh-CN': '插槽2',
-        'en-US': ''
+        'en-US': 'slot 2'
       },
       desc: {
-        'zh-CN': '<p>`prefix` 前置插槽，仅开启 `advanced` 高级向导模式有效。<p>',
-        'en-US': '<p>bbutton click</p>'
+        'zh-CN': '<p>`prefix` 前置插槽，仅开启 `advanced` 高级向导模式有效。</p>',
+        'en-US': '<p>prefix` front slot, valid only when `advanced` advanced wizard mode is enabled</p>'
       },
       codeFiles: ['slot.vue']
     },
@@ -92,11 +95,12 @@ export default {
       demoId: 'slot-bottom',
       name: {
         'zh-CN': '插槽3',
-        'en-US': ''
+        'en-US': 'slot 3'
       },
       desc: {
-        'zh-CN': '<p>`block-bottom` 滚动块底部插槽，仅开启 `advanced` 高级向导模式有效。<p>',
-        'en-US': '<p>bbutton click</p>'
+        'zh-CN': '<p>`block-bottom` 滚动块底部插槽，仅开启 `advanced` 高级向导模式有效。</p>',
+        'en-US':
+          '<p>`block-bottom` scroll block bottom slot, valid only when `advanced` advanced wizard mode is enabled</p>'
       },
       codeFiles: ['slot-bottom.vue']
     },
@@ -105,12 +109,13 @@ export default {
       demoId: 'duration',
       name: {
         'zh-CN': '节点滚动时间',
-        'en-US': ''
+        'en-US': 'Node scrolling time'
       },
       desc: {
         'zh-CN':
-          '<p>`duration` 设置节点左右滚动的持续时间，默认值为 300（单位 ms），设置 0 则无滚动动画，仅开启 `advanced` 高级向导模式有效。<p>',
-        'en-US': '<p>bbutton click</p>'
+          '<p>`duration` 设置节点左右滚动的持续时间，默认值为 300（单位 ms），设置 0 则无滚动动画，仅开启 `advanced` 高级向导模式有效。</p>',
+        'en-US':
+          '<p>`duration` Sets the duration for scrolling left and right of a node. The default value is 300 (unit: ms). If this parameter is set to 0, there is no scrolling animation. This parameter is valid only when the advanced wizard mode is enabled.</p>'
       },
       codeFiles: ['duration.vue']
     },
@@ -119,14 +124,101 @@ export default {
       demoId: 'complicated',
       name: {
         'zh-CN': '综合示例',
-        'en-US': ''
+        'en-US': 'Comprehensive example'
       },
       desc: {
-        'zh-CN': '<p>综合示例<p>',
-        'en-US': '<p>bbutton click</p>'
+        'zh-CN': '<p>综合示例</p>',
+        'en-US': '<p>Comprehensive example</p>'
       },
       codeFiles: ['complicated.vue']
     }
   ],
-  apis: []
+  apis: [
+    {
+      'name': 'Steps',
+      'type': 'component',
+      'props': [
+        {
+          'name': 'advanced',
+          'type': 'Boolean',
+          'defaultValue': 'false',
+          'desc': { 'zh-CN': '是否开启高级向导模式', 'en-US': 'Enable Advanced Wizard Mode' },
+          'demoId': 'advanced-steps'
+        },
+        {
+          'name': 'description-field',
+          'type': 'String',
+          'defaultValue': 'description',
+          'desc': { 'zh-CN': '描述字段', 'en-US': 'Description field' }
+        },
+        {
+          'name': 'duration',
+          'type': 'Number',
+          'defaultValue': '300',
+          'desc': {
+            'zh-CN':
+              '设置节点左右滚动的持续时间，默认值为 300（单位 ms），设置 0 则无滚动动画，仅开启 advanced 高级向导模式有效',
+            'en-US':
+              'Duration for scrolling left and right of a node. The default value is 300 (unit: ms). If this parameter is set to 0, there is no scrolling animation. This parameter is valid only when the advanced wizard mode is enabled.'
+          },
+          'demoId': 'duration'
+        },
+        {
+          'name': 'no-arrow ',
+          'type': 'Boolean',
+          'defaultValue': '',
+          'desc': {
+            'zh-CN':
+              '添加属性 no-arrow 隐藏左右箭头，在 PC 端按住 shift+鼠标滚轮 进行节点左右滚动，移动端触屏左右滑动即可，仅开启 advanced 高级向导模式有效。',
+            'en-US':
+              'Add the no-arrow attribute to hide the left and right arrows. On the PC, press Shift and scroll the mouse wheel to scroll the node left and right. Swipe left and right on the touch screen of the mobile end. This function is valid only when the advanced wizard mode is enabled.'
+          },
+          'demoId': 'advanced-no-arrow'
+        },
+        {
+          'name': 'vertical',
+          'type': 'Boolean',
+          'defaultValue': 'false',
+          'desc': {
+            'zh-CN': '是否开启垂直单链型',
+            'en-US': 'Indicates whether to enable the vertical single chain mode.'
+          },
+          'demoId': 'vertical'
+        },
+        {
+          'name': 'visible-num',
+          'type': 'Number',
+          'defaultValue': '5',
+          'desc': {
+            'zh-CN': '显示模块数量，超出隐藏',
+            'en-US': 'Display the number of modules. The number of modules exceeds the hidden value'
+          },
+          'demoId': 'vertical'
+        }
+      ],
+      'slots': [
+        {
+          'name': 'block-bottom ',
+          'type': '',
+          'defaultValue': '',
+          'desc': {
+            'zh-CN': '滚动块底部插槽，仅开启 advanced 高级向导模式有效。',
+            'en-US':
+              'Slot at the bottom of the scroll block. This parameter is valid only when the advanced wizard mode is enabled.'
+          },
+          'demoId': 'slot-bottom'
+        },
+        {
+          'name': 'prefix ',
+          'type': '',
+          'defaultValue': '',
+          'desc': {
+            'zh-CN': '前置插槽，仅开启 advanced 高级向导模式有效。',
+            'en-US': 'Front slot, valid only when the advanced wizard mode is enabled.'
+          },
+          'demoId': 'slot'
+        }
+      ]
+    }
+  ]
 }