分享8個非常實用的Vue自定義指令

本文在github做了收錄 github.com/Michael-lzg…

demo原始碼地址 github.com/Michael-lzg…

在 Vue，除了核心功能預設內建的指令 ( v-model 和 v-show )，Vue 也允許註冊自定義指令。它的作用價值在於當開發人員在某些場景下需要對普通 DOM 元素進行操作。

Vue 自定義指令有全域性註冊和區域性註冊兩種方式。先來看看註冊全域性指令的方式，通過 Vue.directive( id, [definition] ) 方式註冊全域性指令。然後在入口檔案中進行 Vue.use() 呼叫。

批量註冊指令，新建 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 引入並呼叫

import Vue from 'vue'
import Directives from './JS/directives'
Vue.use(Directives)

指令定義函式提供了幾個鉤子函式（可選）：

• bind: 只呼叫一次，指令第一次繫結到元素時呼叫，可以定義一個在繫結時執行一次的初始化動作。
• inserted: 被繫結元素插入父節點時呼叫（父節點存在即可呼叫，不必存在於 document 中）。
• update: 被繫結元素所在的模板更新時呼叫，而不論繫結值是否變化。通過比較更新前後的繫結值。
• componentUpdated: 被繫結元素所在模板完成一次更新週期時呼叫。
• unbind: 只呼叫一次， 指令與元素解綁時呼叫。

下面分享幾個實用的 Vue 自定義指令

• 複製貼上指令 v-copy
• 長按指令 v-longpress
• 輸入框防抖指令 v-debounce
• 禁止表情及特殊字元 v-emoji
• 圖片懶載入 v-LazyLoad
• 許可權校驗指令 v-premission
• 實現頁面水印 v-waterMarker
• 拖拽指令 v-draggable

v-copy

需求：實現一鍵複製文字內容，用於滑鼠右鍵貼上。

思路：

1. 動態建立 textarea 標籤，並設定 readOnly 屬性及移出可視區域
2. 將要複製的值賦給 textarea 標籤的 value 屬性，並插入到 body
3. 選中值 textarea 並複製
4. 將 body 中插入的 textarea 移除
5. 在第一次呼叫時繫結事件，在解綁時移除事件

const copy = {
  bind(el, { value }) {
    el.$value = value
    el.handler = () => {
      if (!el.$value) {
        // 值為空的時候，給出提示。可根據專案UI仔細設計
        console.log('無複製內容')
        return
      }
      // 動態建立 textarea 標籤
      const textarea = document.createElement('textarea')
      // 將該 textarea 設為 readonly 防止 iOS 下自動喚起鍵盤，同時將 textarea 移出可視區域
      textarea.readOnly = 'readonly'
      textarea.style.position = 'absolute'
      textarea.style.left = '-9999px'
      // 將要 copy 的值賦給 textarea 標籤的 value 屬性
      textarea.value = el.$value
      // 將 textarea 插入到 body 中
      document.body.appendChild(textarea)
      // 選中值並複製
      textarea.select()
      const result = document.execCommand('Copy')
      if (result) {
        console.log('複製成功') // 可根據專案UI仔細設計
      }
      document.body.removeChild(textarea)
    }
    // 繫結點選事件，就是所謂的一鍵 copy 啦
    el.addEventListener('click', el.handler)
  },
  // 當傳進來的值更新的時候觸發
  componentUpdated(el, { value }) {
    el.$value = value
  },
  // 指令與元素解綁的時候，移除事件繫結
  unbind(el) {
    el.removeEventListener('click', el.handler)
  },
}

export default copy

使用：給 Dom 加上 v-copy 及複製的文字即可

<template>
  <button v-copy="copyText">複製</button>
</template>

<script> export default {
    data() {
      return {
        copyText: 'a copy directives',
      }
    },
  }
</script>

v-longpress

需求：實現長按，使用者需要按下並按住按鈕幾秒鐘，觸發相應的事件

