blackteay/vant
1
0
Fork 0
mirror of https://gitee.com/vant-contrib/vant.git synced 2025-04-05 19:41:42 +08:00
Code Issues Projects Releases Wiki Activity

docs(ImagePreview): add vertical prop (#12663)

Browse Source
This commit is contained in:
neverland 2024-03-09 20:23:18 +08:00 committed by GitHub
parent c42bbcfc61
commit db76676633
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
packages/vant/src/image-preview/README.md
View File

@ -212,6 +212,7 @@ Vant exports following ImagePreview utility functions:
| doubleScale `v4.7.2` | Whether to enable double tap zoom gesture. When disabled, the image preview will be closed immediately upon clicking | _boolean_ | `true` |
| closeOnClickImage `v4.8.3` | Whether to close when image is clicked | _boolean_ | `true` |
| closeOnClickOverlay `v4.6.4` | Whether to close when overlay is clicked | _boolean_ | `true` |
| vertical `v4.8.6` | Whether to enable vertical gesture sliding | _boolean_ | `false` |
| beforeClose | Callback function before close | _(action) => boolean \| Promise_ | - |
| className | Custom className | _string \| Array \| object_ | - |
| maxZoom | Max zoom | _number \| string_ | `3` |
@ -240,6 +241,7 @@ Vant exports following ImagePreview utility functions:
| close-on-popstate | Whether to close when popstate | _boolean_ | `true` |
| close-on-click-image `v4.8.3` | Whether to close when image is clicked | _boolean_ | `true` |
| close-on-click-overlay `v4.6.4` | Whether to close when overlay is clicked | _boolean_ | `true` |
| vertical `v4.8.6` | Whether to enable vertical gesture sliding | _boolean_ | `false` |
| class-name | Custom className (apply to Popup in image preview) | _string \| Array \| object_ | - |
| max-zoom | Max zoom | _number \| string_ | `3` |
| min-zoom | Min zoom | _number \| string_ | `1/3` |

2
packages/vant/src/image-preview/README.zh-CN.md
View File

@ -216,6 +216,7 @@ Vant 中导出了以下 ImagePreview 相关的辅助函数：
| closeOnPopstate | 是否在页面回退时自动关闭 | _boolean_ | `true` |
| closeOnClickImage `v4.8.3` | 是否在点击图片后关闭图片预览 | _boolean_ | `true` |
| closeOnClickOverlay `v4.6.4` | 是否在点击遮罩层后关闭图片预览 | _boolean_ | `true` |
| vertical `v4.8.6` | 是否开启纵向手势滑动 | _boolean_ | `false` |
| className | 自定义类名 (应用在图片预览的弹出层) | _string \| Array \| object_ | - |
| maxZoom | 手势缩放时，最大缩放比例 | _number \| string_ | `3` |
| minZoom | 手势缩放时，最小缩放比例 | _number \| string_ | `1/3` |
@ -245,6 +246,7 @@ Vant 中导出了以下 ImagePreview 相关的辅助函数：
| close-on-popstate | 是否在页面回退时自动关闭 | _boolean_ | `true` |
| close-on-click-image `v4.8.3` | 是否在点击图片后关闭图片预览 | _boolean_ | `true` |
| close-on-click-overlay `v4.6.4` | 是否在点击遮罩层后关闭图片预览 | _boolean_ | `true` |
| vertical `v4.8.6` | 是否开启纵向手势滑动 | _boolean_ | `false` |
| class-name | 自定义类名 | _string \| Array \| object_ | - |
| max-zoom | 手势缩放时，最大缩放比例 | _number \| string_ | `3` |
| min-zoom | 手势缩放时，最小缩放比例 | _number \| string_ | `1/3` |

1
packages/vant/src/image-preview/function-call.tsx
View File

@ -13,6 +13,7 @@ const defaultConfig: ImagePreviewOptions = {
onScale: undefined,
onClose: undefined,
onChange: undefined,
vertical: false,
teleport: 'body',
className: '',
showIndex: true,