blackteay/vant
1
0
Fork 0
mirror of https://gitee.com/vant-contrib/vant.git synced 2025-04-06 03:57:59 +08:00
Code Issues Projects Releases Wiki Activity

docs(Swipe): add api version tip (#5091)

Browse Source
This commit is contained in:
neverland 2019-11-25 08:27:40 +08:00 committed by GitHub
parent 4c1e77cc37
commit 9b01cac23f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 29 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
src/swipe/README.md
View File

@ -144,34 +144,34 @@ export default {
### Swipe Events
| Event | Description | Arguments |
|------|------|------|
| change | Triggered when current swipe change | index: index of current swipe |
| Event | Description | Arguments | Version |
|------|------|------|------|
| change | Triggered when current swipe change | index: index of current swipe | - |
### SwipeItem Events
| Event | Description | Arguments |
|------|------|------|
| click | Triggered when clicked | event: Event |
| Event | Description | Arguments | Version |
|------|------|------|------|
| click | Triggered when clicked | event: Event | - |
### Swipe Methods
Use [ref](https://vuejs.org/v2/api/#ref) to get Swipe instance and call instance methods
| Name | Description | Attribute | Return value |
|------|------|------|------|
| swipeTo | Swipe to target index | index: target index, options: Options | void |
| resize | Resize Swipe when container element resized | - | void |
| Name | Description | Attribute | Return value | Version |
|------|------|------|------|------|
| swipeTo | Swipe to target index | index: target index, options: Options | void | - |
| resize | Resize Swipe when container element resized | - | void | 2.2.14 |
### swipeTo Options
| Name | Description | Type |
|------|------|------|
|------|------|------|------|
| immediate | Whether to skip animation | *boolean* |
### Swipe Slots
| Name | Description |
|------|------|
| default | Content |
| indicator | Custom indicator |
| Name | Description | Version |
|------|------|------|
| default | Content | - |
| indicator | Custom indicator | - |

28
src/swipe/README.zh-CN.md
View File

@ -150,24 +150,24 @@ export default {
### Swipe Events
| 事件名 | 说明 | 回调参数 |
|------|------|------|
| change | 每一页轮播结束后触发 | index, 当前页的索引 |
| 事件名 | 说明 | 回调参数 | 版本 |
|------|------|------|------|
| change | 每一页轮播结束后触发 | index, 当前页的索引 | - |
### SwipeItem Events
| 事件名 | 说明 | 回调参数 |
|------|------|------|
| click | 点击时触发 | event: Event |
| 事件名 | 说明 | 回调参数 | 版本 |
|------|------|------|------|
| click | 点击时触发 | event: Event | - |
### Swipe 方法
通过 [ref](https://cn.vuejs.org/v2/api/#ref) 可以获取到 Swipe 实例并调用实例方法
| 方法名 | 说明 | 参数 | 返回值 |
|------|------|------|------|
| swipeTo | 滚动到目标位置 | index: number, options: Options | void |
| resize | 外层元素大小变化后，可以调用此方法来触发重绘 | - | void |
| 方法名 | 说明 | 参数 | 返回值 | 版本 |
|------|------|------|------|------|
| swipeTo | 滚动到目标位置 | index: number, options: Options | void | - |
| resize | 外层元素大小变化后，可以调用此方法来触发重绘 | - | void | 2.2.14 |
### swipeTo Options 格式
@ -177,7 +177,7 @@ export default {
### Swipe Slots
| 名称 | 说明 |
|------|------|
| default | 轮播内容 |
| indicator | 自定义指示器 |
| 名称 | 说明 | 版本 |
|------|------|------|
| default | 轮播内容 | - |
| indicator | 自定义指示器 | - |