Vue中8個實用的自訂指令（分享）

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

相關推薦：《vue.js教學》

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>复制</button>
</template>

<script> export default {
    data() {
      return {
        copyText: &#39;a copy directives&#39;,
      }
    },
  }
</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>长按</button>
</template>

<script> 
export default {
  methods: {
    longpress () {
      alert(&#39;长按指令生效&#39;)
    }
  }
} 
</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>防抖</button>
</template>

<script> 
export default {
  methods: {
    debounceClick () {
      console.log(&#39;只触发一次&#39;)
    }
  }
} 
</script>

v-emoji

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

我們常規方法是在每一個表單的 on-change 事件上做處理。

<template>
  <input>
</template>

<script> export default {
    methods: {
      vaidateEmoji() {
        var reg = /[^u4E00-u9FA5|d|a-zA-Z|rns,.?!，。？！…—&$=()-+/*{}[]]|s/g
        this.note = this.note.replace(reg, &#39;&#39;)
      },
    },
  } </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>
</template>

v-LazyLoad

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

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

思路：

• 图片懒加载的原理主要是判断当前图片是否到了可视区域这一核心逻辑实现的

• 拿到所有的图片 Dom ，遍历每个图片判断当前图片是否到了可视区范围内

• 如果到了就设置图片的 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('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('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) {
      if (realSrc) {
        el.src = realSrc
        el.removeAttribute('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  src="/static/imghw/default1.png" data-src="https://img.php.cn/upload/image/507/827/655/1608513898590253.png" class="lazy" alt="Vue中8個實用的自訂指令（分享）" >

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>
  <!-- 显示 -->
  <button>权限按钮1</button>
  <!-- 不显示 -->
  <button>权限按钮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></div>
</template>

效果如图所示

v-draggable

需求：实现一个拖拽指令，可在页面可视区域任意拖拽元素。

思路：

• 设置需要拖拽的元素为相对定位，其父元素为绝对定位。

• 鼠标按下(onmousedown)时记录目标元素当前的 left 和 top 值。

• 鼠标移动(onmousemove)时计算每次移动的横向距离和纵向距离的变化值，并改变元素的 left 和 top 值

• 鼠标松开(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  maxX) {
          x = maxX
        }

        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></div>
</template>

所有指令源码地址：https://github.com/Michael-lzg/v-directives

相关推荐：

2020年前端vue面试题大汇总（附答案）

vue教程推荐：2020最新的5个vue.js视频教程精选

更多编程相关知识，请访问：编程教学！！

以上是Vue中8個實用的自訂指令（分享）的詳細內容。更多資訊請關注PHP中文網其他相關文章！