您好,登錄后才能下訂單哦!
這篇文章主要講解了“怎么在Vue2中自定義一個圖片懶加載指令”,文中的講解內容簡單清晰,易于學習與理解,下面請大家跟著小編的思路慢慢深入,一起來研究和學習“怎么在Vue2中自定義一個圖片懶加載指令”吧!
自定義圖片懶加載指令主要涉及以下三塊知識:
Vue2 中自定義指令
使用事件總線進行模塊之間的通信
使用到的 Web API
Element.clientHeight
Element.getBoundingClientRect()
下面我會對這些知識點進行一一介紹。
下面我只對自定義指令做簡單的介紹,詳細介紹大家可以參照Vue 官網 - 自定義指令。
bind:只調用一次,指令第一次綁定到元素時調用。在這里可以進行一次性的初始化設置。
inserted:被綁定元素插入父節點時調用 (僅保證父節點存在,但不一定已被插入文檔中)。
update:所在組件的 VNode 更新時調用,但是可能發生在其子 VNode 更新之前。指令的值可能發生了改變,也可能沒有。可通過比較更新前后的值來忽略不必要的模板更新 (詳細的鉤子函數參數見下)。
componentUpdated:指令所在組件的 VNode 及其子 VNode 全部更新后調用。
unbind:只調用一次,指令與元素解綁時調用。
鉤子函數的參數主要有這四個el、binding、vnode、oldVnode
。
el:指令所綁定的元素,可以用來直接操作 DOM。
binding:一個對象,包含以下 property:
name:指令名,不包括 v- 前綴。
value:指令的綁定值,如:v-my-directive="1 + 1" 中,綁定值為 2。
oldValue:指令綁定的前一個值,僅在 update 和 componentUpdated 鉤子中可用。無論值是否改變都可用。
expression:字符串形式的指令表達式。如 v-my-directive="1 + 1" 中,表達式為 "1 + 1"。
arg:傳給指令的參數,可選。例如 v-my-directive:foo 中,參數為 "foo"。
modifiers:一個包含修飾符的對象。例如:v-my-directive.foo.bar 中,修飾符對象為 { foo: true, bar: true }。
vnode:Vue 編譯生成的虛擬節點。移步 VNode API 來了解更多詳情。
oldVnode:上一個虛擬節點,僅在 update 和 componentUpdated 鉤子中可用。
對事件總線不熟悉的朋友,可以參照該博客什么是 Vue 事件總線(EventBus)。
監聽事件總線上的事件---調用 $on 方法
觸發事件總線上的事件---調用 $emit 方法
取消監聽事件總線上的事件---調用 $off 方法
我們可以借助 vue 示例來實現事件總線,也可以自行封裝;我使用了第一種方法。
因此事件總線配置文件---eventBus.js
的代碼如下:
import Vue from "vue"; const eventBus = new Vue({}); /* * 事件名:mainScroll * 含義:主區域滾動條位置變化后觸發 * 參數: * - 滾動的dom元素,如果是undefined,則表示dom元素已經不存在 */ //在Vue.prototype原型上注冊事件總線,方便vue實例對象監聽和觸發 Vue.prototype.$bus = eventBus; //導出事件總線,方便在其他js模塊監聽和觸發事件總線上的事件 export default eventBus;
首先Element.clientHeight
是一個只讀屬性,具有以下特點:
對于那些沒有定義 CSS 或者內聯布局盒子的元素,該 API 會返回 0;
對于根元素(html 元素)或怪異模式下的 body 元素,該 API 將返回視口高度(不包含任何滾動條)
其他情況,該 API 會返回元素內部的高度(以像素為單位),包含content
與padding
,不包含border
、margin
與水平滾動條(如果存在)。
另外改 API 會將獲取的值四舍五入取整數。如果你需要小數結果,可以使用 element.getBoundingClientRect()方法。
示例圖如下:
Element.getBoundingClientRect()
方法返回一個DOMRect
對象,其提供了元素的大小及其相對于視口的位置。
該方法無參數,返回值為DOMRect
對象,該對象的屬性以下幾個:
width:就是元素自身寬度
height: 元素自身高度
left(x):元素開始位置到窗口左邊的距離
right: 元素的右邊到窗口左邊的距離
bottom: 元素的下邊到窗口上邊的距離
top(y): 元素的上邊到窗口上邊的距離
x 和 y 相當于 left 和 top
示意圖如下:
該 API 的詳細文檔可以參照MDN - Element.getBoundingClientRect()
由于在個人博客系統中圖片懶加載指令使用的比較頻繁,使用我選擇了全局注冊該指令。
另外因為我使用事件總線這方法來自己通信,使用還需引入事件總線配置文件---eventBus.js
所以 main.js入口文件
的代碼如下:
import Vue from "vue"; import App from "./App.vue"; import "./eventBus"; //引入事件總線 import vLazy from "./directives/lazy"; Vue.directive("lazy", vLazy); //全局注冊指令 new Vue({ render: (h) => h(App), }).$mount("#app");
使用 v-lazy 指令的示例代碼如下:
<template> <div class="container"> <ul> <li v-for="img in imgs" :key="img.id"> <img v-lazy="img.src" :alt="img.alt" :title="img.title" /> </li> </ul> </div> </template> <script> export default { data() { return { imgs: [ { id: "", src: "", alt: "", title: "", }, ], }; }, //下面的代碼可以用組件混入來進行封裝,從而優化代碼結構 methods: { //觸發mainScroll事件 handleMainScroll() { this.$bus.$emit("mainScroll", this.$refs.container); }, }, mounted() { //監聽滾輪事件 this.$refs.container.addEventListener("scroll", this.handleMainScroll); }, beforeDestroy() { this.$bus.$emit("mainScroll");//參數傳入undefined,表示dom元素已經不存在 //取消監聽滾輪事件 this.$refs.container.removeEventListener("scroll", this.handleMainScroll); }, }; </script>
要實現圖片懶加載效果,我們首先要思考以下四個關鍵問題:
如何監聽容器的滾動條的滾動?
使用自定義指令哪些鉤子函數?
如何判斷圖片 img 元素是否在用戶的可見范圍內?
如何處理圖片 img 元素的加載?
對于這問題,由于我的博客系統在處理其他組件之間的傳值問題時,使用了事件總線方法,所以為了方便,我也使用這一方法,當然大家可以針對實際場景使用其他方法來解決這問題。
所以我們要在 v-lazy 圖片懶加載指令配置文件---lazy.js
文件中監聽事件總線 eventBus 中的mainScroll事件
,同時為了性能優化,我們需要進行 mainScroll 事件的事件防抖
。
其中事件防抖工具函數---debounce.js
代碼如下:
/** * @param {Function} fn 需要進行防抖操作的事件函數 * @param {Number} duration 間隔時間 * @returns {Function} 已進行防抖的函數 */ export default function (fn, duration = 100) { let timer = null; return (...args) => { clearTimeout(timer); timer = setTimeout(() => { fn(...args); }, duration); }; }
圖片懶加載指令配置文件---lazy.js
該部分代碼如下:
import eventBus from "@/eventBus"; //引入事件總線 import { debounce } from "@/utils"; //引入函數防抖工具函數 // 調用setImages函數,就可以處理那些符合條件的圖片 function setImages() {} //監聽事件總線中的mainScroll事件,該事件觸發時調用setImages函數來加載圖片 eventBus.$on("mainScroll", debounce(setImages, 50));
經過場景分析,我選用了inserted
和unbind
這兩個鉤子函數,當 img 元素剛插入父節點時收集 img 的信息,并在內部使用一個 imgs 數組存儲已收集到的信息,當指令與元素解綁時,進行 imgs 數組清空操作。
另外我們還需獲取圖片 img 元素的 DOM 節點和 src 屬性值
由于我們將指令綁定到了 img'元素上,所以可通過自定義指令鉤子函樹中的el參數
得到其 DOM 節點
由于我們將 src 值傳給了指令,所以可通過bindings.value參數
得到其 src 屬性值
所以此時圖片懶加載指令配置文件---lazy.js
該部分代碼如下:
import eventBus from "@/eventBus"; //引入事件總線 import { debounce } from "@/utils"; //引入函數防抖工具函數 // 調用setImages函數,就可以處理那些符合條件的圖片 function setImages() {} //監聽事件總線中的mainScroll事件,該事件觸發時調用setImages函數來加載圖片 eventBus.$on("mainScroll", debounce(setImages, 50)); //上面代碼是3.1 如何監聽容器的滾動條的滾動? //下面代碼是3.2 使用自定義指令哪些鉤子函數? let imgs = []; //存儲收集到的的圖片信息 當圖片加載好后刪除該圖片信息 //調用setImage函數,就可以進行單張圖片的加載 function setImage(img) {} export default { inserted(el, bindings) { //剛插入父節點時 收集img節點信息 const img = { dom: el, //img 元素DOM節點 src: bindings.value, //img的src屬性值 }; imgs.push(img); //先將圖片信息存儲到imgs數組 setImage(img); // 立即判斷該圖片是否要加載 }, unbind(el) { //解綁時 刪除 imgs 中的所有圖片信息 imgs = imgs.filter((img) => img.dom !== el); }, };
對于上面這問題,我們先進行問題拆分:
1、獲得用戶的可見范圍(視口)
由于我的博客系統只需考慮視口高度,所以我只使用了Element.clientHeight
這 API。(如果還需要考慮寬度就再使用Element.clientWidth)
2、獲得圖片 img 元素的位置信息
我使用了Element.getBoundingClientRect()
這 API。
3、判斷圖片 img 元素是否在視口內
img.getBoundingClientRect().top > 0 時,說明圖片在視口內或視口下方
當 img.getBoundingClientRect().top <= document.documentElement.clientHeight 時,該 img 元素在視口內
反之則不在視口內
img.getBoundingClientRect().top < 0 時,說明圖片在視口內或視口上方
當-img.getBoundingClientRect().top <= img.getBoundingClientRect().height 時,該 img 元素在視口內
反之則不在視口內
圖片懶加載指令配置文件---lazy.js
該部分代碼如下:
import eventBus from "@/eventBus"; //引入事件總線 import { debounce } from "@/utils"; //引入函數防抖工具函數 let imgs = []; //存儲收集到的的圖片信息 // 調用setImages函數,就可以處理那些符合條件的圖片 function setImages() { for (const img of imgs) { setImage(img); // 處理該圖片 } } //監聽事件總線中的mainScroll事件,該事件觸發時調用setImages函數來加載符合條件圖片 eventBus.$on("mainScroll", debounce(setImages, 50)); //當圖片加載好后刪除該圖片信息 export default { inserted(el, bindings) { //剛插入父節點時 收集img節點信息 const img = { dom: el, //img 元素DOM節點 src: bindings.value, //img的src屬性值 }; imgs.push(img); //先將圖片信息存儲到imgs數組 setImage(img); // 立即判斷該圖片是否要加載 }, unbind(el) { //解綁時 刪除 imgs 中的所有圖片信息 imgs = imgs.filter((img) => img.dom !== el); }, }; //上面代碼是3.1 如何監聽容器的滾動條的滾動?+ 3.2 使用自定義指令哪些鉤子函數? //下面代碼是3.3 如何判斷圖片 img 元素是否在用戶的可見范圍內? //調用setImage函數,就可以進行單張圖片的加載 function setImage(img) { const clientHeight = document.documentElement.clientHeight; //視口高度 const rect = img.dom.getBoundingClientRect(); //圖片的位置信息 //取默認值150 是為了解決圖片未加載成功時高度缺失的問題 const height = rect.height || 150; //圖片的高度 // 判斷該圖片是否在視口范圍內 if (rect.top >= -height && rect.top <= clientHeight) { // 在視口范圍內 進行相關處理操作 } else { // 不在視口范圍內 不進行操作 } }
由效果圖我們可看出一開始所有 img 元素都是一張默認的 GIF 圖片---defaultGif
,等該 img 元素進入到視口范圍時,開始加載該圖片,加載完成后再進行替換。
這里我還進行一個優化操作,就是先新建一個 Image 對象實例
,代替 img 元素加載圖片,因為圖片加載完成后會觸發onload事件
,所以我們只需對onload事件
進行改寫,在其內部執行 img 元素的 src 屬性替換操作,這樣就解決了加載過程中圖片空白的情況。
所以圖片懶加載指令配置文件---lazy.js
完整的代碼如下:
import eventBus from "@/eventBus"; //引入事件總線 import { debounce } from "@/utils"; //引入函數防抖工具函數 import defaultGif from "@/assets/default.gif"; //在assets靜態文件夾下放入默認圖 let imgs = []; //存儲收集到的且未加載的圖片信息 //調用setImage函數,就可以進行單張圖片的加載 function setImage(img) { img.dom.src = defaultGif; // 先暫時使用默認圖片 const clientHeight = document.documentElement.clientHeight; //視口高度 const rect = img.dom.getBoundingClientRect(); //圖片的位置信息 //取默認值150 是為了解決圖片未加載成功時 高度缺失的問題 const height = rect.height || 150; //圖片的高度 // 判斷該圖片是否在視口范圍內 if (-rect.top <= height && rect.top <= clientHeight) { // 在視口范圍內 進行相關處理操作 const tempImg = new Image(); //新建Image對象實例 //改寫onload事件 tempImg.onload = function () { // 當圖片加載完成之后 img.dom.src = img.src; //替換img元素的src屬性 }; tempImg.src = img.src; imgs = imgs.filter((i) => i !== img); //將已加載好的圖片進行刪除 } } // 調用setImages函數,就可以處理那些符合條件的圖片 function setImages() { for (const img of imgs) { setImage(img); // 處理該圖片 } } //監聽事件總線中的mainScroll事件,該事件觸發時調用setImages函數來加載符合條件圖片 eventBus.$on("mainScroll", debounce(setImages, 50)); //當圖片加載好后刪除該圖片信息 export default { inserted(el, bindings) { //剛插入父節點時 收集img節點信息 const img = { dom: el, //img 元素DOM節點 src: bindings.value, //img的src屬性值 }; imgs.push(img); //先將圖片信息存儲到imgs數組 setImage(img); // 立即判斷該圖片是否要加載 }, unbind(el) { //解綁時 清空 imgs imgs = imgs.filter((img) => img.dom !== el); }, };
感謝各位的閱讀,以上就是“怎么在Vue2中自定義一個圖片懶加載指令”的內容了,經過本文的學習后,相信大家對怎么在Vue2中自定義一個圖片懶加載指令這一問題有了更深刻的體會,具體使用情況還需要大家實踐驗證。這里是億速云,小編將為大家推送更多相關知識點的文章,歡迎關注!
免責聲明:本站發布的內容(圖片、視頻和文字)以原創、轉載和分享為主,文章觀點不代表本網站立場,如果涉及侵權請聯系站長郵箱:is@yisu.com進行舉報,并提供相關證據,一經查實,將立刻刪除涉嫌侵權內容。