原生 JS 實現一個瀑布流插件

時間 2019-11-16

原文原文鏈接

瀑布流佈局中的圖片有一個核心特色 —— 等寬不定等高，瀑布流佈局在國內外網站都有必定規模的使用，好比pinterest、花瓣網等等。那麼接下來就基於這個特色開始瀑布流探索之旅。css

基礎功能實現

首先咱們定義好一個有 20 張圖片的容器，html

<body>
  <style> #waterfall { position: relative; } .waterfall-box { float: left; width: 200px; } </style>
</body>
<div id="waterfall">
    <img src="images/1.png" class="waterfall-box">
    <img src="images/2.png" class="waterfall-box">
    <img src="images/3.png" class="waterfall-box">
    <img src="images/4.png" class="waterfall-box">
    <img src="images/5.png" class="waterfall-box">
    <img src="images/6.png" class="waterfall-box">
    ...
  </div>
複製代碼

因爲未知的 css 知識點，絲襪最長的妹子把下面的空間都佔用掉了。。。react

接着正文，假如如上圖，每排有 5 列，那第 6 張圖片應該出現前 5 張圖片哪張的下面呢？固然是絕對定位到前 5 張圖片高度最小的圖片下方。git

那第 7 張圖片呢？這時候把第 6 張圖片和在它上面的圖片看成是一個總體後，思路和上述是一致的。代碼實現以下:github

Waterfall.prototype.init = function () {
  ...
  const perNum = this.getPerNum() // 獲取每排圖片數
  const perList = []              // 存儲第一列的各圖片的高度
  for (let i = 0; i < perNum; i++) {
    perList.push(imgList[i].offsetHeight)
  }

  let pointer = this.getMinPointer(perList) // 求出當前最小高度的數組下標

  for (let i = perNum; i < imgList.length; i++) {
    imgList[i].style.position = 'absolute' // 核心語句
    imgList[i].style.left = `${imgList[pointer].offsetLeft}px`
    imgList[i].style.top = `${perList[pointer]}px`

    perList[pointer] = perList[pointer] + imgList[i].offsetHeight // 數組最小的值加上相應圖片的高度
    pointer = this.getMinPointer(perList)
  }
}
複製代碼

細心的朋友也許發現了代碼中獲取圖片的高度用到了 offsetHeight 這個屬性，這個屬性的高度之和等於圖片高度 + 內邊距 + 邊框，正由於此，咱們用了 padding 而不是 margin 來設置圖片與圖片之間的距離。此外除了offsetHeight 屬性，此外還要理解 offsetHeight、clientHeight、offsetTop、scrollTop 等屬性的區別，才能比較好的理解這個項目。css 代碼簡單以下：ajax

.waterfall-box {
  float: left;
  width: 200px;
  padding-left: 10px;
  padding-bottom: 10px;
}
複製代碼

至此完成了瀑布流的基本佈局，效果圖以下：數組

scroll、resize 事件監聽的實現

實現了初始化函數 init 之後，下一步就要實現對 scroll 滾動事件進行監聽，從而實現當滾到父節點的底部有源源不斷的圖片被加載出來的效果。這時候要考慮一個點，是滾動到什麼位置時觸發加載函數呢？這個因人而異，個人作法是當知足 父容器高度 + 滾動距離 > 最後一張圖片的 offsetTop 這個條件，即橙色線條 + 紫色線條 > 藍色線條時觸發加載函數，代碼以下：瀏覽器

window.onscroll = function() {
  // ...
  if (scrollPX + bsHeight > imgList[imgList.length - 1].offsetTop) {// 瀏覽器高度 + 滾動距離 > 最後一張圖片的 offsetTop
    const fragment = document.createDocumentFragment()
    for(let i = 0; i < 20; i++) {
      const img = document.createElement('img')
      img.setAttribute('src', `images/${i+1}.png`)
      img.setAttribute('class', 'waterfall-box')
      fragment.appendChild(img)
    }
    $waterfall.appendChild(fragment)
  }
}
複製代碼

