better-scroll在vue中的應用

在我們日常的移動端項目開發中處理滾動列表是再常見不過的需求了以滴滴為例可以是這樣豎向滾動的列表如圖所示

微信 —> 錢包—>滴滴出行”體驗效果。

什么是 better-scroll better-scroll 是一個移動端滾動的解決方案它是基于 iscroll 的重寫它和 iscroll 的主要區別在 這里 。better-scroll 也很強大不僅可以做普通的滾動列表還可以做輪播圖、picker 等等。

不少同學可能用過 better-scroll我收到反饋最多的問題是

不能滾動是現象我們得搞清楚這其中的根本原因。在這之前我們先來看一下瀏覽器的滾動原理

那么對于 better-scroll 也是一樣的道理我們先來看一下 better-scroll 常見的 html 結構

<div class="wrapper">  <ul class="content">    <li>...</li>    <li>...</li>
    ...  </ul>
</div>

為了更加直觀我們再來看一張圖

固定的高度 。×××部分為 content它是父容器的第一個子元素它的高度會隨著內容的大小而撐高。那么當 content 的高度不超過父容器的高度是不能滾動的而它一旦超過了父容器的高度我們就可以滾動內容區了這就是 better-scroll 的滾動原理。

import BScroll from 'better-scroll' let wrapper = document.querySelector('.wrapper') let scroll = new BScroll(wrapper, {})

better-scroll 的文檔 。

scroll.refresh() 方法重新計算來確保滾動效果的正常。所以同學們反饋的 better-scroll 不能滾動的原因 多半是初始化 better-scroll 的時機不對或者是當 DOM 結構發送變化的時候并沒有重新計算 better-scroll 。

Vue.js 都不陌生當 better-scroll 遇見 Vue會擦出怎樣的火花呢

很多同學開始接觸使用 better-scroll 都是受到了我的一門教學課程—— 《Vue.js高仿餓了么外賣App》 的影響。在那門課程中我們把 better-scroll 和 Vue 做了結合實現了很多列表滾動的效果。在 Vue 中的使用方法如下

<template>  <div class="wrapper" ref="wrapper">    <ul class="content">      <li>...</li>      <li>...</li>
      ...    </ul>  </div></template><script>
  import BScroll from 'better-scroll'  export default {
    mounted() {      this.$nextTick(() => {        this.scroll = new Bscroll(this.$refs.wrapper, {})
      })
    }
  }</script>

js 提供了我們一個獲取 DOM 對象的接口—— vm.$refs 。在這里我們通過了 this.$refs.wrapper 訪問到了這個 DOM 對象并且我們在 mounted 這個鉤子函數里 this.$nextTick 的回調函數中初始化 better-scroll 。因為這個時候wrapper 的 DOM 已經渲染了我們可以正確計算它以及它內層 content 的高度以確保滾動正常。

this.$nextTick 是一個異步函數為了確保 DOM 已經渲染感興趣的同學可以了解一下它的 內部實現細節 底層用到了 MutationObserver 或者是 setTimeout(fn, 0) 。其實我們在這里把 this.$nextTick 替換成 setTimeout(fn, 20) 也是可以的20 ms 是一個經驗值每一個 Tick 約為 17 ms對用戶體驗而言都是無感知的。

在我們的實際工作中列表的數據往往都是異步獲取的因此我們初始化 better-scroll 的時機需要在數據獲取后代碼如下

<template>  <div class="wrapper" ref="wrapper">    <ul class="content">      <li v-for="item in data">`item`</li>    </ul>  </div></template><script>
  import BScroll from 'better-scroll'  export default {
    data() {      return {        data: []
      }
    },
    created() {
      requestData().then((res) => {        this.data = res.data        this.$nextTick(() => {          this.scroll = new Bscroll(this.$refs.wrapper, {})
        })
      })
    }
  }</script>

axios 或者 vue-resource 。我們獲取到數據的后需要通過異步的方式再去初始化 better-scroll因為 Vue 是數據驅動的 Vue 數據發生變化 this.data = res.data 到頁面重新渲染是一個異步的過程我們的初始化時機是要在 DOM 重新渲染后所以這里用到了 this.$nextTick 當然替換成 setTimeout(fn, 20) 也是可以的。

