@opentiny/vue-docs 2.2.6 → 2.2.8

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

@@ -4,4 +4,4 @@ title: Dropdown drop-down list
 
 # Dropdown drop-down list
 
-> Can configure menu list, drop down when clicked or hovered, supports multi-level menus
+Can configure menu list, drop down when clicked or hovered, supports multi-level menus.

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

@@ -6,8 +6,8 @@ export default {
       'demoId': 'basic-usage',
       'name': { 'zh-CN': '基本用法', 'en-US': 'Basic Usage' },
       'desc': {
-        'zh-CN': '<p>使用 tiny-dropdown-item 定义菜单节点</p>\n',
-        'en-US': '<p>Define menu nodes using tiny-dropdown-item</p>\n'
+        'zh-CN': '<p>使用 tiny-dropdown-item 定义菜单节点。</p>\n',
+        'en-US': '<p>Define menu nodes using tiny-dropdown-item.</p>\n'
       },
       'codeFiles': ['basic-usage.vue']
     },
@@ -16,7 +16,8 @@ export default {
       'name': { 'zh-CN': '禁用', 'en-US': 'Disabled' },
       'desc': {
         'zh-CN': '<p>通过 <code>disabled</code> 属性设置 菜单 或者 菜单项 为禁用状态。</p>\n',
-        'en-US': 'The <p>Use the<code>disabled</code>attribute to set the menu or menu item to a disabled state. </p>\n'
+        'en-US':
+          'The <p>Use the <code>disabled</code> attribute to set the menu or menu item to a disabled state. </p>\n'
       },
       'codeFiles': ['disabled.vue']
     },
@@ -27,7 +28,7 @@ export default {
         'zh-CN':
           '<p>通过 <code>size</code> 属性可配置其他尺寸，可选值：<code>medium</code> / <code>small</code> / <code>mini</code>。</p>\n',
         'en-US':
-          '<p>Use the<code>size</code>attribute to configure other sizes, with optional values:<code>medium</code>/<code>small</code>/<code>mini</code>. </p>\n'
+          '<p>Use the <code>size</code> attribute to configure other sizes, with optional values: <code>medium</code> / <code>small</code> / <code>mini</code>. </p>\n'
       },
       'codeFiles': ['size.vue']
     },
@@ -49,7 +50,7 @@ export default {
         'zh-CN':
           '<p>通过 <code>split-button</code> 属性，设置下拉菜单显示为按钮类型。仅按钮类型时，支持 <code>type</code> 属性设置按钮状态。</p>\n',
         'en-US':
-          '<p>Set the drop-down menu to display as a button type through the<code>split button</code>attribute. When only button types are used, the<code>type</code>attribute setting button status is supported.</p>\n'
+          '<p>Set the drop-down menu to display as a button type through the <code>split-button</code> attribute. When only button types are used, the <code>type</code> attribute setting button status is supported.</p>\n'
       },
       'codeFiles': ['split-button.vue']
     },
@@ -60,7 +61,7 @@ export default {
         'zh-CN':
           '<p>通过 <code>trigger</code> 属性设置触发下拉的方式，默认为 <code>hover</code>。可选值为: <code>click</code> / <code>hover</code> 。</p>\n',
         'en-US':
-          '<p>By setting the<code>trigger</code>attribute to trigger a drop-down, the default is<code>hover</code>. The optional values are:<code>click</code>/<code>hover</code>.</p>\n'
+          '<p>By setting the <code>trigger</code> attribute to trigger a drop-down, the default is <code>hover</code>. The optional values are: <code>click</code> / <code>hover</code>.</p>\n'
       },
       'codeFiles': ['trigger.vue']
     },
@@ -70,7 +71,7 @@ export default {
       'desc': {
         'zh-CN': '通过 <p><code>tip</code> 属性设置提示信息，<code>tip-position</code> 属性设置提示信息的位置。</p>\n',
         'en-US':
-          '<p>Set the prompt information through the<p><code>tip</code>attribute, and set the position of the prompt information through the<code>tip position</code>attribute.</p>\n'
+          '<p>Set the prompt information through the <code>tip</code> attribute, and set the position of the prompt information through the <code>tip-position</code> attribute.</p>\n'
       },
       'codeFiles': ['tip.vue']
     },
