封装 better-scroll

2,131 阅读2分钟

详情看:当 better-scroll 遇见 Vue

npm install --save better-scroll

BetterScroll.vue

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

<script>
  import BScroll from 'better-scroll'

  export default {
    name: 'BetterScroll',
    components: {BScroll},
    props: {
      /**
       * 1 滚动的时候会派发scroll事件,会截流。
       * 2 滚动的时候实时派发scroll事件,不会截流。
       * 3 除了实时派发scroll事件,在swipe的情况下仍然能实时派发scroll事件
       */
      probeType: {
        type: Number,
        default: 1
      },
      /**
       * 点击列表是否派发click事件
       */
      click: {
        type: Boolean,
        default: true
      },
      /**
       * 是否开启横向滚动
       */
      scrollX: {
        type: Boolean,
        default: false
      },
      /**
       * 是否派发滚动事件
       */
      listenScroll: {
        type: Boolean,
        default: false
      },
      /**
       * 列表的数据
       */
      data: {
        type: Array,
        default: null
      },
      /**
       * 是否派发滚动到底部的事件,用于上拉加载
       */
      pullup: {
        type: Boolean,
        default: false
      },
      /**
       * 是否派发顶部下拉的事件,用于下拉刷新
       */
      pulldown: {
        type: Boolean,
        default: false
      },
      /**
       * 是否派发列表滚动开始的事件
       */
      beforeScroll: {
        type: Boolean,
        default: false
      },
      /**
       * 当数据更新后,刷新scroll的延时。
       */
      refreshDelay: {
        type: Number,
        default: 20
      }
    },
    mounted() {
      // 保证在DOM渲染完毕后初始化better-scroll
      setTimeout(() => {
        this._initScroll()
      }, 20)
    },
    methods: {
      _initScroll() {
        if (!this.$refs.wrapper) {
          return
        }
        // better-scroll的初始化
        this.scroll = new BScroll(this.$refs.wrapper, {
          probeType: this.probeType,
          click: this.click,
          scrollX: this.scrollX
        })

        // 是否派发滚动事件
        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('pullup')
            }
          })
        }

        // 是否派发顶部下拉事件,用于下拉刷新
        if (this.pulldown) {
          this.scroll.on('touchend', (pos) => {
            // 下拉动作
            if (pos.y > 50) {
              this.$emit('pulldown')
            }
          })
        }

        // 是否派发列表滚动开始的事件
        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()
      },
      scrollTo() {
        // 代理better-scroll的scrollTo方法
        this.scroll && this.scroll.scrollTo.apply(this.scroll, arguments)
      },
      scrollToElement() {
        // 代理better-scroll的scrollToElement方法
        this.scroll && this.scroll.scrollToElement.apply(this.scroll, arguments)
      }
    },
    watch: {
      // 监听数据的变化,延时refreshDelay时间后调用refresh方法重新计算,保证滚动效果正常
      data() {
        setTimeout(() => {
          this.refresh()
        }, this.refreshDelay)
      }
    }
  }
</script>

使用

<BetterScroll class="wrapper"
              :data="recordGroup"
              :pulldown="pulldown"
              :pullup="pullup"
              @pulldown="_pulldown"
              @pullup="_pullup">
  <div class="content">
    <recordGroup :recordGroup="recordGroup"></recordGroup>
    <p style="text-align:center;font-size: 14px;color: #666;" v-if="!pullup">
      没有更多数据
    </p>
  </div>
</BetterScroll>

<script>
import BetterScroll from '@/components/BetterScroll/BetterScroll.vue'

components: {RecordGroup},
data() {
  return {
    recordGroup: [],
    hasMore: true,
    PAGE_SIZE: 10,
    scrollNum: 0,
    pulldown: true,
    pullup: true,
  }
},

created() {
  this._pullup();
},

methods: {
  clear() {
    this.scrollNum = 0;
    this.recordGroup = [];
    this.hasMore = true;
  },
  //下拉刷新
  _pulldown(otherData) {
    console.log('正在下拉');
    this.clear();
    let data = {
      pageSize: this.PAGE_SIZE,
      startRow: this.PAGE_SIZE * this.scrollNum,
    };
    if (typeof otherData !== 'undefined') {
      Object.assign(data, data, otherData);
    }
    this._sendRequest(data);
  },
  //上拉加载
  _pullup(otherData) {
    console.log('正在上拉');
    if (this.hasMore === false) {
      console.log('没有更多了');
      this.pullup = false;
      return false;
    }
    let data = {
      pageSize: this.PAGE_SIZE,
      startRow: this.PAGE_SIZE * this.scrollNum,
    };
    if (typeof otherData !== 'undefined') {
      Object.assign(data, data, otherData);
    }
    console.log(data);
    this._sendRequest(data);
  },
  _sendRequest(data) {
    //上传信息
    this.$api.recordInterface.sendRequest(data).then(res => {
      res = res.data;
      console.log(res);
      if (res.success && typeof res.data !== 'undefined') {
        this.recordGroup = this.recordGroup.concat(res.data.dbPageList);
        this.hasMore = res.data.hasMore;
        this.scrollNum++;
        if (this.hasMore === false) {
          console.log('结果显示没有更多了');
          this.pullup = false;
        }
      } else {
        this.$vux.toast.show({type: "cancel", text: res.retMsg});
      }
    }).catch(err => {
      console.error(err);
    });
  },
}
</script>