vue2.x项目better-scroll组件封装

以下是自己项目中的封装代码，在components文件夹新建Scroll.vue，粘贴此代码。在需要用到的页面引入Scroll.vue并注册，即可使用。

<template>
  <div ref="wrapper">
    <slot></slot>
  </div>
</template>

<script>
import BScroll from 'better-scroll'
export default {
  props: {
    probeType: {
      type: Number,
      default: 1
    },
    click: {
      type: Boolean,
      default: true
    },
    scrollX: {
      type: Boolean,
      default: false
    },
    eventPassthrough: {
      type: String,
      default: ''
    },
    listenScroll: {
      type: Boolean,
      default: false
    },
    data: {
      type: Array,
      default: null
    },
    pullup: {
      type: Boolean,
      default: false
    },
    pulldown: {
      type: Boolean,
      default: false
    },
    pullright: {
      type: Boolean,
      default: false
    },
    beforeScroll: {
      type: Boolean,
      default: false
    },
    refreshDelay: {
      type: Number,
      default: 20
    },
    bounce: {
      type: Boolean,
      default: true
    },
    bounceTime: {
      type: Number,
      default: 700
    },
    preventDefaultException: {
      type: Object,
      default: () => {
        return { tagName: /^(PRE|INPUT|TEXTAREA|BUTTON|SELECT)$/ }
      }
    }
  },
  mounted () {
    // 保证在DOM渲染完毕后初始化better-scroll
    this.$nextTick(() => {
      this._initScroll()
    })
    // setTimeout(() => {
    //   this._initScroll()
    // }, 20)
  },
  methods: {
    _initScroll () {
      if (!this.$refs.wrapper) {
        return
      }
      // better-scroll的初始化
      let scrollOptions = {
        probeType: this.probeType,
        click: this.click,
        scrollX: this.scrollX,
        preventDefaultException: this.preventDefaultException,
        bounce: this.bounce,
        bounceTime: this.bounceTime,
        eventPassthrough: this.eventPassthrough
      }
      if (this.pulldown) {
        let pullDownRefresh = {
          pullDownRefresh: {
            threshold: 50,
            stop: 50
          }
        }
        Object.assign(scrollOptions, pullDownRefresh)
      }
      this.scroll = new BScroll(this.$refs.wrapper, scrollOptions)
      // 是否派发滚动事件
      if (this.listenScroll) {
        this.scroll.on('scroll', (pos) => {
          this.$emit('scroll', pos)
        })
      }

      // 是否派发滚动到底部事件，用于上拉加载
      if (this.pullup) {
        this.scroll.on('scrollEnd', () => {
          // 滚动到底部
          if (this.scroll.y <= (this.scroll.maxScrollY + 50)) {
            this.$emit('scrollToEnd')
          }
        })
      }

      // 是否派发滚动到右边底部事件，用于加载
      if (this.pullright) {
        this.scroll.on('scrollEnd', () => {
          // 滚动到右边底
          if (this.scroll.x <= (this.scroll.maxScrollX + 50)) {
            this.$emit('scrollToEnd')
          }
        })
      }

      // 是否派发顶部下拉事件，用于下拉刷新
      if (this.pulldown) {
        this.scroll.on('pullingDown', () => {
          this.$emit('pullDownRefresh')
        })
      }

      // 是否派发列表滚动开始的事件
      if (this.beforeScroll) {
        this.scroll.on('beforeScrollStart', () => {
          this.$emit('beforeScroll')
        })
      }
    },
    disable () {
      // 代理better-scroll的disable方法
      this.scroll && this.scroll.disable()
    },
    enable () {
      // 代理better-scroll的enable方法
      this.scroll && this.scroll.enable()
    },
    refresh () {
      // 代理better-scroll的refresh方法
      this.scroll && this.scroll.refresh()
    },
    finishPullDown () {
      this.scroll && this.scroll.finishPullDown()
    },
    scrollTo (x, y, t) {
      // 代理better-scroll的scrollTo方法
      this.scroll && this.scroll.scrollTo.apply(this.scroll, arguments)
    },
    scrollBy (x, y, t) {
      // 代理better-scroll的scrollTo方法
      this.scroll && this.scroll.scrollBy.apply(this.scroll, arguments)
    },
    maxScrollY () {
      return this.scroll.maxScrollY
    },
    scrollToElement (el, time) {
      // 代理better-scroll的scrollToElement方法
      this.scroll && this.scroll.scrollToElement.apply(this.scroll, arguments)
    }
  },
  watch: {
    // 监听数据的变化，延时refreshDelay时间后调用refresh方法重新计算，保证滚动效果正常
    data () {
      setTimeout(() => {
        this.refresh()
      }, this.refreshDelay)
    }
  }
}
</script>

<style lang="stylus" scoped>

</style>

 <a href="https://github.com/ustbhuangyi/better-scroll">better-scroll</a>是一款重点解决移动端（已支持 PC）各种滚动场景需求的插件。它的核心是借鉴的 iscroll 的实现，它的 API 设计基本兼容 iscroll，在 iscroll 的基础上又扩展了一些 feature 以及做了一些性能优化。

BetterScroll 是使用纯 JavaScript 实现的，这意味着它是无依赖的。

感谢github大佬 ustbhuangyi 为我们带来这么好用的滚动插件，respect。

注意：很多人已经用过 BetterScroll，遇到最多的坑是：

BetterScroll 初始化了， 但是没法滚动。

不能滚动是现象，我们得搞清楚这其中的根本原因。在这之前，我们先来看一下浏览器的滚动原理： 浏览器的滚动条大家都会遇到，当页面内容的高度超过视口高度的时候，会出现纵向滚动条；当页面内容的宽度超过视口宽度的时候，会出现横向滚动条。也就是当我们的视口展示不下内容的时候，会通过滚动条的方式让用户滚动屏幕看到剩余的内容。