docs: update version tag
This commit is contained in:
陈嘉涵
+29
-29
@@ -128,42 +128,42 @@ export default {
|
||||
|
||||
### Swipe Props
|
||||
|
||||
| Attribute | Description | Type | Default | Version |
|
||||
|------|------|------|------|------|
|
||||
| autoplay | Autoplay interval (ms) | *number* | - | - |
|
||||
| duration | Animation duration (ms) | *number* | `500` | - |
|
||||
| initial-swipe | Index of initial swipe, start from 0 | *number* | `0` | - |
|
||||
| width | Set Swiper Item Width | *number* | `0` | - |
|
||||
| height | Set Swiper Item Height | *number* | `0` | - |
|
||||
| loop | Whether to enable loop | *boolean* | `true` | - |
|
||||
| show-indicators | Whether to show indicators | *boolean* | `true` | - |
|
||||
| indicator-color | Indicator color | *string* | `#1989fa` | - |
|
||||
| vertical | Whether to be vertical Scrolling | *boolean* | `false` | - |
|
||||
| touchable | Whether to allow swipe by touch gesture | *boolean* | `true` | - |
|
||||
| stop-propagation | Whether to stop touchmove event propagation | *boolean* | `false` | 2.1.0 |
|
||||
| Attribute | Description | Type | Default |
|
||||
|------|------|------|------|
|
||||
| autoplay | Autoplay interval (ms) | *number* | - |
|
||||
| duration | Animation duration (ms) | *number* | `500` |
|
||||
| initial-swipe | Index of initial swipe, start from 0 | *number* | `0` |
|
||||
| width | Set Swiper Item Width | *number* | `0` |
|
||||
| height | Set Swiper Item Height | *number* | `0` |
|
||||
| loop | Whether to enable loop | *boolean* | `true` |
|
||||
| show-indicators | Whether to show indicators | *boolean* | `true` |
|
||||
| indicator-color | Indicator color | *string* | `#1989fa` |
|
||||
| vertical | Whether to be vertical Scrolling | *boolean* | `false` |
|
||||
| touchable | Whether to allow swipe by touch gesture | *boolean* | `true` |
|
||||
| stop-propagation `v2.1.0` | Whether to stop touchmove event propagation | *boolean* | `false` |
|
||||
|
||||
### Swipe Events
|
||||
|
||||
| Event | Description | Arguments | Version |
|
||||
|------|------|------|------|
|
||||
| change | Triggered when current swipe change | index: index of current swipe | - |
|
||||
| Event | Description | Arguments |
|
||||
|------|------|------|
|
||||
| change | Triggered when current swipe change | index: index of current swipe |
|
||||
|
||||
### SwipeItem Events
|
||||
|
||||
| Event | Description | Arguments | Version |
|
||||
|------|------|------|------|
|
||||
| click | Triggered when clicked | event: Event | - |
|
||||
| Event | Description | Arguments |
|
||||
|------|------|------|
|
||||
| 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 | Version |
|
||||
|------|------|------|------|------|
|
||||
| prev | Swipe to prev item | - | - | 2.4.2 |
|
||||
| next | Swipe to next item | - | - | 2.4.2 |
|
||||
| swipeTo | Swipe to target index | index: target index, options: Options | void | - |
|
||||
| resize | Resize Swipe when container element resized | - | void | 2.2.14 |
|
||||
| Name | Description | Attribute | Return value |
|
||||
|------|------|------|------|
|
||||
| prev `v2.4.2` | Swipe to prev item | - | - |
|
||||
| next `v2.4.2` | Swipe to next item | - | - |
|
||||
| swipeTo | Swipe to target index | index: target index, options: Options | void |
|
||||
| resize `v2.2.14` | Resize Swipe when container element resized | - | void |
|
||||
|
||||
### swipeTo Options
|
||||
|
||||
@@ -173,7 +173,7 @@ Use [ref](https://vuejs.org/v2/api/#ref) to get Swipe instance and call instance
|
||||
|
||||
### Swipe Slots
|
||||
|
||||
| Name | Description | Version |
|
||||
|------|------|------|
|
||||
| default | Content | - |
|
||||
| indicator | Custom indicator | - |
|
||||
| Name | Description |
|
||||
|------|------|
|
||||
| default | Content |
|
||||
| indicator | Custom indicator |
|
||||
|
||||
+29
-29
@@ -134,42 +134,42 @@ export default {
|
||||
|
||||
### Swipe Props
|
||||
|
||||
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
||||
|------|------|------|------|------|
|
||||
| autoplay | 自动轮播间隔，单位为 ms | *number* | - | - |
|
||||
| duration | 动画时长，单位为 ms | *number* | `500` | - |
|
||||
| initial-swipe | 初始位置索引值 | *number* | `0` | - |
|
||||
| width | 滑块宽度 | *number* | `auto` | - |
|
||||
| height | 滑块高度 | *number* | `auto` | - |
|
||||
| loop | 是否开启循环播放 | *boolean* | `true` | - |
|
||||
| show-indicators | 是否显示指示器 | *boolean* | `true` | - |
|
||||
| indicator-color | 指示器颜色 | *string* | `#1989fa` | - |
|
||||
| vertical | 是否为纵向滚动 | *boolean* | `false` | - |
|
||||
| touchable | 是否可以通过手势滑动 | *boolean* | `true` | - |
|
||||
| stop-propagation | 是否阻止滑动事件冒泡 | *boolean* | `true` | 2.2.13 |
|
||||
| 参数 | 说明 | 类型 | 默认值 |
|
||||
|------|------|------|------|
|
||||
| autoplay | 自动轮播间隔，单位为 ms | *number* | - |
|
||||
| duration | 动画时长，单位为 ms | *number* | `500` |
|
||||
| initial-swipe | 初始位置索引值 | *number* | `0` |
|
||||
| width | 滑块宽度 | *number* | `auto` |
|
||||
| height | 滑块高度 | *number* | `auto` |
|
||||
| loop | 是否开启循环播放 | *boolean* | `true` |
|
||||
| show-indicators | 是否显示指示器 | *boolean* | `true` |
|
||||
| indicator-color | 指示器颜色 | *string* | `#1989fa` |
|
||||
| vertical | 是否为纵向滚动 | *boolean* | `false` |
|
||||
| touchable | 是否可以通过手势滑动 | *boolean* | `true` |
|
||||
| stop-propagation `v2.2.13` | 是否阻止滑动事件冒泡 | *boolean* | `true` |
|
||||
|
||||
### Swipe Events
|
||||
|
||||
| 事件名 | 说明 | 回调参数 | 版本 |
|
||||
|------|------|------|------|
|
||||
| change | 每一页轮播结束后触发 | index, 当前页的索引 | - |
|
||||
| 事件名 | 说明 | 回调参数 |
|
||||
|------|------|------|
|
||||
| change | 每一页轮播结束后触发 | index, 当前页的索引 |
|
||||
|
||||
### SwipeItem Events
|
||||
|
||||
| 事件名 | 说明 | 回调参数 | 版本 |
|
||||
|------|------|------|------|
|
||||
| click | 点击时触发 | event: Event | - |
|
||||
| 事件名 | 说明 | 回调参数 |
|
||||
|------|------|------|
|
||||
| click | 点击时触发 | event: Event |
|
||||
|
||||
### Swipe 方法
|
||||
|
||||
通过 [ref](https://cn.vuejs.org/v2/api/#ref) 可以获取到 Swipe 实例并调用实例方法
|
||||
|
||||
| 方法名 | 说明 | 参数 | 返回值 | 版本 |
|
||||
|------|------|------|------|------|
|
||||
| prev | 切换到上一轮播 | - | - | 2.4.2 |
|
||||
| next | 切换到下一轮播 | - | - | 2.4.2 |
|
||||
| swipeTo | 切换到指定位置 | index: number, options: Options | void | - |
|
||||
| resize | 外层元素大小变化后，可以调用此方法来触发重绘 | - | void | 2.2.14 |
|
||||
| 方法名 | 说明 | 参数 | 返回值 |
|
||||
|------|------|------|------|
|
||||
| prev `v2.4.2` | 切换到上一轮播 | - | - |
|
||||
| next `v2.4.2` | 切换到下一轮播 | - | - |
|
||||
| swipeTo | 切换到指定位置 | index: number, options: Options | void |
|
||||
| resize `v2.2.14` | 外层元素大小变化后，可以调用此方法来触发重绘 | - | void |
|
||||
|
||||
### swipeTo Options 格式
|
||||
|
||||
@@ -179,10 +179,10 @@ export default {
|
||||
|
||||
### Swipe Slots
|
||||
|
||||
| 名称 | 说明 | 版本 |
|
||||
|------|------|------|
|
||||
| default | 轮播内容 | - |
|
||||
| indicator | 自定义指示器 | - |
|
||||
| 名称 | 说明 |
|
||||
|------|------|
|
||||
| default | 轮播内容 |
|
||||
| indicator | 自定义指示器 |
|
||||
|
||||
## 常见问题
|
||||
|
||||
|
||||
Reference in New Issue
Block a user