vant/src/swipe/README.zh-CN.md

Swipe 轮播

引入

import { Swipe, SwipeItem } from 'vant';

Vue.use(Swipe).use(SwipeItem);

代码演示

基础用法

通过autoplay属性设置自动轮播间隔

<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 组件实现图片懒加载

<van-swipe :autoplay="3000">
  <van-swipe-item v-for="(image, index) in images" :key="index">
    <img v-lazy="image" />
  </van-swipe-item>
</van-swipe>

export default {
  data() {
    return {
      images: [
        'https://img.yzcdn.cn/vant/apple-1.jpg',
        'https://img.yzcdn.cn/vant/apple-2.jpg'
      ]
    }
  }
}

监听 change 事件

<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>

export default {
  methods: {
    onChange(index) {
      Toast('当前 Swipe 索引：' + index);
    }
  }
}

纵向滚动

设置vertical属性后滑块会纵向排列，此时需要指定滑块容器的高度

<van-swipe style="height: 200px;" 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>

控制滑块大小

滑块默认宽度为100%，可以通过width属性设置滑块的宽度，此属性不能与循环播放同时使用

<van-swipe :loop="false" :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>

自定义指示器

通过indicator插槽可以自定义指示器的样式

<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>

export default {
  data() {
    return {
      current: 0
    }
  },
  methods: {
    onChange(index) {
      this.current = index;
    }
  }
}

API

Swipe Props

参数	说明	类型	默认值	版本
autoplay	自动轮播间隔，单位为 ms	number	-	-
duration	动画时长，单位为 ms	number	500	-
initial-swipe	初始位置索引值	number	0	-
loop	是否开启循环播放	boolean	true	-
show-indicators	是否显示指示器	boolean	true	-
indicator-color	指示器颜色	string	#1989fa	-
vertical	是否为纵向滚动	boolean	false	-
touchable	是否可以通过手势滑动	boolean	true	-
width	滑块宽度	number	auto	-
height	滑块高度	number	auto	-

Swipe Events

事件名	说明	回调参数
change	每一页轮播结束后触发	index, 当前页的索引

SwipeItem Events

事件名	说明	回调参数
click	点击时触发	event: Event

Swipe 方法

通过 ref 可以获取到 swipe 实例并调用实例方法

方法名	参数	返回值	介绍
swipeTo	index: 目标位置的索引, options: 选项	void	滚动到目标位置

swipeTo Options 格式

名称	说明	类型
immediate	是否跳过动画	boolean

Swipe Slots

名称	说明
default	轮播内容
indicator	自定义指示器