由於父節點可能自定義節點，因此提供了對監聽 scroll 函數的封裝，代碼以下：緩存

proto.bind = function () {
    const bindScrollElem = document.getElementById(this.opts.scrollElem)
    util.addEventListener(bindScrollElem || window, 'scroll', scroll.bind(this))
  }

  const util = {
    addEventListener: function (elem, evName, func) {
      elem.addEventListener(evName, func, false)
    },
  }
複製代碼

resize 事件的監聽與 scroll 事件監聽大同小異，當觸發了 resize 函數，調用 init 函數進行重置就行。app

使用發佈-訂閱模式和繼承實現監聽綁定

既然以開發插件爲目標，不能僅僅知足於功能的實現，還要留出相應的操做空間給開發者自行處理。聯想到業務場景中瀑布流中下拉加載的圖片通常都來自 Ajax 異步獲取，那麼加載的數據必然不能寫死在庫裏，指望能實現以下調用(此處借鑑了 waterfall 的使用方式)，

const waterfall = new Waterfall({options})

waterfall.on("load", function () {
  // 此處進行 ajax 同步/異步添加圖片
})
複製代碼

觀察調用方式，不難聯想到使用發佈/訂閱模式來實現它，關於發佈/訂閱模式，以前在 Node.js 異步異聞錄有介紹它。其核心思想即經過訂閱函數將函數添加到緩存中，而後經過發佈函數實現異步調用，下面給出其代碼實現:

function eventEmitter() {
  this.sub = {}
}

eventEmitter.prototype.on = function (eventName, func) { // 訂閱函數
  if (!this.sub[eventName]) {
    this.sub[eventName] = []
  }
  this.sub[eventName].push(func) // 添加事件監聽器
}

eventEmitter.prototype.emit = function (eventName) { // 發佈函數
  const argsList = Array.prototype.slice.call(arguments, 1)
  for (let i = 0, length = this.sub[eventName].length; i < length; i++) {
    this.sub[eventName][i].apply(this, argsList) // 調用事件監聽器
  }
}
複製代碼

接着，要讓 Waterfall 能使用發佈/訂閱模式，只需讓 Waterfall 繼承 eventEmitter 函數，代碼實現以下:

function Waterfall(options = {}) {
  eventEmitter.call(this)
  this.init(options) // 這個 this 是 new 的時候，綁上去的
}

Waterfall.prototype = Object.create(eventEmitter.prototype)
Waterfall.prototype.constructor = Waterfall
複製代碼

繼承方式的寫法吸取了基於構造函數繼承和基於原型鏈繼承兩種寫法的優勢，以及使用 Object.create 隔離了子類和父類，關於繼承更多方面的細節，能夠另寫一篇文章了，此處點到爲止。

小優化

爲了防止 scroll 事件觸發屢次加載圖片，能夠考慮用函數防抖與節流實現。在基於發佈-訂閱模式的基礎上，定義了個 isLoading 參數表示是否在加載中，並根據其布爾值決定是否加載，代碼以下：

let isLoading = false
const scroll = function () {
  if (isLoading) return false // 避免一次觸發事件屢次
  if (scrollPX + bsHeight > imgList[imgList.length - 1].offsetTop) { // 瀏覽器高度 + 滾動距離 > 最後一張圖片的 offsetTop
    isLoading = true
    this.emit('load')
  }
}

proto.done = function () {
  this.on('done', function () {
    isLoading = false
    ...
  })
  this.emit('done')
}
複製代碼

這時候須要在調用的地方加上 waterfall.done, 從而告知當前圖片已經加載完畢，代碼以下:

const waterfall = new Waterfall({})
waterfall.on("load", function () {
  // 異步/同步加載圖片
  waterfall.done()
})
複製代碼

項目地址

此插件在 React 項目中的運用

項目簡陋，不足之處在所不免，歡迎留下大家寶貴的意見。

相關標籤/搜索

每日一句

每一个你不满意的现在，都有一个你没有努力的曾经。