思路：

1. 建立一個計時器， 2 秒後執行函式
2. 當使用者按下按鈕時觸發 mousedown 事件，啟動計時器；使用者鬆開按鈕時呼叫 mouseout 事件。
3. 如果 mouseup 事件 2 秒內被觸發，就清除計時器，當作一個普通的點選事件
4. 如果計時器沒有在 2 秒內清除，則判定為一次長按，可以執行關聯的函式。
5. 在移動端要考慮 touchstart，touchend 事件

const longpress = {
  bind: function (el, binding, vNode) {
    if (typeof binding.value !== 'function') {
      throw 'callback must be a function'
    }
    // 定義變數
    let pressTimer = null
    // 建立計時器（ 2秒後執行函式 ）
    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
      }
    }
    // 執行函式
    const handler = (e) => {
      binding.value(e)
    }
    // 新增事件監聽器
    el.addEventListener('mousedown', start)
    el.addEventListener('touchstart', start)
    // 取消計時器
    el.addEventListener('click', cancel)
    el.addEventListener('mouseout', cancel)
    el.addEventListener('touchend', cancel)
    el.addEventListener('touchcancel', cancel)
  },
  // 當傳進來的值更新的時候觸發
  componentUpdated(el, { value }) {
    el.$value = value
  },
  // 指令與元素解綁的時候，移除事件繫結
  unbind(el) {
    el.removeEventListener('click', el.handler)
  },
}

export default longpress

使用：給 Dom 加上 v-longpress 及回撥函式即可

<template>
  <button v-longpress="longpress">長按</button>
</template>

<script> 
export default {
  methods: {
    longpress () {
      alert('長按指令生效')
    }
  }
} 
</script>

v-debounce

背景：在開發中，有些提交儲存按鈕有時候會在短時間內被點選多次，這樣就會多次重複請求後端介面，造成資料的混亂，比如新增表單的提交按鈕，多次點選就會新增多條重複的資料。

需求：防止按鈕在短時間內被多次點選，使用防抖函式限制規定時間內只能點選一次。

思路：

1. 定義一個延遲執行的方法，如果在延遲時間內再呼叫該方法，則重新計算執行時間。
2. 將時間繫結在 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 及回撥函式即可

<template>
  <button v-debounce="debounceClick">防抖</button>
</template>

<script> 
export default {
  methods: {
    debounceClick () {
      console.log('只觸發一次')
    }
  }
} 
</script>

v-emoji

背景：開發中遇到的表單輸入，往往會有對輸入內容的限制，比如不能輸入表情和特殊字元，只能輸入數字或字母等。

