From 5298e597a612e32f85133bae2bec4c278650db0a Mon Sep 17 00:00:00 2001 From: neverland Date: Fri, 20 Nov 2020 20:43:54 +0800 Subject: [PATCH] docs(ImagePreview): fix swipeTo method (#7595) --- src/image-preview/README.md | 7 +++++++ src/image-preview/README.zh-CN.md | 9 ++++++++- 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/src/image-preview/README.md b/src/image-preview/README.md index 13af99942..8f344c75b 100644 --- a/src/image-preview/README.md +++ b/src/image-preview/README.md @@ -159,6 +159,13 @@ export default { | closed `v2.5.6` | Emitted when ImagePreview is closed | - | | change | Emitted when current image changed | index: index of current image | | scale `v2.5.0` | Emitted when scaling current image | { index: index of current image, scale: scale of current image} | + +### Methods + +Use [ref](https://vuejs.org/v2/api/#ref) to get ImagePreview instance and call instance methods. + +| Name | Description | Attribute | Return value | +| --- | --- | --- | --- | | swipeTo `2.9.0` | Swipe to target index | index: target index, options: Options | - | ### Slots diff --git a/src/image-preview/README.zh-CN.md b/src/image-preview/README.zh-CN.md index 93b6634a1..161fc41a1 100644 --- a/src/image-preview/README.zh-CN.md +++ b/src/image-preview/README.zh-CN.md @@ -199,7 +199,14 @@ export default { | closed `v2.5.6` | 关闭且且动画结束后触发 | - | | change | 切换当前图片时触发 | index: 当前图片的索引 | | scale `v2.5.0` | 缩放当前图片时触发 | { index: 当前图片的索引, scale: 当前缩放的值 } | -| swipeTo `2.9.0` | 切换到指定位置 | index: number, options: Options | - | + +### 方法 + +通过组件调用 `ImagePreview` 时,通过 ref 可以获取到 ImagePreview 实例并调用实例方法,详见[组件实例方法](#/zh-CN/advanced-usage#zu-jian-shi-li-fang-fa)。 + +| 方法名 | 说明 | 参数 | 返回值 | +| --------------- | -------------- | ------------------------------- | ------ | +| swipeTo `2.9.0` | 切换到指定位置 | index: number, options: Options | - | ### Slots