基于better-scroll封装slider组件

前言

轮播图可以说是在开发中必不可少的组件。接下来这篇文章就基于better-scroll封装一个简单的slider。

better-scroll简介

better-scroll可以说是在Vue开发移动端中最好用的滚动视图的组件，基本上可以解决移动端各种滚动场景需求，核心是借鉴了iscroll的实现，而且API设计基本兼容iscroll.如果您想详细的了解，可以点击查看better-scroll文档。

Slider的简单封装

template代码

<template>
  <div class="slider" ref="slider">
    <div class="slider-group" ref="sliderGroup">
      <slot>
      </slot>
    </div>
    <div class="dots">
      <span class="dot" :class="{active: currentPageIndex === index }" v-for="(item, index) in dots"></span>
    </div>
  </div>
</template>

在template文件中，我们首先用了一个最外层的div 来包裹slider的内容区域(group)和索引区域(dots).然后我们使用了vue-slot插槽，来扩展内容区域,以达到简单封装的目的。

CSS代码

<style scoped lang="stylus" rel="stylesheet/stylus">
  @import "~common/stylus/variable"

  .slider
    min-height: 1px
    .slider-group
      position: relative
      overflow: hidden
      white-space: nowrap
      .slider-item
        float: left
        box-sizing: border-box
        overflow: hidden
        text-align: center
        a
          display: block
          width: 100%
          overflow: hidden
          text-decoration: none
        img
          display: block
          width: 100%
    .dots
      position: absolute
      right: 0
      left: 0
      bottom: 12px
      text-align: center
      font-size: 0
      .dot
        display: inline-block
        margin: 0 4px
        width: 8px
        height: 8px
        border-radius: 50%
        background: $color-text-l
        &.active
          width: 20px
          border-radius: 5px
          background: $color-text-ll
</style>

在CSS文件，主要添加相关的CSS属性。在这里我们使用到定义常量的variable.styl。在内容区域用到了a标签和img标签。因为我们在使用的时候为了兼顾点击事件和图片的显示。
variable.styl

// 颜色定义规范
$color-background = #222
$color-background-d = rgba(0, 0, 0, 0.3)
$color-highlight-background = #333
$color-dialog-background = #666
$color-theme = #ffcd32
$color-theme-d = rgba(255, 205, 49, 0.5)
$color-sub-theme = #d93f30
$color-text = #fff
$color-text-d = rgba(255, 255, 255, 0.3)
$color-text-l = rgba(255, 255, 255, 0.5)
$color-text-ll = rgba(255, 255, 255, 0.8)

//字体定义规范
$font-size-small-s = 10px
$font-size-small = 12px
$font-size-medium = 14px
$font-size-medium-x = 16px
$font-size-large = 18px
$font-size-large-x = 22px

js代码

<script type="text/ecmascript-6">
  import {addClass} from 'common/js/dom'
  import BScroll from 'better-scroll'

  export default {
    name: 'slider',
    props: {
      loop: {
        type: Boolean,
        default: true
      },
      autoPlay: {
        type: Boolean,
        default: true
      },
      interval: {
        type: Number,
        default: 4000
      }
    },
    data() {
      return {
        dots: [],
        currentPageIndex: 0
      }
    },
    mounted() {
      setTimeout(() => {
        this._setSliderWidth()
        this._initDots()
        this._initSlider()

        if (this.autoPlay) {
          this._play()
        }
      }, 20)

      window.addEventListener('resize', () => {
        if (!this.slider) {
          return
        }
        this._setSliderWidth(true)
        this.slider.refresh()
      })
    },
    activated() {
      if (this.autoPlay) {
        this._play()
      }
    },
    deactivated() {
      clearTimeout(this.timer)
    },
    beforeDestroy() {
      clearTimeout(this.timer)
    },
    methods: {
      _setSliderWidth(isResize) {
        this.children = this.$refs.sliderGroup.children

        let width = 0
        let sliderWidth = this.$refs.slider.clientWidth
        for (let i = 0; i < this.children.length; i++) {
          let child = this.children[i]
          addClass(child, 'slider-item')

          child.style.width = sliderWidth + 'px'
          width += sliderWidth
        }
        if (this.loop && !isResize) {
          width += 2 * sliderWidth
        }
        this.$refs.sliderGroup.style.width = width + 'px'
      },
      _initSlider() {
        this.slider = new BScroll(this.$refs.slider, {
          scrollX: true,
          scrollY: false,
          momentum: false,
          snap: true,
          snapLoop: this.loop,
          snapThreshold: 0.3,
          snapSpeed: 400
        })

        this.slider.on('scrollEnd', () => {
          let pageIndex = this.slider.getCurrentPage().pageX
          if (this.loop) {
            pageIndex -= 1
          }
          this.currentPageIndex = pageIndex

          if (this.autoPlay) {
            this._play()
          }
        })

        this.slider.on('beforeScrollStart', () => {
          if (this.autoPlay) {
            clearTimeout(this.timer)
          }
        })
      },
      _initDots() {
        this.dots = new Array(this.children.length)
      },
      _play() {
        let pageIndex = this.currentPageIndex + 1
        if (this.loop) {
          pageIndex += 1
        }
        this.timer = setTimeout(() => {
          this.slider.goToPage(pageIndex, 0, 400)
        }, this.interval)
      }
    }
  }
</script>

在js代码中，首先我们引入可一个dom.js用来给标签动态添加css属性。然后引入better-scroll插件.
props：父组件向子组件单向传参 在上文中定义了是否循环播放、是否自动播放、时间间隔。

data: Vue 实例的数据对象。Vue 将会递归将 data 的属性转换为 getter/setter，从而让 data 的属性能够响应数据变化。 在上文中定义了dots数组、当前页索引值。

mounted：vm的一个生命周期，如果想要确保整个视图都渲染完毕可使用vm.$nextclick和这里的setTimeout20是一个目的。在这里我们设置slider的宽度、初始化dots、初始化slider.
而且监听了window大小变化，来及时修改slider的宽度。

activated：keep-alive 组件激活时调用。 在这里，我们设置开始播放轮播图。

deactivated：keep-alive 组件停用时调用。 在这里，我们清除计时器。

beforeDestroy：实例销毁之前调用。在这一步，实例仍然完全可用。 在这里，还是为了清除计时器。

methods: 定义vue示例的方法。在这里，主要是写我们调用方法的实现。

dom.js

//当前class是否存在classname
export function hasClass(el, className) {
  let reg = new RegExp('(^|\\s)' + className + '(\\s|$)')
  return reg.test(el.className)
}
//元素添加classname
export function addClass(el, className) {
  if (hasClass(el, className)) {
    return
  }
  let newClass = el.className.split(' ')
  newClass.push(className)
  el.className = newClass.join(' ')
}

使用示例

template代码

   <m-slider>
            <div v-for="item in recommendsliders">
              <a :href="item.linkUrl">
                <img @load="loadImage" class="needsclick" :src="item.picUrl">
              </a>
            </div>
    </m-slider>

js代码

<script type="text/ecmascript-6">
 import Slider from 'base/slider/slider';
 export default {
  components: {
      'm-slider': Slider,
    }
}
 </script>

最后

以上就是全部的代码以及实现思路，也就是对better-scroll简单的处理和扩展，方便我们在项目中使用到轮播图的地方调用。