工作中 9 成概率會(huì)用到的 8 個(gè) Vue 自定義指令,十分實(shí)用!
作者:lzg9527 https://juejin.cn/post/6906028995133833230
Vue 自定義指令
在 Vue,除了核心功能默認(rèn)內(nèi)置的指令 ( v-model 和 v-show ),Vue 也允許注冊(cè)自定義指令。它的作用價(jià)值在于當(dāng)開(kāi)發(fā)人員在某些場(chǎng)景下需要對(duì)普通 DOM 元素進(jìn)行操作。
Vue 自定義指令有全局注冊(cè)和局部注冊(cè)兩種方式。先來(lái)看看注冊(cè)全局指令的方式,通過(guò)?Vue.directive( id, [definition] )?方式注冊(cè)全局指令。然后在入口文件中進(jìn)行?Vue.use()?調(diào)用。
批量注冊(cè)指令,新建?directives/index.js?文件
import?copy?from?'./copy'
import?longpress?from?'./longpress'
//?自定義指令
const?directives?=?{
??copy,
??longpress,
}
export?default?{
??install(Vue)?{
????Object.keys(directives).forEach((key)?=>?{
??????Vue.directive(key,?directives[key])
????})
??},
}
在?main.js?引入并調(diào)用
import?Vue?from?'vue'
import?Directives?from?'./JS/directives'
Vue.use(Directives)
指令定義函數(shù)提供了幾個(gè)鉤子函數(shù)(可選):
bind: 只調(diào)用一次,指令第一次綁定到元素時(shí)調(diào)用,可以定義一個(gè)在綁定時(shí)執(zhí)行一次的初始化動(dòng)作。 inserted: 被綁定元素插入父節(jié)點(diǎn)時(shí)調(diào)用(父節(jié)點(diǎn)存在即可調(diào)用,不必存在于 document 中)。 update: 被綁定元素所在的模板更新時(shí)調(diào)用,而不論綁定值是否變化。通過(guò)比較更新前后的綁定值。 componentUpdated: 被綁定元素所在模板完成一次更新周期時(shí)調(diào)用。 unbind: 只調(diào)用一次, 指令與元素解綁時(shí)調(diào)用。
下面分享幾個(gè)實(shí)用的 Vue 自定義指令
復(fù)制粘貼指令? v-copy長(zhǎng)按指令? v-longpress輸入框防抖指令? v-debounce禁止表情及特殊字符? v-emoji圖片懶加載? v-LazyLoad權(quán)限校驗(yàn)指令? v-premission實(shí)現(xiàn)頁(yè)面水印? v-waterMarker拖拽指令? v-draggable
v-copy
需求:實(shí)現(xiàn)一鍵復(fù)制文本內(nèi)容,用于鼠標(biāo)右鍵粘貼。
思路:
動(dòng)態(tài)創(chuàng)建? textarea?標(biāo)簽,并設(shè)置?readOnly?屬性及移出可視區(qū)域將要復(fù)制的值賦給? textarea?標(biāo)簽的?value?屬性,并插入到?body選中值? textarea?并復(fù)制將? body?中插入的?textarea?移除在第一次調(diào)用時(shí)綁定事件,在解綁時(shí)移除事件
const?copy?=?{
??bind(el,?{?value?})?{
????el.$value?=?value
????el.handler?=?()?=>?{
??????if?(!el.$value)?{
????????//?值為空的時(shí)候,給出提示??筛鶕?jù)項(xiàng)目UI仔細(xì)設(shè)計(jì)
????????console.log('無(wú)復(fù)制內(nèi)容')
????????return
??????}
??????//?動(dòng)態(tài)創(chuàng)建?textarea?標(biāo)簽
??????const?textarea?=?document.createElement('textarea')
??????//?將該?textarea?設(shè)為?readonly?防止?iOS?下自動(dòng)喚起鍵盤(pán),同時(shí)將?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ù)項(xiàng)目UI仔細(xì)設(shè)計(jì)
??????}
??????document.body.removeChild(textarea)
????}
????//?綁定點(diǎn)擊事件,就是所謂的一鍵?copy?啦
????el.addEventListener('click',?el.handler)
??},
??//?當(dāng)傳進(jìn)來(lái)的值更新的時(shí)候觸發(fā)
??componentUpdated(el,?{?value?})?{
????el.$value?=?value
??},
??//?指令與元素解綁的時(shí)候,移除事件綁定
??unbind(el)?{
????el.removeEventListener('click',?el.handler)
??},
}
export?default?copy
使用:給 Dom 加上?v-copy?及復(fù)制的文本即可
<template>
??<button?v-copy="copyText">復(fù)制button>
template>
<script>
??export?default?{
????data()?{
??????return?{
????????copyText:?'a?copy?directives',
??????}
????},
??}
script>
v-longpress
需求:實(shí)現(xiàn)長(zhǎng)按,用戶需要按下并按住按鈕幾秒鐘,觸發(fā)相應(yīng)的事件
思路:
創(chuàng)建一個(gè)計(jì)時(shí)器, 2 秒后執(zhí)行函數(shù) 當(dāng)用戶按下按鈕時(shí)觸發(fā)? mousedown?事件,啟動(dòng)計(jì)時(shí)器;用戶松開(kāi)按鈕時(shí)調(diào)用mouseout?事件。如果? mouseup?事件 2 秒內(nèi)被觸發(fā),就清除計(jì)時(shí)器,當(dāng)作一個(gè)普通的點(diǎn)擊事件如果計(jì)時(shí)器沒(méi)有在 2 秒內(nèi)清除,則判定為一次長(zhǎng)按,可以執(zhí)行關(guān)聯(lián)的函數(shù)。 在移動(dòng)端要考慮? touchstart,touchend?事件
const?longpress?=?{
??bind:?function?(el,?binding,?vNode)?{
????if?(typeof?binding.value?!==?'function')?{
??????throw?'callback?must?be?a?function'
????}
????//?定義變量
????let?pressTimer?=?null
????//?創(chuàng)建計(jì)時(shí)器(?2秒后執(zhí)行函數(shù)?)
????let?start?=?(e)?=>?{
??????if?(e.type?===?'click'?&&?e.button?!==?0)?{
????????return
??????}
??????if?(pressTimer?===?null)?{
????????pressTimer?=?setTimeout(()?=>?{
??????????handler()
????????},?2000)
??????}
????}
????//?取消計(jì)時(shí)器
????let?cancel?=?(e)?=>?{
??????if?(pressTimer?!==?null)?{
????????clearTimeout(pressTimer)
????????pressTimer?=?null
??????}
????}
????//?運(yùn)行函數(shù)
????const?handler?=?(e)?=>?{
??????binding.value(e)
????}
????//?添加事件監(jiān)聽(tīng)器
????el.addEventListener('mousedown',?start)
????el.addEventListener('touchstart',?start)
????//?取消計(jì)時(shí)器
????el.addEventListener('click',?cancel)
????el.addEventListener('mouseout',?cancel)
????el.addEventListener('touchend',?cancel)
????el.addEventListener('touchcancel',?cancel)
??},
??//?當(dāng)傳進(jìn)來(lái)的值更新的時(shí)候觸發(fā)
??componentUpdated(el,?{?value?})?{
????el.$value?=?value
??},
??//?指令與元素解綁的時(shí)候,移除事件綁定
??unbind(el)?{
????el.removeEventListener('click',?el.handler)
??},
}
export?default?longpress
使用:給 Dom 加上?v-longpress?及回調(diào)函數(shù)即可
<template>
??<button?v-longpress="longpress">長(zhǎng)按button>
template>
<script>
export?default?{
??methods:?{
????longpress?()?{
??????alert('長(zhǎng)按指令生效')
????}
??}
}
v-debounce
背景:在開(kāi)發(fā)中,有些提交保存按鈕有時(shí)候會(huì)在短時(shí)間內(nèi)被點(diǎn)擊多次,這樣就會(huì)多次重復(fù)請(qǐng)求后端接口,造成數(shù)據(jù)的混亂,比如新增表單的提交按鈕,多次點(diǎn)擊就會(huì)新增多條重復(fù)的數(shù)據(jù)。
需求:防止按鈕在短時(shí)間內(nèi)被多次點(diǎn)擊,使用防抖函數(shù)限制規(guī)定時(shí)間內(nèi)只能點(diǎn)擊一次。
思路:
定義一個(gè)延遲執(zhí)行的方法,如果在延遲時(shí)間內(nèi)再調(diào)用該方法,則重新計(jì)算執(zhí)行時(shí)間。 將時(shí)間綁定在 click 方法上。
const?debounce?=?{
??inserted:?function?(el,?binding)?{
????let?timer
????el.addEventListener('keyup',?()?=>?{
??????if?(timer)?{
????????clearTimeout(timer)
??????}
??????timer?=?setTimeout(()?=>?{
????????binding.value()
??????},?1000)
????})
??},
}
export?default?debounce
使用:給 Dom 加上?v-debounce?及回調(diào)函數(shù)即可
<template>
??<button?v-debounce="debounceClick">防抖button>
template>
<script>
export?default?{
??methods:?{
????debounceClick?()?{
??????console.log('只觸發(fā)一次')
????}
??}
}
v-emoji
背景:開(kāi)發(fā)中遇到的表單輸入,往往會(huì)有對(duì)輸入內(nèi)容的限制,比如不能輸入表情和特殊字符,只能輸入數(shù)字或字母等。
我們常規(guī)方法是在每一個(gè)表單的?on-change?事件上做處理。
<template>
??<input?type="text"?v-model="note"?@change="vaidateEmoji"?/>
template>
<script>
??export?default?{
????methods:?{
??????vaidateEmoji()?{
????????var?reg?=?/[^\u4E00-\u9FA5|\d|\a-zA-Z|\r\n\s,.?!,。?!…—&$=()-+/*{}[\]]|\s/g
????????this.note?=?this.note.replace(reg,?'')
??????},
????},
??}
script>
這樣代碼量比較大而且不好維護(hù),所以我們需要自定義一個(gè)指令來(lái)解決這問(wèn)題。
需求:根據(jù)正則表達(dá)式,設(shè)計(jì)自定義處理表單輸入規(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)
}
const?emoji?=?{
??bind:?function?(el,?binding,?vnode)?{
????//?正則規(guī)則可根據(jù)需求自定義
????var?regRule?=?/[^\u4E00-\u9FA5|\d|\a-zA-Z|\r\n\s,.?!,。?!…—&$=()-+/*{}[\]]|\s/g
????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)
??},
}
export?default?emoji
使用:將需要校驗(yàn)的輸入框加上?v-emoji?即可
<template>
??<input?type="text"?v-model="note"?v-emoji?/>
template>
v-LazyLoad
背景:在類電商類項(xiàng)目,往往存在大量的圖片,如 banner 廣告圖,菜單導(dǎo)航圖,美團(tuán)等商家列表頭圖等。圖片眾多以及圖片體積過(guò)大往往會(huì)影響頁(yè)面加載速度,造成不良的用戶體驗(yàn),所以進(jìn)行圖片懶加載優(yōu)化勢(shì)在必行。
需求:實(shí)現(xiàn)一個(gè)圖片懶加載指令,只加載瀏覽器可見(jiàn)區(qū)域的圖片。
思路:
圖片懶加載的原理主要是判斷當(dāng)前圖片是否到了可視區(qū)域這一核心邏輯實(shí)現(xiàn)的 拿到所有的圖片 Dom ,遍歷每個(gè)圖片判斷當(dāng)前圖片是否到了可視區(qū)范圍內(nèi) 如果到了就設(shè)置圖片的? src?屬性,否則顯示默認(rèn)圖片
圖片懶加載有兩種方式可以實(shí)現(xiàn),一是綁定?srcoll?事件進(jìn)行監(jiān)聽(tīng),二是使用?IntersectionObserver?判斷圖片是否到了可視區(qū)域,但是有瀏覽器兼容性問(wèn)題。
下面封裝一個(gè)懶加載指令兼容兩種方法,判斷瀏覽器是否支持?IntersectionObserverAPI,如果支持就使用?IntersectionObserver?實(shí)現(xiàn)懶加載,否則則使用?srcoll事件監(jiān)聽(tīng) + 節(jié)流的方法實(shí)現(xiàn)。
const?LazyLoad?=?{
??//?install方法
??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('src',?val)
????el.setAttribute('src',?def)
??},
??//?利用IntersectionObserver監(jiān)聽(tīng)el
??observe(el)?{
????var?io?=?new?IntersectionObserver((entries)?=>?{
??????const?realSrc?=?el.dataset.src
??????if?(entries[0].isIntersecting)?{
????????if?(realSrc)?{
??????????el.src?=?realSrc
??????????el.removeAttribute('src')
????????}
??????}
????})
????io.observe(el)
??},
??//?監(jiān)聽(tīng)scroll事件
??listenerScroll(el)?{
????const?handler?=?LazyLoad.throttle(LazyLoad.load,?300)
????LazyLoad.load(el)
????window.addEventListener('scroll',?()?=>?{
??????handler(el)
????})
??},
??//?加載真實(shí)圖片
??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('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)
????}
??},
}
export?default?LazyLoad
使用,將組件內(nèi) ?標(biāo)簽的?src?換成?v-LazyLoad
<img?v-LazyLoad="xxx.jpg"?/>
v-permission
背景:在一些后臺(tái)管理系統(tǒng),我們可能需要根據(jù)用戶角色進(jìn)行一些操作權(quán)限的判斷,很多時(shí)候我們都是粗暴地給一個(gè)元素添加?v-if / v-show?來(lái)進(jìn)行顯示隱藏,但如果判斷條件繁瑣且多個(gè)地方需要判斷,這種方式的代碼不僅不優(yōu)雅而且冗余。針對(duì)這種情況,我們可以通過(guò)全局自定義指令來(lái)處理。
需求:自定義一個(gè)權(quán)限指令,對(duì)需要權(quán)限判斷的 Dom 進(jìn)行顯示隱藏。
思路:
自定義一個(gè)權(quán)限數(shù)組 判斷用戶的權(quán)限是否在這個(gè)數(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?//?無(wú)權(quán)限
??}
}
const?permission?=?{
??inserted:?function?(el,?binding)?{
????let?permission?=?binding.value?//?獲取到?v-permission的值
????if?(permission)?{
??????let?hasPermission?=?checkArray(permission)
??????if?(!hasPermission)?{
????????//?沒(méi)有權(quán)限?移除Dom元素
????????el.parentNode?&&?el.parentNode.removeChild(el)
??????}
????}
??},
}
export?default?permission
使用:給?v-permission?賦值判斷即可
<div?class="btns">
??
??<button?v-permission="'1'">權(quán)限按鈕1button>
??
??<button?v-permission="'10'">權(quán)限按鈕2button>
div>
vue-waterMarker
需求:給整個(gè)頁(yè)面添加背景水印
思路:
使用? canvas?特性生成?base64?格式的圖片文件,設(shè)置其字體大小,顏色等。將其設(shè)置為背景圖片,從而實(shí)現(xiàn)頁(yè)面或組件水印效果
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')?+?')'
}
const?waterMarker?=?{
??bind:?function?(el,?binding)?{
????addWaterMarker(binding.value.text,?el,?binding.value.font,?binding.value.textColor)
??},
}
export?default?waterMarker
使用,設(shè)置水印文案,顏色,字體大小即可
<template>
??<div?v-waterMarker="{text:'lzg版權(quán)所有',textColor:'rgba(180,?180,?180,?0.4)'}">div>
template>
v-draggable
需求:實(shí)現(xiàn)一個(gè)拖拽指令,可在頁(yè)面可視區(qū)域任意拖拽元素。
思路:
設(shè)置需要拖拽的元素為相對(duì)定位,其父元素為絕對(duì)定位。 鼠標(biāo)按下 (onmousedown)時(shí)記錄目標(biāo)元素當(dāng)前的?left?和?top?值。鼠標(biāo)移動(dòng) (onmousemove)時(shí)計(jì)算每次移動(dòng)的橫向距離和縱向距離的變化值,并改變?cè)氐?left?和?top?值鼠標(biāo)松開(kāi) (onmouseup)時(shí)完成一次拖拽
const?draggable?=?{
??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
??????}
????}
??},
}
export?default?draggable
使用: 在 Dom 上加上 v-draggable 即可
<template>
??<div?class="el-dialog"?v-draggable>div>
template>
最后
1.看到這里了就點(diǎn)個(gè)在看支持下吧,你的「點(diǎn)贊,在看」是我創(chuàng)作的動(dòng)力。
2.關(guān)注公眾號(hào)前端壹棧,回復(fù)「電子書(shū)」加入獲得 160 本前端精華電子書(shū)哦
3.也可添加公眾號(hào)【全棧修煉】,一起成長(zhǎng)
往期精文