數據改變 —> DOM 重新渲染仍然是一個異步過程 所以即使在我們拿到數據后也要異步初始化 better-scroll。

我們在實際開發中除了數據異步獲取還有一些場景可以動態更新列表中的數據比如常見的下拉加載上拉刷新等。比如我們用 better-scroll 配合 Vue 實現下拉加載功能代碼如下

<template>  <div class="wrapper" ref="wrapper">    <ul class="content">      <li v-for="item in data">`item`</li>    </ul>    <div class="loading-wrapper"></div>  </div></template><script>
  import BScroll from 'better-scroll'  export default {
    data() {      return {        data: []
      }
    },
    created() {      this.loadData()
    },    methods: {
      loadData() {
        requestData().then((res) => {          this.data = res.data.concat(this.data)          this.$nextTick(() => {            if (!this.scroll) {              this.scroll = new Bscroll(this.$refs.wrapper, {})              this.scroll.on('touchend', (pos) => {                // 下拉動作                if (pos.y > 50) {                  this.loadData()
                }
              })
            } else {              this.scroll.refresh()
            }
          })
        })
      }
    }
  }</script>

這段代碼比之前稍微復雜一些, 當我們在滑動列表松開手指時候 better-scroll 會對外派發一個 touchend 事件我們監聽了這個事件并且判斷了 pos.y > 50我們把這個行為定義成一次下拉的動作。如果是下拉的話我們會重新請求數據并且把新的數據和之前的 data 做一次 concat也就更新了列表的數據那么數據的改變就會映射到 DOM 的變化。需要注意的一點這里我們對 this.scroll 做了判斷如果沒有初始化過我們會通過 new BScroll 初始化并且綁定一些事件否則我們會調用 this.scroll.refresh 方法重新計算來確保滾動效果的正常。

scroll 組件的抽象和封裝 因此我們有強烈的需求抽象出來一個 scroll 組件類似小程序的 scroll-view 組件方便開發者的使用。

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

<script type="text/ecmascript-6"> import BScroll from 'better-scroll' export default { 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) { let me = this this.scroll.on('scroll', (pos) => { me.$emit('scroll', pos) }) } // 是否派發滾動到底部事件用于上拉加載 if (this.pullup) { this.scroll.on('scrollEnd', () => { // 滾動到底部 if (this.scroll.y <= (this.scroll.maxScrollY + 50)) { this.$emit('scrollToEnd') } }) } // 是否派發頂部下拉事件用于下拉刷新 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>

有了這一層 scroll 組件的封裝我們來修改剛剛最復雜的代碼假設我們已經全局注冊了 scroll 組件。

<template>  <scroll class="wrapper"          :data="data"          :pulldown="pulldown"
          @pulldown="loadData">    <ul class="content">      <li v-for="item in data">`item`</li>    </ul>    <div class="loading-wrapper"></div>  </scroll></template><script>
  import BScroll from 'better-scroll'  export default {
    data() {      return {        data: [],        pulldown: true
      }
    },
    created() {      this.loadData()
    },    methods: {
      loadData() {
        requestData().then((res) => {          this.data = res.data.concat(this.data)
        })
      }
    }
  }</script>

插件 Vue 化引發的一些思考 這篇文章我不僅僅是要教會大家封裝一個 scroll 組件還想傳遞一些把第三方插件原生 JS 實現Vue 化的思考過程。很多學習 Vue.js 的同學可能還停留在 “XX 效果如何用 Vue.js 實現” 的程度其實把插件 Vue 化有兩點很關鍵一個是對插件本身的實現原理很了解另一個是對 Vue.js 的特性很了解。對插件本身的實現原理了解需要的是一個思考和鉆研的過程這個過程可能困難但是收獲也是巨大的而對 Vue.js 的特性的了解是需要大家對 Vue.js 多多使用學會從平時的項目中積累和總結也要善于查閱 Vue.js 的官方文檔關注一些 Vue.js 的升級等。