@@ -81,7 +82,7 @@ export default {
         'zh-CN':
           '<p>通过 <code>visible-arrow</code> 属性设置下拉弹框是否显示箭头，默认不显示。<code>visible-arrow</code> 为 true 时显示箭头。</p>\n',
         'en-US':
-          '<p>Use the <code>visible arrow</code> attribute to set whether the drop-down pop-up box displays an arrow, which is not displayed by default< Show arrows when code>visible arrow</code>is true.</p>\n'
+          '<p>Use the <code>visible-arrow</code> attribute to set whether the drop-down pop-up box displays an arrow, which is not displayed by default show arrows when <code>visible-arrow</code> is true.</p>\n'
       },
       'codeFiles': ['visible-arrow.vue']
     },
@@ -92,7 +93,7 @@ export default {
         'zh-CN':
           '<p>通过 <code>hide-on-click</code> 属性设置点击菜单项后是否收起菜单弹框。默认为 true，点击后收起。</p>\n',
         'en-US':
-          '<p>Use the <code>hide on click</code> attribute to set whether to collapse the menu pop-up after clicking on the menu item. The default is true, and it will be collapsed after clicking. </p>\n'
+          '<p>Use the <code>hide-on-click</code> attribute to set whether to collapse the menu pop-up after clicking on the menu item. The default is true, and it will be collapsed after clicking. </p>\n'
       },
       'codeFiles': ['hide-on-click.vue']
     },
@@ -102,7 +103,7 @@ export default {
       'desc': {
         'zh-CN': '<p>通过 <code>title</code> 属性设置触发源的文本，默认为 <code>下拉菜单</code>。</p>\n',
         'en-US':
-          '<p>Set the text of the trigger source through the<code>title</code>attribute, which defaults to the<code>drop-down menu</code>.</p>\n'
+          '<p>Set the text of the trigger source through the <code>title</code> attribute, which defaults to the <code>drop-down-menu</code>.</p>\n'
       },
       'codeFiles': ['title.vue']
     },
@@ -113,7 +114,7 @@ export default {
         'zh-CN':
           '<p><code>menu-options</code>属性：只使用 tiny-dropdown 组件配置式时使用。</p>\n<p><code>options</code>属性：使用 tiny-dropdown-menu 组件配置式时使用。</p>\n<p><code>text-field</code>属性：指定菜单文案显示的字段，默认为 label。 </p>\n<p><code>title</code>属性：设置触发源的文本。</p>\n',
         'en-US':
-          '<p><code>menu options</code>Properties: Used only when using the tiny dropdown component configuration</p>\n<p><code>options</code>Properties: Used when using the tiny dropdown menu component configuration</p> \n<p><code>text field</code>Attribute: specifies the field displayed in the menu copy, which defaults to label</p> \n<p><code>title</code>Property: Set the text of the trigger source</p>\n'
+          '<p><code>menu-options</code> properties: used only when using the tiny dropdown component configuration</p>\n<p> <code>options</code> properties: Used when using the tiny dropdown menu component configuration</p> \n<p><code>text-field</code> attribute: specifies the field displayed in the menu copy, which defaults to label</p> \n<p><code>title</code> attribute: Set the text of the trigger source</p>\n'
       },
       'codeFiles': ['options.vue']
     },
