Swipe 轮播

引入

  1. import Vue from 'vue';
  2. import { Swipe, SwipeItem } from 'vant';
  3. Vue.use(Swipe);
  4. Vue.use(SwipeItem);

代码演示

基础用法

每个 SwipeItem 代表一张轮播卡片,可以通过 autoplay 属性设置自动轮播的间隔。

  1. <van-swipe class="my-swipe" :autoplay="3000" indicator-color="white">
  2. <van-swipe-item>1</van-swipe-item>
  3. <van-swipe-item>2</van-swipe-item>
  4. <van-swipe-item>3</van-swipe-item>
  5. <van-swipe-item>4</van-swipe-item>
  6. </van-swipe>
  7. <style>
  8. .my-swipe .van-swipe-item {
  9. color: #fff;
  10. font-size: 20px;
  11. line-height: 150px;
  12. text-align: center;
  13. background-color: #39a9ed;
  14. }
  15. </style>

图片懒加载

当 Swipe 中含有图片时,可以配合 Lazyload 组件实现图片懒加载。

  1. <van-swipe :autoplay="3000">
  2. <van-swipe-item v-for="(image, index) in images" :key="index">
  3. <img v-lazy="image" />
  4. </van-swipe-item>
  5. </van-swipe>
  1. import Vue from 'vue';
  2. import { Lazyload } from 'vant';
  3. Vue.use(Lazyload);
  4. export default {
  5. data() {
  6. return {
  7. images: [
  8. 'https://img.yzcdn.cn/vant/apple-1.jpg',
  9. 'https://img.yzcdn.cn/vant/apple-2.jpg',
  10. ],
  11. };
  12. },
  13. };

监听 change 事件

  1. <van-swipe @change="onChange">
  2. <van-swipe-item>1</van-swipe-item>
  3. <van-swipe-item>2</van-swipe-item>
  4. <van-swipe-item>3</van-swipe-item>
  5. <van-swipe-item>4</van-swipe-item>
  6. </van-swipe>
  1. import { Toast } from 'vant';
  2. export default {
  3. methods: {
  4. onChange(index) {
  5. Toast('当前 Swipe 索引:' + index);
  6. },
  7. },
  8. };

纵向滚动

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

  1. <van-swipe style="height: 200px;" vertical>
  2. <van-swipe-item>1</van-swipe-item>
  3. <van-swipe-item>2</van-swipe-item>
  4. <van-swipe-item>3</van-swipe-item>
  5. <van-swipe-item>4</van-swipe-item>
  6. </van-swipe>

自定义滑块大小

滑块默认宽度为 100%,可以通过 width 属性设置单个滑块的宽度。纵向滚动模式下,可以通过 height 属性设置单个滑块的高度。

  1. <van-swipe :loop="false" :width="300">
  2. <van-swipe-item>1</van-swipe-item>
  3. <van-swipe-item>2</van-swipe-item>
  4. <van-swipe-item>3</van-swipe-item>
  5. <van-swipe-item>4</van-swipe-item>
  6. </van-swipe>

目前不支持在循环滚动模式下自定义滑块大小,因此需要将 loop 设置为 false。

自定义指示器

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

  1. <van-swipe @change="onChange">
  2. <van-swipe-item>1</van-swipe-item>
  3. <van-swipe-item>2</van-swipe-item>
  4. <van-swipe-item>3</van-swipe-item>
  5. <van-swipe-item>4</van-swipe-item>
  6. <template #indicator>
  7. <div class="custom-indicator">
  8. {{ current + 1 }}/4
  9. </div>
  10. </template>
  11. </van-swipe>
  12. <style>
  13. .custom-indicator {
  14. position: absolute;
  15. right: 5px;
  16. bottom: 5px;
  17. padding: 2px 5px;
  18. font-size: 12px;
  19. background: rgba(0, 0, 0, 0.1);
  20. }
  21. </style>
  1. export default {
  2. data() {
  3. return {
  4. current: 0,
  5. };
  6. },
  7. methods: {
  8. onChange(index) {
  9. this.current = index;
  10. },
  11. },
  12. };

API

Swipe Props

参数说明类型默认值
autoplay自动轮播间隔,单位为 msnumber | string-
duration动画时长,单位为 msnumber | string500
initial-swipe初始位置索引值number | string0
width滑块宽度,单位为pxnumber | stringauto
height滑块高度,单位为pxnumber | stringauto
loop是否开启循环播放booleantrue
show-indicators是否显示指示器booleantrue
vertical是否为纵向滚动booleanfalse
touchable是否可以通过手势滑动booleantrue
stop-propagation是否阻止滑动事件冒泡booleantrue
lazy-render v2.5.8是否延迟渲染未展示的轮播booleanfalse
indicator-color指示器颜色string#1989fa

Swipe Events

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

SwipeItem Events

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

Swipe 方法

通过 ref 可以获取到 Swipe 实例并调用实例方法,详见组件实例方法

方法名说明参数返回值
prev v2.4.2切换到上一轮播--
next v2.4.2切换到下一轮播--
swipeTo切换到指定位置index: number, options: Optionsvoid
resize外层元素大小变化后,可以调用此方法来触发重绘-void

swipeTo Options 格式

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

Swipe Slots

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

常见问题

滑动轮播时为什么触发了 click 事件?

这种情况通常是由于项目中引入了fastclick库导致的。fastclick的原理是通过 Touch 事件模拟出 click 事件,而 Swipe 内部默认会阻止 touchmove 事件冒泡,干扰了 fastclick 的判断,导致出现这个问题。

将 Swipe 组件的 stop-propagation 属性设置为 false 即可避免该问题。

在桌面端无法操作组件?

参见在桌面端使用

Swipe 组件功能太少,无法实现复杂效果?

Vant 中的 Swipe 组件是比较轻量的,因此功能也比较基础。如果需要更复杂的轮播效果,推荐使用社区里一些优质的轮播库,比如 vue-awesome-swiper

Swipe 轮播 - 图1