分享8個(gè)非常實(shí)用的Vue自定義指令
關(guān)注公眾號 程序員成長指北,回復(fù)“1”
加入我們一起學(xué)習(xí),天天進(jìn)步

作者:lzg9527?
鏈接:https://segmentfault.com/a/1190000038475001
在 Vue,除了核心功能默認(rèn)內(nèi)置的指令 ( v-model 和 v-show ),Vue 也允許注冊自定義指令。它的作用價(jià)值在于當(dāng)開發(fā)人員在某些場景下需要對普通 DOM 元素進(jìn)行操作。
Vue 自定義指令有全局注冊和局部注冊兩種方式。先來看看注冊全局指令的方式,通過 Vue.directive( id, [definition] ) 方式注冊全局指令。然后在入口文件中進(jìn)行 Vue.use() 調(diào)用。
批量注冊指令,新建 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í)行一次的初始化動作。 inserted: 被綁定元素插入父節(jié)點(diǎn)時(shí)調(diào)用(父節(jié)點(diǎn)存在即可調(diào)用,不必存在于 document 中)。 update: 被綁定元素所在的模板更新時(shí)調(diào)用,而不論綁定值是否變化。通過比較更新前后的綁定值。 componentUpdated: 被綁定元素所在模板完成一次更新周期時(shí)調(diào)用。 unbind: 只調(diào)用一次, 指令與元素解綁時(shí)調(diào)用。
下面分享幾個(gè)實(shí)用的 Vue 自定義指令
復(fù)制粘貼指令 v-copy長按指令 v-longpress輸入框防抖指令 v-debounce禁止表情及特殊字符 v-emoji圖片懶加載 v-LazyLoad權(quán)限校驗(yàn)指令 v-premission實(shí)現(xiàn)頁面水印 v-waterMarker拖拽指令 v-draggable
v-copy
需求:實(shí)現(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)用時(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('無復(fù)制內(nèi)容')
????????return
??????}
??????//?動態(tài)創(chuàng)建?textarea?標(biāo)簽
??????const?textarea?=?document.createElement('textarea')
??????//?將該?textarea?設(shè)為?readonly?防止?iOS?下自動喚起鍵盤,同時(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)來的值更新的時(shí)候觸發(fā)
??componentUpdated(el,?{?value?})?{
????el.$value?=?value
??},
??//?指令與元素解綁的時(shí)候,移除事件綁定
??unbind(el)?{
????el.removeEventListener('click',?el.handler)
??},
}
export?default?copy
使用:給 Dom 加上 v-copy 及復(fù)制的文本即可
??
v-longpress
需求:實(shí)現(xiàn)長按,用戶需要按下并按住按鈕幾秒鐘,觸發(fā)相應(yīng)的事件
思路:
創(chuàng)建一個(gè)計(jì)時(shí)器, 2 秒后執(zhí)行函數(shù) 當(dāng)用戶按下按鈕時(shí)觸發(fā) mousedown事件,啟動計(jì)時(shí)器;用戶松開按鈕時(shí)調(diào)用mouseout事件。如果 mouseup事件 2 秒內(nèi)被觸發(fā),就清除計(jì)時(shí)器,當(dāng)作一個(gè)普通的點(diǎn)擊事件如果計(jì)時(shí)器沒有在 2 秒內(nèi)清除,則判定為一次長按,可以執(zhí)行關(guān)聯(lián)的函數(shù)。 在移動端要考慮 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)聽器
????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)來的值更新的時(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ù)即可
??
v-debounce
背景:在開發(fā)中,有些提交保存按鈕有時(shí)候會在短時(shí)間內(nèi)被點(diǎn)擊多次,這樣就會多次重復(fù)請求后端接口,造成數(shù)據(jù)的混亂,比如新增表單的提交按鈕,多次點(diǎn)擊就會新增多條重復(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ù)即可
??
v-emoji
背景:開發(fā)中遇到的表單輸入,往往會有對輸入內(nèi)容的限制,比如不能輸入表情和特殊字符,只能輸入數(shù)字或字母等。
我們常規(guī)方法是在每一個(gè)表單的 on-change 事件上做處理。
??type="text"?v-model="note"?@change="vaidateEmoji"?/>
這樣代碼量比較大而且不好維護(hù),所以我們需要自定義一個(gè)指令來解決這問題。
需求:根據(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|rns,.?!,。?!…—&$=()-+/*{}[]]|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 即可
??type="text"?v-model="note"?v-emoji?/>
v-LazyLoad
背景:在類電商類項(xiàng)目,往往存在大量的圖片,如 banner 廣告圖,菜單導(dǎo)航圖,美團(tuán)等商家列表頭圖等。圖片眾多以及圖片體積過大往往會影響頁面加載速度,造成不良的用戶體驗(yàn),所以進(jìn)行圖片懶加載優(yōu)化勢在必行。
需求:實(shí)現(xiàn)一個(gè)圖片懶加載指令,只加載瀏覽器可見區(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)聽,二是使用 IntersectionObserver 判斷圖片是否到了可視區(qū)域,但是有瀏覽器兼容性問題。
下面封裝一個(gè)懶加載指令兼容兩種方法,判斷瀏覽器是否支持 IntersectionObserver API,如果支持就使用 IntersectionObserver 實(shí)現(xiàn)懶加載,否則則使用 srcoll 事件監(jiān)聽 + 節(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)聽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)聽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
“在看轉(zhuǎn)發(fā)”是最大的支持
