feat: update chart docs (#1623)

Author: zzcr

.gitignore

@@ -62,6 +62,11 @@ packages/theme/src/theme/*-theme/component.js
 pnpm-lock.yaml
 gulp/bundle.json
 
+# 屏蔽测试用例报告相关文件
+allure-report
+allure-results
+test-results
+
 # 本地构建的saas相关资源文件
 examples/sites/public/tiny-vue*.js
 examples/sites/public/tiny-vue*.mjs

examples/docs/package.json

@@ -18,9 +18,9 @@
     "sortablejs": "1.15.0"
   },
   "devDependencies": {
-    "@playwright/test": "^1.40.1"
+    "@playwright/test": "~1.42.0"
   },
   "files": [
     "resources"
   ]
-}
+}

examples/sites/demos/apis/dialog-box.js

@@ -161,10 +161,10 @@ export default {
         {
           name: 'resize',
           type: 'boolean',
-          defaultValue: 'true',
+          defaultValue: 'false',
           desc: {
-            'zh-CN': '实现窗口最大化',
-            'en-US': 'Maximize windows'
+            'zh-CN': '弹窗是否能切换全屏',
+            'en-US': 'Whether the pop-up window can be switched to full screen'
           },
           mode: ['pc'],
           pcDemo: 'form-in-dialog'
@@ -245,6 +245,17 @@ export default {
           },
           mode: ['pc'],
           pcDemo: 'dialog-width'
+        },
+        {
+          name: 'dialog-transition',
+          type: 'string',
+          defaultValue: ``,
+          desc: {
+            'zh-CN': '启动弹出动效由小变大',
+            'en-US': 'Startup pop-up effect from small to large'
+          },
+          mode: ['pc'],
+          pcDemo: 'transition-effect'
         }
       ],
       events: [
@@ -335,6 +346,18 @@ export default {
           },
           mode: ['pc'],
           pcDemo: 'open-close-events'
+        },
+        {
+          name: 'resize',
+          typeAnchorName: 'IResizeEvent',
+          type: '(ev: IResizeEvent) => void',
+          defaultValue: '',
+          desc: {
+            'zh-CN': '弹窗大小变化时的事件，比如切换全屏状态时',
+            'en-US': 'Event when the pop-up window size changes, for example, when the full-screen mode is switched.'
+          },
+          mode: ['pc'],
+          pcDemo: 'fullscreen'
         }
       ],
       methods: [],
@@ -343,7 +366,7 @@ export default {
           name: 'default',
           defaultValue: '',
           desc: {
-            'zh-CN': 'Dialog 的内容',
+            'zh-CN': 'Dialog 的内容插槽',
             'en-US': 'Dialog content'
           },
           mode: ['pc'],
@@ -353,7 +376,7 @@ export default {
           name: 'footer',
           defaultValue: '',
           desc: {
-            'zh-CN': 'Dialog 按钮操作区的内容',
+            'zh-CN': 'Dialog 按钮操作区的内容插槽',
             'en-US': 'Dialog button operation area content'
           },
           mode: ['pc'],
@@ -363,13 +386,27 @@ export default {
           name: 'title',
           defaultValue: '',
           desc: {
-            'zh-CN': 'Dialog 标题区的内容',
+            'zh-CN': 'Dialog 标题区的内容插槽',
             'en-US': 'Dialog content in the title area'
           },
           mode: ['pc'],
           pcDemo: 'custom-dialog-title'
         }
       ]
     }
+  ],
+  types: [
+    {
+      name: 'IResizeEvent',
+      type: 'interface',
+      code: `
+interface IResizeEvent {
+  // 当前的全屏状态
+  fullscreen: boolean
+  // 弹窗的元素
+  dialog: HTMLElement
+}
+      `
+    }
   ]
 }

examples/sites/demos/apis/dialog-select.js

@@ -362,6 +362,18 @@ export default {
           },
           mode: ['pc'],
           pcDemo: 'nest-grid-multi'
+        },
+        {
+          name: 'resize',
+          typeAnchorName: 'IResizeEvent',
+          type: '(ev: IResizeEvent) => void',
+          defaultValue: '',
+          desc: {
+            'zh-CN': '弹窗大小变化时的事件，比如切换全屏状态时',
+            'en-US': 'Event when the pop-up window size changes, for example, when the full-screen mode is switched.'
+          },
+          mode: ['pc'],
+          pcDemo: ''
         }
       ],
       methods: [
@@ -637,6 +649,18 @@ newPageSize: number // 变更后分页大小
 currentPage: number // 当前所在页
 currentPageSize: number // 当前分页大小
 }`
+    },
+    {
+      name: 'IResizeEvent',
+      type: 'interface',
+      code: `
+interface IResizeEvent {
+  // 当前的全屏状态
+  fullscreen: boolean
+  // 弹窗的元素
+  dialog: HTMLElement
+}
+      `
     }
   ]
 }

examples/sites/demos/apis/dialogbox.js

@@ -327,6 +327,18 @@ export default {
           mode: ['mobile-first'],
           mfDemo: ''
         },
+        {
+          name: 'image-bg-color',
+          type: 'string',
+          defaultValue: '',
+          desc: {
+            'zh-CN': '配置 `list-type` 等于 `picture-single` 或 `picture-card` 模式下图片的背景色。',
+            'en-US':
+              'Configure the background color of the image when `list-type` is set to `picture-single` or `picture-card`.'
+          },
+          mode: ['mobile-first'],
+          mfDemo: ''
+        },
         {
           name: 'is-folder-title',
           type: 'Boolean',
@@ -1067,7 +1079,7 @@ interface IHeaders {
       name: 'IListType',
       type: 'type',
       code: `
-type IListType = 'text' | 'picture' | 'picture-card' | 'thumb' | 'saas'
+type IListType = 'text' | 'picture' | 'picture-card' | 'thumb' | 'saas' // saas为3.14.0版本新增
       `
     },
     {

examples/sites/demos/apis/file-upload.js

@@ -602,6 +602,16 @@ export default {
           },
           mode: ['pc'],
           pcDemo: 'error-label'
+        },
+        {
+          name: 'prompt',
+          defaultValue: '',
+          desc: {
+            'zh-CN': '强提示插槽',
+            'en-US': 'Prompt slot'
+          },
+          mode: ['mobile-first'],
+          mfDemo: 'prompt-slot'
         }
       ]
     }

examples/sites/demos/apis/form.js

@@ -374,6 +374,8 @@ interface IPopperOption {
   bubbling: boolean // 是否监听元素所有上级有滚动元素的scroll事件，监听到则更新popper的位置。用于解决某些弹出层位置在页面滚动时，位置不正确的场景，默认false
   followReferenceHide: boolean // 当触发源隐藏时，自动隐藏弹出层，默认true
   removeOnDestroy: boolean // 弹出层消失后，是否移除弹出层的DOM元素，布尔false
+  updateHiddenPopperOnScroll: boolean  // 滚动过程中是否更新隐藏的弹出层位置
+  boundariesElement: 'viewport' | 'body' | HTMLElement // 滚动过程中,弹出层的碰撞边界。 默认值为： 'viewport'
 }
       `
     },