mand-mobile/components/swiper/README.md

2.3 KiB
Raw Permalink Blame History

title preview
Swiper 轮播 https://didi.github.io/mand-mobile/examples/#/swiper

走马灯,用于一组图片或卡片轮播

引入

import { Swiper, SwiperItem } from 'mand-mobile'

Vue.component(Swiper.name, Swiper)
Vue.component(SwiperItem.name, SwiperItem)

代码演示

API

Swiper Props

属性 说明 类型 默认值 可选值/备注
autoplay 自动切换间隔时长(毫秒), 禁用可设置为0 Number 3000 0, [500, +Int.Max)
transition 面板切换动画效果 String slide slide, slideY, fade
transition-duration 面板切换动画时长 Number 250 单位ms
default-index 第一屏面板索引值 Number 0 [0, length - 1]
has-dots 控制面板指示点 Boolean true -
is-prevent 阻止默认的事件,如页面滚动事件 Boolean true swiper-item绑定点击事件需将其设置为false
is-loop 循环播放 Boolean true -
dragable 禁用触摸滑动 Boolean true -
use-native-driver 开启3D加速 Boolean true -

Swiper Methods

play(autoplay)

打开自动切换

参数 说明 类型 默认值 可选值
autoplay 自动切换间隔时长(毫秒) Number 3000 [500, +Int.Max)
vm.$refs.swiper.play(5000)
stop()

停止自动切换

vm.$refs.swiper.stop()
prev()

前一个item

vm.$refs.swiper.prev()
next()

后一个item

vm.$refs.swiper.next()
goto(index)

切换到某一个index

参数 说明 类型 默认值 可选值
index 面板索引值 Number 0 [0, length - 1]
vm.$refs.swiper.goto(2)
getIndex()

获取当前显示的index

参数 说明 类型
index 当前显示的index Number
var index = vm.$refs.swiper.getIndex()

Swiper Events

@beforeChange(from, to)

轮播器将要切换前的事件

参数 说明 类型
from 轮播器当前展示的索引值 Number
to 轮播器下一屏展示的索引值 Number
@afterChange(from, to)

轮播器切换完成时的事件

参数 说明 类型
from 轮播器当前展示的索引值 Number
to 轮播器下一屏展示的索引值 Number