mirror of
https://gitee.com/vant-contrib/vant.git
synced 2025-04-06 03:57:59 +08:00
162 lines
3.4 KiB
Markdown
162 lines
3.4 KiB
Markdown
## Swipe 轮播
|
|
|
|
### 使用指南
|
|
``` javascript
|
|
import { Swipe, SwipeItem } from 'vant';
|
|
|
|
Vue.use(Swipe).use(SwipeItem);
|
|
```
|
|
|
|
### 代码演示
|
|
|
|
#### 基础用法
|
|
通过`autoplay`属性设置自动轮播间隔
|
|
|
|
```html
|
|
<van-swipe :autoplay="3000" indicator-color="white">
|
|
<van-swipe-item>1</van-swipe-item>
|
|
<van-swipe-item>2</van-swipe-item>
|
|
<van-swipe-item>3</van-swipe-item>
|
|
<van-swipe-item>4</van-swipe-item>
|
|
</van-swipe>
|
|
```
|
|
|
|
#### 图片懒加载
|
|
配合 [Lazyload](#/zh-CN/lazyload) 组件实现图片懒加载
|
|
|
|
```html
|
|
<van-swipe :autoplay="3000">
|
|
<van-swipe-item v-for="(image, index) in images" :key="index">
|
|
<img v-lazy="image" />
|
|
</van-swipe-item>
|
|
</van-swipe>
|
|
```
|
|
|
|
```javascript
|
|
export default {
|
|
data() {
|
|
return {
|
|
images: [
|
|
'https://img.yzcdn.cn/1.jpg',
|
|
'https://img.yzcdn.cn/2.jpg'
|
|
]
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
#### 监听 change 事件
|
|
|
|
```html
|
|
<van-swipe @change="onChange">
|
|
<van-swipe-item>1</van-swipe-item>
|
|
<van-swipe-item>2</van-swipe-item>
|
|
<van-swipe-item>3</van-swipe-item>
|
|
<van-swipe-item>4</van-swipe-item>
|
|
</van-swipe>
|
|
```
|
|
|
|
```js
|
|
export default {
|
|
methods: {
|
|
onChange(index) {
|
|
Toast('当前 Swipe 索引：' + index);
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
#### 纵向滚动
|
|
|
|
```html
|
|
<van-swipe :autoplay="3000" vertical>
|
|
<van-swipe-item>1</van-swipe-item>
|
|
<van-swipe-item>2</van-swipe-item>
|
|
<van-swipe-item>3</van-swipe-item>
|
|
<van-swipe-item>4</van-swipe-item>
|
|
</van-swipe>
|
|
```
|
|
|
|
#### 控制滑块大小
|
|
|
|
```html
|
|
<van-swipe :autoplay="3000" :width="300">
|
|
<van-swipe-item>1</van-swipe-item>
|
|
<van-swipe-item>2</van-swipe-item>
|
|
<van-swipe-item>3</van-swipe-item>
|
|
<van-swipe-item>4</van-swipe-item>
|
|
</van-swipe>
|
|
```
|
|
|
|
#### 自定义指示器
|
|
|
|
```html
|
|
<van-swipe @change="onChange">
|
|
<van-swipe-item>1</van-swipe-item>
|
|
<van-swipe-item>2</van-swipe-item>
|
|
<van-swipe-item>3</van-swipe-item>
|
|
<van-swipe-item>4</van-swipe-item>
|
|
|
|
<div class="custom-indicator" slot="indicator">
|
|
{{ current + 1 }}/4
|
|
</div>
|
|
</van-swipe>
|
|
```
|
|
|
|
```js
|
|
export default {
|
|
data() {
|
|
return {
|
|
current: 0
|
|
}
|
|
},
|
|
methods: {
|
|
onChange(index) {
|
|
this.current = index;
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
### API
|
|
|
|
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
|------|------|------|------|------|
|
|
| autoplay | 自动轮播间隔，单位为 ms | `Number` | - | - |
|
|
| duration | 动画时长，单位为 ms | `Number` | `500` | - |
|
|
| initial-swipe | 初始位置索引值 | `Number` | `0` | - |
|
|
| loop | 是否开启循环播放 | `Boolean` | `true` | - |
|
|
| show-indicators | 是否显示指示器 | `Boolean` | `true` | - |
|
|
| indicator-color | 指示器颜色 | `String` | `#1989fa` | 1.4.5 |
|
|
| vertical | 是否为纵向滚动 | `Boolean` | `false` | 1.1.1 |
|
|
| touchable | 是否可以通过手势滑动 | `Boolean` | `true` | 1.1.1 |
|
|
| width | 滑块宽度 | `Number` | `0` | 1.2.1 |
|
|
| height | 滑块高度 | `Number` | `0` | 1.2.1 |
|
|
|
|
### Swipe 事件
|
|
|
|
| 事件名 | 说明 | 参数 |
|
|
|------|------|------|
|
|
| change | 每一页轮播结束后触发 | index, 当前页的索引 |
|
|
|
|
### SwipeItem 事件
|
|
|
|
| 事件名 | 说明 | 参数 |
|
|
|------|------|------|
|
|
| click | 点击时触发 | - |
|
|
|
|
### 方法
|
|
|
|
通过 ref 可以获取到 swipe 实例并调用实例方法
|
|
|
|
| 方法名 | 参数 | 返回值 | 介绍 |
|
|
|------|------|------|------|
|
|
| swipeTo | index: 目标位置的索引 | void | 滚动到目标位置 |
|
|
|
|
### 插槽
|
|
|
|
| 名称 | 说明 |
|
|
|------|------|
|
|
| - | 轮播内容 |
|
|
| indicator | 自定义指示器 |
|