@@ -135,38 +136,38 @@ export default {
       'desc': {
         'zh-CN': '<p>通过 <code>inherit-width</code> 属性设置下拉弹框的最小宽度继承触发源的宽度。</p>\n',
         'en-US':
-          '<p>Inherit the width of the trigger source by setting the minimum width of the drop-down pop-up box through the<code>inherit width</code>attribute.</p>\n'
+          '<p>Inherit the width of the trigger source by setting the minimum width of the drop-down pop-up box through the <code>inherit-width</code> attribute.</p>\n'
       },
       'codeFiles': ['inherit-width.vue']
     },
     {
-      'demoId': 'events',
-      'name': { 'zh-CN': '事件', 'en-US': 'Events' },
+      'demoId': 'slots',
+      'name': { 'zh-CN': '插槽', 'en-US': 'Slots' },
       'desc': {
         'zh-CN':
-          '<p><code>button-click</code>：按钮类型时，监听左侧按钮点击事件。</p><p><code>item-click</code>：监听点击菜单项事件。</p><p><code>visible-change</code>：监听下拉弹框显示隐藏发生变化。</p>\n',
+          '<p>通过 <code>default</code> 插槽自定义触发源文本区域。<code>suffix-icon</code> 插槽自定义触发源图标区域。</p>\n',
         'en-US':
-          '<p><code>button-click</code>: When the button type is selected, listen for the left button click event.</p>\n<p><code>item-click</code>: Listens for menu item click events</p>\n<p>code>visible-change</code>: Listens for changes in the display and hiding of dropdown pop ups.</p>\n'
+          '<p>Customize the trigger source text area through the <code>default</code> slot.</p>\n<p>Customize the trigger source icon area through the <code>suffix-icon</code> slot.</p>\n'
       },
-      'codeFiles': ['events.vue']
+      'codeFiles': ['slots.vue']
     },
     {
-      'demoId': 'slots',
-      'name': { 'zh-CN': '插槽', 'en-US': 'Slots' },
+      'demoId': 'events',
+      'name': { 'zh-CN': '事件', 'en-US': 'Events' },
       'desc': {
         'zh-CN':
-          '<p>通过 <code>default</code> 插槽自定义触发源文本区域。<code>suffix-icon</code> 插槽自定义触发源图标区域。</p>\n',
+          '<p><code>button-click</code>：按钮类型时，监听左侧按钮点击事件。</p><p><code>item-click</code>：监听点击菜单项事件。</p><p><code>visible-change</code>：监听下拉弹框显示隐藏发生变化。</p>\n',
         'en-US':
-          '<p>Customize the trigger source text area through the<code>default</code>slot.</p>\n<p>Customize the trigger source icon area through the<code>suffix icon</code>slot.</p>\n'
+          '<p><code>button-click</code>: When the button type is selected, listen for the left button click event.</p>\n<p><code>item-click</code>: Listens for menu item click events</p>\n<p><code>visible-change</code>: Listens for changes in the display and hiding of dropdown pop ups.</p>\n'
       },
-      'codeFiles': ['slots.vue']
+      'codeFiles': ['events.vue']
     }
   ],
   apis: [
     {
       'name': 'dropdown',
       'type': 'component',
-      'properties': [
+      'props': [
         {
           'name': 'disabled',
           'type': 'boolean',
@@ -280,10 +281,11 @@ export default {
         },
         {
           'name': 'type',
-          'type': '"primary" | "success" | "warning" | "danger" | "info" | "text"',
+          'type': 'IButtonType',
+          'typeAnchorName': 'IButtonType',
           'defaultValue': '',
           'desc': {
-            'zh-CN': '按钮类型。注意：只在split-button为 true 的情况下有效',
+            'zh-CN': '按钮类型。注意：只在 split-button 为 true 的情况下有效',
             'en-US': 'Button type. Note: Only valid if split button is true'
           },
           'demoId': 'split-button'
@@ -291,7 +293,7 @@ export default {
         {
           'name': 'title',
           'type': 'string',
-          'defaultValue': '下拉菜单',
+          'defaultValue': "'下拉菜单'",
           'desc': {
             'zh-CN': '自定义触发源的文本',
             'en-US': 'Text for custom trigger source'
@@ -300,8 +302,8 @@ export default {
         },
         {
           'name': 'trigger',
-          'type': '"hover" | "click"',
-          'defaultValue': 'hover',
+          'type': "'hover' | 'click'",
+          'defaultValue': "'hover'",
           'desc': {
             'zh-CN': '触发下拉的方式',
             'en-US': 'Trigger the dropdown method'
@@ -388,11 +390,11 @@ export default {
     {
       'name': 'dropdown-menu',
       'type': 'component',
-      'properties': [
+      'props': [
         {
           'name': 'options',
-          'type': 'IItem []',
-          'typeAnchorName': 'IItem',
+          'type': 'IItemData []',
+          'typeAnchorName': 'IItemData',
           'defaultValue': '[]',
           'desc': {
             'zh-CN': '通过配置式设置菜单项的属性',
@@ -402,8 +404,9 @@ export default {
         },
         {
           'name': 'placement',
-          'type': ' "top" | "top-start" | "top-end" | "bottom" | "bottom-start" | "bottom-end"',
-          'defaultValue': 'bottom-end',
+          'type': 'IPlacementType',
+          'typeAnchorName': 'IPlacementType',
+          'defaultValue': "'bottom-end'",
           'desc': {
             'zh-CN': '菜单弹出位置',
             'en-US': 'Menu pop-up location '
@@ -423,7 +426,7 @@ export default {
         {
           'name': 'text-field',
           'type': 'string',
-          'defaultValue': 'label',
+          'defaultValue': "'label'",
           'desc': {
             'zh-CN': '菜单项文本的字段,结合 options 属性使用',
             'en-US': 'The field of menu item text, used in conjunction with the options attribute'
@@ -447,7 +450,7 @@ export default {
     {
       'name': 'dropdown-item',
       'type': 'component',
-      'properties': [
+      'props': [
         {
           'name': 'disabled',
           'type': 'boolean',
@@ -531,7 +534,7 @@ interface IMenuOption {
       name: 'IItemClickParam',
       type: 'interface',
       code: `        
-interface IMenuOption {
+interface IItemClickParam {
   itemData: IItemData
   // dropdownItem 组件的实例
   vm: {
@@ -552,6 +555,20 @@ interface IItemData {
   disabled?: boolean
   divided?: boolean
 }
+`
+    },
+    {
+      name: 'IButtonType',
+      type: 'type',
+      code: `        
+type IButtonType =  'primary' | 'success' | 'warning' | 'danger' | 'info' | 'text'
+`
+    },
+    {
+      name: 'IPlacementType',
+      type: 'type',
+      code: `        
+type IPlacementType =  'top' | 'top-start' | 'top-end' | 'bottom' | 'bottom-start' | 'bottom-end'
 `
     }
   ]

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

@@ -29,7 +29,7 @@ export default {
     {
       'name': 'espace',
       'type': 'component',
-      'properties': [
+      'props': [
         {
           'name': 'data',
           'type': 'Array , object',

package/demos/pc/app/file-upload/drag-upload.spec.ts

@@ -15,6 +15,6 @@ test('是否可以拖拽上传', async ({ page }) => {
   await expect(drag).toHaveCSS('width', '360px')
   await expect(drag).toHaveCSS('height', '180px')
   await fileChooser.setFiles(currentPath)
-  await expect(lists.nth(0)).toHaveText(/测试.jpg/)
+  await lists.getByText('测试.jpg').isVisible()
   await expect(input).toHaveAttribute('accept', '.png,.jpeg,.jpg')
 })

package/demos/pc/app/file-upload/picture-card.spec.ts

@@ -27,12 +27,12 @@ test('照片墙', async ({ page }) => {
   await expect(height).toEqual(148)
   await expect(li).toHaveCount(1)
   await fileChooser.setFiles(currentPath)
-  await expect(li).toHaveCount(2)
   await first.hover()
   await prevPic.click()
   await expect(prevImg).toHaveAttribute('src', '/static/images/fruit.jpg')
   await dialogClose.click()
   await first.hover()
   await delButton.click()
-  await expect(items).toHaveCount(1)
+  await page.waitForTimeout(200)
+  await li.isHidden()
 })

package/demos/pc/app/filter-panel/basic-usage-composition-api.vue

@@ -1,6 +1,15 @@
 <template>
   <div>
-    <tiny-filter-panel ref="filterPanelRef" label="物品数量" @handle-clear="handleClear" :value="value">
+    <div class="mb10">
+      <tiny-switch v-model="disabled"></tiny-switch><span class="ml10">{{ disabled ? '禁用' : '非禁用' }}</span>
+    </div>
+    <tiny-filter-panel
+      ref="filterPanelRef"
+      label="物品数量"
+      @handle-clear="handleClear"
+      :value="value"
+      :disabled="disabled"
+    >
       <tiny-radio-group v-model="radioVal" size="mini">
         <tiny-radio label="大于">大于</tiny-radio>
         <tiny-radio label="等于">等于</tiny-radio>
@@ -17,11 +26,13 @@ import {
   FilterPanel as TinyFilterPanel,
   Radio as TinyRadio,
   RadioGroup as TinyRadioGroup,
-  Input as TinyInput
+  Input as TinyInput,
+  Switch as TinySwitch
 } from '@opentiny/vue'
 
 const inputVal = ref('')
 const radioVal = ref('')
+const disabled = ref(false)
 const value = computed(() => {
   return radioVal.value + inputVal.value
 })

package/demos/pc/app/filter-panel/basic-usage.spec.ts

@@ -7,13 +7,22 @@ test('基本用法', async ({ page }) => {
   const panel = page.locator('.tiny-filter-panel')
   const button = panel.locator('.tiny-filter-box')
   const popPanel = page.getByRole('tooltip', { name: '大于 等于 小于' })
-  const input = page.getByRole('tooltip', { name: '大于 等于 小于' }).getByRole('textbox')
+  const inputEl = page.locator('.tiny-filter-panel__popover').locator('.tiny-input__inner')
+  const disabledBtn = panel.locator('.tiny-filter-box.disabled')
+  const switchBtn = page.locator('.mb10 > .tiny-switch')
 
   await button.click()
-  await expect(popPanel).toBeVisible()
+  await popPanel.isVisible()
   await page.getByRole('radio', { name: '等于' }).click()
-  await expect(button).toHaveText('物品数量等于')
-  await input.click()
-  await input.fill('10')
-  await expect(button).toHaveText('物品数量等于10')
+  await button.getByText('物品数量等于').isVisible()
+  await inputEl.click()
+  await inputEl.fill('10')
+  await button.getByText('物品数量等于10').isVisible()
+
+  // 禁用
+  await switchBtn.click()
+  await expect(disabledBtn).toHaveCount(1)
+  await expect(disabledBtn).toHaveCSS('cursor', 'not-allowed')
+  await button.click()
+  await popPanel.isHidden()
 })

package/demos/pc/app/filter-panel/basic-usage.vue

@@ -1,6 +1,15 @@
 <template>
   <div>
-    <tiny-filter-panel ref="filterPanel" label="物品数量" @handle-clear="handleClear" :value="value">
+    <div class="mb10">
+      <tiny-switch v-model="disabled"></tiny-switch><span class="ml10">{{ disabled ? '禁用' : '非禁用' }}</span>
+    </div>
+    <tiny-filter-panel
+      ref="filterPanel"
+      label="物品数量"
+      @handle-clear="handleClear"
+      :value="value"
+      :disabled="disabled"
+    >
       <tiny-radio-group v-model="radioVal" size="mini">
         <tiny-radio label="大于">大于</tiny-radio>
         <tiny-radio label="等于">等于</tiny-radio>
@@ -12,19 +21,21 @@
 </template>
 
 <script>
-import { FilterPanel, Radio, RadioGroup, Input } from '@opentiny/vue'
+import { FilterPanel, Radio, RadioGroup, Input, Switch } from '@opentiny/vue'
 
 export default {
   components: {
     TinyRadio: Radio,
     TinyRadioGroup: RadioGroup,
     TinyFilterPanel: FilterPanel,
-    TinyInput: Input
+    TinyInput: Input,
+    TinySwitch: Switch
   },
   data() {
     return {
       inputVal: '',
-      radioVal: ''
+      radioVal: '',
+      disabled: false
     }
   },
   computed: {

package/demos/pc/app/filter-panel/event.spec.ts

@@ -8,11 +8,21 @@ test('事件', async ({ page }) => {
   const button = panel.locator('.tiny-filter-box')
   const popPanel = page.getByRole('tooltip', { name: '大于 等于 小于' })
   const modal = page.locator('.tiny-modal')
+  const clear = panel.locator('.filter-icon-close')
 
+  // handle-clear事件
+  await button.click()
+  await popPanel.isVisible()
+  await page.getByRole('radio', { name: '等于' }).click()
+  await expect(button).toHaveText('物品数量等于')
+  await clear.click()
+  await expect(button).toHaveText('物品数量')
+  await button.click()
+
+  // visible-change事件
   await button.click()
-  await expect(popPanel).toBeVisible()
   await expect(modal.nth(1)).toHaveText('true visibleChange')
   await button.click()
-  await expect(popPanel).not.toBeVisible()
+  await popPanel.isHidden()
   await expect(modal.nth(2)).toHaveText('false visibleChange')
 })

package/demos/pc/app/filter-panel/manual-hide.spec.ts

@@ -10,7 +10,7 @@ test('手动隐藏', async ({ page }) => {
   const manualButton = page.getByRole('button', { name: '确定' })
 
   await button.click()
-  await expect(popPanel).toBeVisible()
+  await popPanel.isVisible()
   await manualButton.click()
-  await expect(popPanel).not.toBeVisible()
+  await popPanel.isHidden()
 })

package/demos/pc/app/filter-panel/popper-class-composition-api.vue

@@ -7,6 +7,7 @@
       :popper-append-to-body="false"
       :value="value"
       :clearable="false"
+      placement="top-start"
     >
       <tiny-radio-group v-model="radioVal" size="mini">
         <tiny-radio label="大于">大于</tiny-radio>

package/demos/pc/app/filter-panel/popper-class.spec.ts

@@ -9,7 +9,7 @@ test('弹出框样式', async ({ page }) => {
   const popPanel = page.getByRole('tooltip', { name: '大于 等于 小于' })
 
   await button.click()
-  await expect(popPanel).toBeVisible()
+  await popPanel.isHidden()
   await button.click()
-  await expect(popPanel).not.toBeVisible()
+  await popPanel.isHidden()
 })

package/demos/pc/app/filter-panel/popper-class.vue

@@ -7,6 +7,7 @@
       :popper-append-to-body="false"
       :value="value"
       :clearable="false"
+      placement="top-start"
     >
       <tiny-radio-group v-model="radioVal" size="mini">
         <tiny-radio label="大于">大于</tiny-radio>

package/demos/pc/app/filter-panel/tip.spec.ts

@@ -2,12 +2,12 @@ import { test, expect } from '@playwright/test'
 
 test('tip提示', async ({ page }) => {
   page.on('pageerror', (exception) => expect(exception).toBeNull())
-  await page.goto('http://127.0.0.1:7130/pc/filter-panel/tip')
+  await page.goto('filter-panel#tip')
 
   const panel = page.locator('.tiny-filter-panel')
   const help = panel.locator('.tiny-svg.tiny-tooltip')
   const tooltip = page.getByRole('tooltip', { name: '请选择物品数量' })
 
   await help.hover()
-  await expect(tooltip).toBeVisible()
+  await tooltip.isVisible()
 })

package/demos/pc/app/filter-panel/webdoc/filter-panel.cn.md

@@ -4,4 +4,4 @@ title: FilterPanel 过滤器面板
 
 # FilterPanel 过滤器面板
 
-<div>FilterPanel 过滤器面板 。</div>
+<div>用于列表数据过滤、图标卡片过滤等。</div>

package/demos/pc/app/filter-panel/webdoc/filter-panel.en.md

@@ -1,7 +1,7 @@
 ---
-title: FilterPanel FilterPanel
+title: FilterPanel
 ---
 
-# FilterPanel FilterPanel
+# FilterPanel
 
-<div>FilterPanel Filterpanel.</div>
+<div>Used for filtering list data, icon card filtering, etc.</div>