我們常規方法是在每一個表單的 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|rns,.?!，。？！…—&$=()-+/*{}[]]|s/g
        this.note = this.note.replace(reg, '')
      },
    },
  } </script>

這樣程式碼量比較大而且不好維護，所以我們需要自定義一個指令來解決這問題。

需求：根據正規表示式，設計自定義處理表單輸入規則的指令，下面以禁止輸入表情和特殊字元為例。

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) {
    // 正則規則可根據需求自定義
    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

使用：將需要校驗的輸入框加上 v-emoji 即可

<template>
  <input type="text" v-model="note" v-emoji />
</template>

v-LazyLoad

背景：在類電商類專案，往往存在大量的圖片，如 banner 廣告圖，選單導航圖，美團等商家列表頭圖等。圖片眾多以及圖片體積過大往往會影響頁面載入速度，造成不良的使用者體驗，所以進行圖片懶載入優化勢在必行。

需求：實現一個圖片懶載入指令，只載入瀏覽器可見區域的圖片。

思路：

1. 圖片懶載入的原理主要是判斷當前圖片是否到了可視區域這一核心邏輯實現的
2. 拿到所有的圖片 Dom ，遍歷每個圖片判斷當前圖片是否到了可視區範圍內
3. 如果到了就設定圖片的 src 屬性，否則顯示預設圖片

圖片懶載入有兩種方式可以實現，一是繫結 srcoll 事件進行監聽，二是使用 IntersectionObserver 判斷圖片是否到了可視區域，但是有瀏覽器相容性問題。

下面封裝一個懶載入指令相容兩種方法，判斷瀏覽器是否支援 IntersectionObserver API，如果支援就使用 IntersectionObserver 實現懶載入，否則則使用 srcoll 事件監聽 + 節流的方法實現。

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('data-src', val)
    el.setAttribute('src', def)
  },
  // 利用IntersectionObserver監聽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)
  },
  // 監聽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')
      }
    }
  },
  // 節流
  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

使用，將元件內 標籤的 src 換成 v-LazyLoad

<img v-LazyLoad="xxx.jpg" />

v-permission

背景：在一些後臺管理系統，我們可能需要根據使用者角色進行一些操作許可權的判斷，很多時候我們都是粗暴地給一個元素新增 v-if / v-show 來進行顯示隱藏，但如果判斷條件繁瑣且多個地方需要判斷，這種方式的程式碼不僅不優雅而且冗餘。針對這種情況，我們可以通過全域性自定義指令來處理。

需求：自定義一個許可權指令，對需要許可權判斷的 Dom 進行顯示隱藏。

思路：

1. 自定義一個許可權陣列
2. 判斷使用者的許可權是否在這個陣列內，如果是則顯示，否則則移除 Dom

function checkArray(key) {
  let arr = ['1', '2', '3', '4']
  let index = arr.indexOf(key)
  if (index > -1) {
    return true // 有許可權
  } else {
    return false // 無許可權
  }
}

const permission = {
  inserted: function (el, binding) {
    let permission = binding.value // 獲取到 v-permission的值
    if (permission) {
      let hasPermission = checkArray(permission)
      if (!hasPermission) {
        // 沒有許可權 移除Dom元素
        el.parentNode && el.parentNode.removeChild(el)
      }
    }
  },
}

export default permission

使用：給 v-permission 賦值判斷即可

<div class="btns">
  <!-- 顯示 -->
  <button v-permission="'1'">許可權按鈕1</button>
  <!-- 不顯示 -->
  <button v-permission="'10'">許可權按鈕2</button>
</div>

vue-waterMarker

需求：給整個頁面新增背景水印

思路：

1. 使用 canvas 特性生成 base64 格式的圖片檔案，設定其字型大小，顏色等。
2. 將其設定為背景圖片，從而實現頁面或元件水印效果

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

使用，設定水印文案，顏色，字型大小即可

<template>
  <div v-waterMarker="{text:'lzg版權所有',textColor:'rgba(180, 180, 180, 0.4)'}"></div>
</template>

效果如圖所示

v-draggable

需求：實現一個拖拽指令，可在頁面可視區域任意拖拽元素。

思路：

1. 設定需要拖拽的元素為相對定位，其父元素為絕對定位。
2. 滑鼠按下(onmousedown)時記錄目標元素當前的 left 和 top 值。
3. 滑鼠移動(onmousemove)時計算每次移動的橫向距離和縱向距離的變化值，並改變元素的 left 和 top 值
4. 滑鼠鬆開(onmouseup)時完成一次拖拽

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>

所有指令原始碼地址 github.com/Michael-lzg…

推薦文章

你必須知道的webpack外掛原理分析
webpack的非同步載入原理及分包策略
總結18個webpack外掛，總會有你想要的！
搭建一個 vue-cli4+webpack 移動端框架（開箱即用）
從零構建到優化一個類似vue-cli的腳手架
封裝一個toast和dialog元件併發布到npm
從零開始構建一個webpack專案
總結幾個webpack打包優化的方法
總結vue知識體系之高階應用篇
總結vue知識體系之實用技巧
總結vue知識體系之基礎入門篇
總結移動端H5開發常用技巧（乾貨滿滿哦！）