From 4116bc731a49429eb46f1467ff4773c4d781a3ff Mon Sep 17 00:00:00 2001 From: neverland Date: Tue, 18 Aug 2020 21:23:07 +0800 Subject: [PATCH] docs(ImagePreview): update demo (#7016) --- src/image-preview/README.md | 24 ++++++-- src/image-preview/README.zh-CN.md | 28 +++++++--- src/image-preview/demo/index.vue | 91 +++++++++++++++---------------- 3 files changed, 82 insertions(+), 61 deletions(-) diff --git a/src/image-preview/README.md b/src/image-preview/README.md index e46997566..111ff5679 100644 --- a/src/image-preview/README.md +++ b/src/image-preview/README.md @@ -20,7 +20,7 @@ ImagePreview([ ]); ``` -### Custom config +### Set Start Position ```js ImagePreview({ @@ -29,9 +29,6 @@ ImagePreview({ 'https://img.yzcdn.cn/vant/apple-2.jpg', ], startPosition: 1, - onClose() { - // do something - }, }); ``` @@ -49,6 +46,22 @@ ImagePreview({ }); ``` +### Close Event + +```js +import { Toast } from 'vant'; + +ImagePreview({ + images: [ + 'https://img.yzcdn.cn/vant/apple-1.jpg', + 'https://img.yzcdn.cn/vant/apple-2.jpg', + ], + onClose() { + Toast('closed'); + }, +}); +``` + ### Async Close ```js @@ -62,7 +75,7 @@ const instance = ImagePreview({ setTimeout(() => { instance.close(); -}, 1000); +}, 2000); ``` ### Component Call @@ -85,7 +98,6 @@ export default { ], }; }, - methods: { onChange(index) { this.index = index; diff --git a/src/image-preview/README.zh-CN.md b/src/image-preview/README.zh-CN.md index defe34bc8..59f177887 100644 --- a/src/image-preview/README.zh-CN.md +++ b/src/image-preview/README.zh-CN.md @@ -46,9 +46,9 @@ ImagePreview([ ]); ``` -### 传入配置项 +### 指定初始位置 -通过传入配置对象,可以指定初始图片的位置、监听关闭事件。 +ImagePreview 支持传入配置对象,并通过 `startPosition` 选项指定图片的初始位置(索引值)。 ```js ImagePreview({ @@ -57,9 +57,6 @@ ImagePreview({ 'https://img.yzcdn.cn/vant/apple-2.jpg', ], startPosition: 1, - onClose() { - // do something - }, }); ``` @@ -77,6 +74,24 @@ ImagePreview({ }); ``` +### 监听关闭事件 + +通过 `onClose` 选项监听图片预览的关闭事件。 + +```js +import { Toast } from 'vant'; + +ImagePreview({ + images: [ + 'https://img.yzcdn.cn/vant/apple-1.jpg', + 'https://img.yzcdn.cn/vant/apple-2.jpg', + ], + onClose() { + Toast('关闭'); + }, +}); +``` + ### 异步关闭 通过`asyncClose`属性可以开启异步关闭,开启后异步关闭后,只能通过实例上的 close 方法关闭图片预览。 @@ -92,7 +107,7 @@ const instance = ImagePreview({ setTimeout(() => { instance.close(); -}, 1000); +}, 2000); ``` ### 组件调用 @@ -117,7 +132,6 @@ export default { ], }; }, - methods: { onChange(index) { this.index = index; diff --git a/src/image-preview/demo/index.vue b/src/image-preview/demo/index.vue index 79a3f1742..531fb8b65 100644 --- a/src/image-preview/demo/index.vue +++ b/src/image-preview/demo/index.vue @@ -1,33 +1,33 @@