Vue2常用全局自定義指令的封裝詳解
更新時間：2025年02月08日 10:23:36 作者：初陽chuyang
這篇文章主要為大家詳細(xì)介紹了Vue2中多種常用全局自定義指令的封裝,包括一鍵復(fù)制,一鍵長按,圖片懶加載等功能,感興趣的小伙伴可以了解下
準(zhǔn)備工作
創(chuàng)建目錄文件：src/directive/index.js
import copy from "./copy";
import longpress from "./longpress"
import debounce from "./debounce";
import emoji from "./emoji";
import LazyLoad from "./LazyLoad";
import permission from "./permission";
import waterMarker from "./waterMarker";
import draggable from "./draggable";
import empty from "./empty";
const directives = {
copy,longpress,debounce,emoji,LazyLoad,permission,waterMarker,draggable,empty
};
export default {
install(Vue) {
Object.keys(directives).forEach((key) => {
Vue.directive(key, directives[key]);
});
},
};然后再main.js中引入并注冊
// 引入全局自定義指令 import directive from './directive' Vue.use(directive)
注釋：自定義指令的鉤子函數(shù)
- bind: 只調(diào)用一次,指令第一次綁定到元素時使用,可以用這個鉤子函數(shù)定義一個在綁定時執(zhí)行一次的初始動作
- inserted: 被綁定的元素插入父節(jié)點時調(diào)用,(父節(jié)點存在即可調(diào)用,不必存在于document中)
- update: 被綁定元素所在的模板更新時調(diào)用,而不論綁定值是否變化,通過比較更新前后的變化,可以忽略掉不必要的更新
- componentUpdated: 被綁定元素所在模板完成一次更新周期時調(diào)用
- unbind: 只調(diào)用一次,指令與元素解綁時調(diào)用
鉤子函數(shù)的參數(shù)的注意事項:
- el: 指令所綁定的元素,可以用來直接操作DOM
- binding: 一個對象,包含以下屬性:
- name: 指令名,不包括v-前綴
- value: 指令的綁定值,這個值就是使用的時候傳進來的,如果是指就直接復(fù)制,如果是函數(shù)可以直接調(diào)用
- oldValue: 指令綁定的上一個值,僅在update和componentUpdated中可用,無論值是否改變都可用
- expression: 綁定值的表達(dá)式或變量名,
- arg: 傳給指令的參數(shù),例如v-my-directive：foo，arg的值是"foo"
- modifiers：一個包含修飾符的對象，例如v-my-directive.foo.bar，修飾符對象modifiers的值是{foo：true，bar：true}
- vnode：Vue編譯生成的虛擬節(jié)點。
- oldVnode：上一個虛擬節(jié)點，僅在update和componentUpdated鉤子中可用。
除了 el 之外，其它參數(shù)都應(yīng)該是只讀的，切勿進行修改。
一鍵復(fù)制
需求: 實現(xiàn)一鍵復(fù)制文本內(nèi)容,用于鼠標(biāo)右鍵粘貼
思路：
動態(tài)創(chuàng)建 textarea 標(biāo)簽，并設(shè)置 readOnly 屬性及移出可視區(qū)域
將要復(fù)制的值賦給 textarea 標(biāo)簽的 value 屬性，并插入到 body
選中值 textarea 并復(fù)制
將 body 中插入的 textarea 移除
在第一次調(diào)用時綁定事件，在解綁時移除事件
export default {
bind(el, { value }) {
el.$value = value;
el.handler = () => {
if (!el.$value) {
// 值為空的時候，給出提示。可根據(jù)項目UI仔細(xì)設(shè)計
console.log("無復(fù)制內(nèi)容");
return;
}
// 動態(tài)創(chuàng)建 textarea 標(biāo)簽
const textarea = document.createElement("textarea");
// 將該 textarea 設(shè)為 readonly 防止 iOS 下自動喚起鍵盤，同時將 textarea 移出可視區(qū)域
textarea.readOnly = "readonly";
textarea.style.position = "absolute";
textarea.style.left = "-9999px";
// 將要 copy 的值賦給 textarea 標(biāo)簽的 value 屬性
textarea.value = el.$value;
// 將 textarea 插入到 body 中
document.body.appendChild(textarea);
// 選中值并復(fù)制
textarea.select();
const result = document.execCommand("Copy");
if (result) {
console.log("復(fù)制成功"); // 可根據(jù)項目UI仔細(xì)設(shè)計
}
document.body.removeChild(textarea);
};
// // 綁定點擊事件，就是所謂的一鍵 copy 啦
el.addEventListener("click", el.handler);
},
// 當(dāng)傳進來的值更新的時候觸發(fā)
componentUpdated(el, { value }) {
el.$value = value;
},
// 指令與元素解綁的時候，移除事件綁定
unbind(el) {
el.removeEventListener("click", el.handler);
},
};
<button v-copy="copyContent">點擊復(fù)制</button>
data(){
return {
copyContent: "復(fù)制出來的信息",
}
}
一鍵長按
需求：
實現(xiàn)長按，用戶需要按下并按住按鈕幾秒鐘，觸發(fā)相應(yīng)的事件
思路：
創(chuàng)建一個計時器， 2 秒后執(zhí)行函數(shù)
當(dāng)用戶按下按鈕時觸發(fā) mousedown 事件，啟動計時器；用戶松開按鈕時調(diào)用 mouseout 事件。
如果 mouseup 事件 2 秒內(nèi)被觸發(fā)，就清除計時器，當(dāng)作一個普通的點擊事件
如果計時器沒有在 2 秒內(nèi)清除，則判定為一次長按，可以執(zhí)行關(guān)聯(lián)的函數(shù)。
在移動端要考慮 touchstart，touchend 事件
export default {
bind: function (el, binding, vNode) {
// 判斷類型
if (typeof binding.value !== "function") {
throw "callback must be a function";
}
// 定義變量
let pressTimer = null;
// 創(chuàng)建定時器,兩秒后執(zhí)行
let start = (e) => {
if (e.type === "click" && e.button !== 0) {
return;
}
if (pressTimer === null) {
pressTimer = setTimeout(() => {
handler();
}, 2000);
}
};
// 取消定時器
let cancel = (e) => {
if (pressTimer !== null) {
clearTimeout(pressTimer);
pressTimer = null;
}
};
// 運行函數(shù)
const handler = (e) => {
binding.value(e);
};
// 添加事件監(jiān)聽器
el.addEventListener("mousedown", start);
el.addEventListener("touchstart", start);
// 取消計時器
el.addEventListener("click", cancel);
el.addEventListener("mouseout", cancel);
el.addEventListener("touchend", cancel);
el.addEventListener("touchcancel", cancel);
},
// 當(dāng)傳進來的值更新的時候觸發(fā)
componentUpdated(el, { value }) {
el.$value = value;
},
// 指令與元素解綁的時候，移除事件綁定
unbind(el) {
el.removeEventListener("click", el.handler);
},
};
<!-- longpress 必須是一個函數(shù) --> <button v-longpress="longpress">兩秒長按</button>
防抖
需求：
防止按鈕在短時間內(nèi)被多次點擊，使用防抖函數(shù)限制規(guī)定時間內(nèi)只能點擊一次。
思路：
定義一個延遲執(zhí)行的方法，如果在延遲時間內(nèi)再調(diào)用該方法，則重新計算執(zhí)行時間。
將時間綁定在 click 方法上。
export default {
inserted: function(el,binding) {
let timer;
el.addEventListener("click", () => {
if(timer) {
clearTimeout(timer)
}
timer = setTimeout(() => {
binding.value()
},1000)
})
}
}
<!-- 防抖 -->
<button v-debounce="debounceClick">點擊防抖</button>
debounceClick() {
console.log("就應(yīng)該只觸發(fā)一次");
},
限制輸入框類型
開發(fā)中遇到的表單輸入，往往會有對輸入內(nèi)容的限制，比如不能輸入表情和特殊字符，只能輸入數(shù)字或字母等。
我們常規(guī)方法是在每一個表單的 on-change 事件上做處理。這樣代碼量比較大而且不好維護
需求：
根據(jù)正則表達(dá)式，設(shè)計自定義處理表單輸入規(guī)則的指令，下面以禁止輸入表情和特殊字符為例。
let findEle = (parent, type) => {
return parent.tagName.toLowerCase() === type
? parent
: parent.querySelector(type);
};
const trigger = (el, type) => {
const e = document.createEvent("htmlEvents");
e.initEvent(type, true, true);
el.dispatchEvent(e);
};
export default {
bind: function (el, binding, vnode) {
// 正則規(guī)則可根據(jù)需求自定義
// var regRule = /[^u4E00-u9FA5|d|a-zA-Z|rns,.?!，。？！…—&$=()-+/*{}[]]|s/g;
var regRule = /[^\u4E00-\u9FA5\dA-Za-z]|/g; // 只能輸入中文,英文和數(shù)字
let $inp = findEle(el, "input");
el.$inp = $inp;
$inp.handle = function () {
let val = $inp.value;
$inp.value = val.replace(regRule, "");
trigger($inp, "input");
};
$inp.addEventListener("keyup", $inp.handle);
},
unbind: function (el) {
el.$inp.removeEventListener("keyup", el.$inp.handle);
},
};
使用
<!-- 限制輸入類型 --> <input type="text" v-model="value" v-emoji>
圖片懶加載
需求：實現(xiàn)一個圖片懶加載指令，只加載瀏覽器可見區(qū)域的圖片。
思路：
圖片懶加載的原理主要是判斷當(dāng)前圖片是否到了可視區(qū)域這一核心邏輯實現(xiàn)的
拿到所有的圖片 Dom ，遍歷每個圖片判斷當(dāng)前圖片是否到了可視區(qū)范圍內(nèi)
如果到了就設(shè)置圖片的 src 屬性，否則顯示默認(rèn)圖片
圖片懶加載有兩種方式可以實現(xiàn)，一是綁定 srcoll 事件進行監(jiān)聽，二是使用 IntersectionObserver 判斷圖片是否到了可視區(qū)域，
但是有瀏覽器兼容性問題。
下面封裝一個懶加載指令兼容兩種方法，判斷瀏覽器是否支持 IntersectionObserver API，
如果支持就使用 IntersectionObserver 實現(xiàn)懶加載，否則則使用 srcoll 事件監(jiān)聽 + 節(jié)流的方法實現(xiàn)。
使用時:<img v-LazyLoad="xxx.jpg" /> 將組件內(nèi) 標(biāo)簽的 src 換成 v-LazyLoad
export default {
install(Vue, options) {
const defaultSrc = options.default;
Vue.directive("lazy", {
bind(el, binding) {
LazyLoad.init(el, binding.value, defaultSrc);
},
inserted(el) {
if (IntersectionObserver) {
LazyLoad.observe(el);
} else {
LazyLoad.listenerScroll(el);
}
},
});
},
// 初始化
init(el, val, def) {
el.setAttribute("data-src", val);
el.setAttribute("src", def);
},
// 利用IntersectionObserver監(jiān)聽el
observe(el) {
var io = new IntersectionObserver((entries) => {
const realSrc = el.dataset.src;
if (entries[0].isIntersecting) {
if (realSrc) {
el.src = realSrc;
el.removeAttribute("data-src");
}
}
});
io.observe(el);
},
// 監(jiān)聽scroll事件
listenerScroll(el) {
const handler = LazyLoad.throttle(LazyLoad.load, 300);
LazyLoad.load(el);
window.addEventListener("scroll", () => {
handler(el);
});
},
// 加載真實圖片
load(el) {
const windowHeight = document.documentElement.clientHeight;
const elTop = el.getBoundingClientRect().top;
const elBtm = el.getBoundingClientRect().bottom;
const realSrc = el.dataset.src;
if (elTop - windowHeight < 0 && elBtm > 0) {
if (realSrc) {
el.src = realSrc;
el.removeAttribute("data-src");
}
}
},
// 節(jié)流
throttle(fn, delay) {
let timer;
let prevTime;
return function (...args) {
const currTime = Date.now();
const context = this;
if (!prevTime) prevTime = currTime;
clearTimeout(timer);
if (currTime - prevTime > delay) {
prevTime = currTime;
fn.apply(context, args);
clearTimeout(timer);
return;
}
timer = setTimeout(function () {
prevTime = Date.now();
timer = null;
fn.apply(context, args);
}, delay);
};
},
};
頁面內(nèi)指定容器的權(quán)限判斷
背景：
在一些后臺管理系統(tǒng)，我們可能需要根據(jù)用戶角色進行一些操作權(quán)限的判斷，
很多時候我們都是粗暴地給一個元素添加 v-if / v-show 來進行顯示隱藏，
但如果判斷條件繁瑣且多個地方需要判斷，這種方式的代碼不僅不優(yōu)雅而且冗余。
針對這種情況，我們可以通過全局自定義指令來處理。
需求：自定義一個權(quán)限指令，對需要權(quán)限判斷的 Dom 進行顯示隱藏。
思路：
自定義一個權(quán)限數(shù)組
判斷用戶的權(quán)限是否在這個數(shù)組內(nèi)，如果是則顯示，否則則移除 Dom
function checkArray(key) {
let arr = ["1", "2", "3", "4"];
let index = arr.indexOf(key);
if (index > -1) {
return true; // 有權(quán)限
} else {
return false; // 無權(quán)限
}
}
export default {
inserted: function (el, binding) {
let permission = binding.value; // 獲取到 v-permission的值
if (permission) {
let hasPermission = checkArray(permission);
if (!hasPermission) {
// 沒有權(quán)限 移除Dom元素
el.parentNode && el.parentNode.removeChild(el);
}
}
},
};使用時:示例
<!-- 顯示 --> <button v-permission="'1'">權(quán)限按鈕1</button> <!-- 不顯示 --> <button v-permission="'10'">權(quán)限按鈕2</button></div>
頁面添加水印
需求：給整個頁面添加背景水印
思路：
使用 canvas 特性生成 base64 格式的圖片文件，設(shè)置其字體大小，顏色等。
將其設(shè)置為背景圖片，從而實現(xiàn)頁面或組件水印效果
function addWaterMarker(str, parentNode, font, textColor) {
// 水印文字，父元素，字體，文字顏色
var can = document.createElement("canvas");
parentNode.appendChild(can);
can.width = 200;
can.height = 150;
can.style.display = "none";
var cans = can.getContext("2d");
cans.rotate((-20 * Math.PI) / 180);
cans.font = font || "16px Microsoft JhengHei";
cans.fillStyle = textColor || "rgba(180, 180, 180, 0.3)";
cans.textAlign = "left";
cans.textBaseline = "Middle";
cans.fillText(str, can.width / 10, can.height / 2);
parentNode.style.backgroundImage = "url(" + can.toDataURL("image/png") + ")";
}
export default {
bind: function (el, binding) {
addWaterMarker(binding.value.text, el, binding.value.font, binding.value.textColor)
},
}
使用時:
<div v-waterMarker="{text:'bjg版權(quán)所有',textColor:'rgba(180, 180, 180, 0.4)'}"></div>
指定 DOM 拖拽
需求：
實現(xiàn)一個拖拽指令，可在頁面可視區(qū)域任意拖拽元素。
思路：
設(shè)置需要拖拽的元素為相對定位，其父元素為絕對定位。
鼠標(biāo)按下(onmousedown)時記錄目標(biāo)元素當(dāng)前的 left 和 top 值。
鼠標(biāo)移動(onmousemove)時計算每次移動的橫向距離和縱向距離的變化值，并改變元素的 left 和 top 值
鼠標(biāo)松開(onmouseup)時完成一次拖拽
export default {
inserted: function (el) {
el.style.cursor = "move";
el.onmousedown = function (e) {
let disx = e.pageX - el.offsetLeft;
let disy = e.pageY - el.offsetTop;
document.onmousemove = function (e) {
let x = e.pageX - disx;
let y = e.pageY - disy;
let maxX =
document.body.clientWidth -
parseInt(window.getComputedStyle(el).width);
let maxY =
document.body.clientHeight -
parseInt(window.getComputedStyle(el).height);
if (x < 0) {
x = 0;
} else if (x > maxX) {
x = maxX;
}
if (y < 0) {
y = 0;
} else if (y > maxY) {
y = maxY;
}
el.style.left = x + "px";
el.style.top = y + "px";
};
document.onmouseup = function () {
document.onmousemove = document.onmouseup = null;
};
};
},
};
使用時:
<div class="el-dialog" v-draggable></div>
指定容器根據(jù)內(nèi)容判斷是否顯示
如果傳過來的對象或者數(shù)組為空,則不顯示該DOM元素
// 判斷對象或數(shù)組是否為空
function isEmpty(obj) {
if (Array.isArray(obj)) {
return obj.length === 0;
} else if (typeof obj === "object") {
return Object.keys(obj).length === 0;
}
return true; // 其他類型默認(rèn)為空
}
export default {
inserted: function (el, binding) {
const value = binding.value;
if (isEmpty(value)) {
el.style.display = "none";
}
},
};
以上就是Vue2常用全局自定義指令的封裝詳解的詳細(xì)內(nèi)容，更多關(guān)于Vue2全局自定義指令的資料請關(guān)注腳本之家其它相關(guān)文章！
相關(guān)文章
本文給大家分享vue自定義組件的四種方式，通過實例代碼給大家介紹的非常詳細(xì)，具有一定的參考借鑒價值，需要的朋友參考下吧2020-02-02
這篇文章主要介紹了Vue開發(fā)指南之重點知識梳理，對Vue框架感興趣的同學(xué)，可以參考下2021-05-05
項目中需要使用websocke，這個是我自己修修改改好多次之后用得最順手的一版，分享一下。這個封裝需要搭配vuex使用，因為收到的數(shù)據(jù)都保存在vuex中了，真的絕絕子好用，解決了我一大堆問題2022-09-09
這篇文章主要為大家詳細(xì)介紹了Vue之ElementUI Form表單校驗，文中示例代碼介紹的非常詳細(xì)，具有一定的參考價值，感興趣的小伙伴們可以參考一下2021-08-08
這篇文章主要為大家詳細(xì)介紹了Vue實現(xiàn)獲取剪切板內(nèi)容的兩種方法,文中的示例代碼講解詳細(xì),具有一定的借鑒價值,有需要的小伙伴可以了解下2025-02-02
詳解Vue單元測試Karma+Mocha學(xué)習(xí)筆記
本篇文章主要介紹了詳解Vue單元測試Karma+Mocha學(xué)習(xí)筆記，小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2018-01-01
使用Vue3新特性構(gòu)建動態(tài)表單的方法詳解
傳統(tǒng)的表單開發(fā)通常需要編寫大量的重復(fù)代碼,例如處理用戶輸入、驗證數(shù)據(jù)、更新 UI 等等,為了簡化開發(fā),我們可以借助 Vue 3 的新特性,例如組合式 API 和 ref 對象,所以本文我們將一起學(xué)習(xí)如何使用 Vue 3 的新特性構(gòu)建一個更加靈活、可擴展的動態(tài)表單2024-06-06
這篇文章主要介紹了Element MessageBox彈框的具體使用，文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2020-07-07
這篇文章主要介紹了Vue getter setter，文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2019-04-04
這篇文章主要為大家詳細(xì)介紹了vue實現(xiàn)鍵盤輸入支付密碼功能，具有一定的參考價值，感興趣的小伙伴們可以參考一下2018-08-08