Swiper 轮播图

13:10

该组件一般用于导航轮播，广告展示等场景,可开箱即用，具有如下特点：

• 内置多种指示器模式，可配置指示器位置
• 3D 轮播图效果
• 可配置是否显示标题

平台差异说明

App	H5	微信小程序	支付宝小程序	百度小程序	头条小程序	QQ 小程序
√	√	√	√	√	√	√

基本使用

通过list参数传入轮播图列表值，该值为一个数组，元素为对象，见如下：

• list的"image"属性为轮播图的图片路径
• list的"title"属性为需要显示的标题

说明： 某些情况下

1. 您从服务端获取的数据，里面的数组对于图片的属性名不一定为image，如果让您再历遍修改为image属性，显然是不人性的， 所以 uView 提供了一个name参数，比如您数组中的图片名称为img，您可以设置u-swiper组件的name参数为img值。

2. 您也可以直接传递一个元素为图片路径的数组给list参数，如下(1.6.5 支持)：

<u-swiper :list="list"></u-swiper>

let list = [ '1.png', '2.png' ];

注意

如果需要显示标题，还需要设置title参数为true

<template>
  <view class="wrap">
    <u-swiper :list="list"></u-swiper>
  </view>
</template>

<script setup lang="ts">
import { ref } from 'vue'

// 定义轮播图项接口
interface SwiperItem {
  image: string
  title: string
}

// 定义响应式数据
const list = ref<SwiperItem[]>([
  {
    image: "https://cdn.uviewui.com/uview/xxx.jpg",
    title: "昨夜星辰昨夜风，画楼西畔桂堂东",
  },
  {
    image: "https://cdn.uviewui.com/uview/xxx.jpg",
    title: "身无彩凤双飞翼，心有灵犀一点通",
  },
  {
    image: "https://cdn.uviewui.com/uview/xxx.jpg",
    title: "谁念西风独自凉，萧萧黄叶闭疏窗，沉思往事立残阳",
  },
])
</script>

<style lang="scss" scoped>
.wrap {
  padding: 40rpx;
}
</style>

指示器类型

本组件内置了多种指示器，通过配置mode参数即可，有如下：

• rect-指示器为方块状
• dot-指示器为圆点
• number-指示器为数字
• round-激活的指示器为块状，未激活的未点状，为默认值
• none-不显示指示器

通过indicator-pos参数配置指示器的位置，有如下值：

• topLeft-指示器位于左上角
• topCenter-指示器位于上方中间位置
• topRight-指示器位于右上角
• bottomLeft-指示器位于左下角
• bottomCenter-指示器位于底部中间位置，为默认值
• bottomRight-指示器位于右下角

<u-swiper :list="list" mode="dot" indicator-pos="bottomRight"></u-swiper>

是否开启 3D 效果

配置effect3d为true即可，该效果左右两边可以缩略形式预览前后一个 swiper-item 的一部分

<u-swiper :list="list" :effect3d="true"></u-swiper>

控制轮播效果

• autoplay-是否自动轮播，默认为true
• interval-前后两张图自动轮播的时间间隔
• duration-切换一张轮播图所需的时间
• circular-是否衔接滑动，即到最后一张时，是否可以直接转到第一张

<u-swiper :list="list" duration="3000" :circular="false"></u-swiper>

API

Props

参数	说明	类型	默认值	可选值
list	轮播图数据，见上方"基本使用"说明	Array	-	-
title	是否显示标题文字，需要配合list参数，见上方说明	Boolean	false	true
mode	指示器模式，见上方说明	String	round	rect / dot / number / none
height	轮播图组件高度，单位 rpx	String | Number	250	-
indicator-pos	指示器的位置	String	bottomCenter	topLeft / topCenter / topRight / bottomLeft / bottomRight
effect3d	是否开启 3D 效果	Boolean	false	true
autoplay	是否自动播放	Boolean	true	false
interval	自动轮播时间间隔，单位 ms	String | Number	2500	-
circular	是否衔接播放，见上方说明	Boolean	true	false
duration	切换一张轮播图所需的时间，单位 ms	String | Number	500	-
border-radius	轮播图圆角值，单位 rpx	String | Number	8	-
title-style	自定义标题样式	Object	-	-
effect3d-previous-margin	effect3d = true 模式的情况下，激活项与前后项之间的距离，单位 rpx	String | Number	50	-
img-mode	图片的裁剪模式，详见image 组件裁剪模式	String	aspectFill	-
name	组件内部读取的list参数中的属性名，见上方说明	string	name	-
bg-color	背景颜色	string	#f3f4f6	-
current	初始化时，默认显示第几项	String | Number	0	-

Events

事件名	说明	回调参数
click	点击轮播图时触发	index：点击了第几张图片，从 0 开始
change	轮播图切换时触发(自动或者手动切换)	index：切换到了第几张图片，从 0 开始