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

来源:https://www.cnblogs.com/smileZAZ/archive/2022/10/24/16822147.html
-Advertisement-
Play Games

這裡給大家分享我在網上總結出來的一些知識,希望對大家有所幫助 在 Vue,除了核心功能預設內置的指令 ( v-model 和 v-show ),Vue 也允許註冊自定義指令。它的作用價值在於當開發人員在某些場景下需要對普通 DOM 元素進行操作。 Vue 自定義指令有全局註冊和局部註冊兩種方式。先來 ...


這裡給大家分享我在網上總結出來的一些知識,希望對大家有所幫助

在 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

使用方法

1、安裝依賴

npm install cm-directives --save

2、註冊指令

import cmDirectives from 'cm-directives'
Vue.use(cmDirectives)

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. 在移動端要考慮 touchstarttouchend 事件
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('click', () => {
      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|\r\n\s,.?!,。?!…—&$=()-+/*{}[\]]|\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|\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

使用:將需要校驗的輸入框加上 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)時記錄目標元素當前的 lefttop 值。
  3. 滑鼠移動(onmousemove)時計算每次移動的橫向距離和縱向距離的變化值,並改變元素的 lefttop
  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>

本文轉載於:

https://juejin.cn/post/6906028995133833230

如果對您有所幫助,歡迎您點個關註,我會定時更新技術文檔,大家一起討論學習,一起進步。

 


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 摘要:我是管理員賬號,怎麼還沒有許可權?當小伙伴詢問的時候,我第一時間就會想到都是用戶同名Schema惹的禍 本文分享自華為雲社區《你應該知道的數倉安全——都是同名Schema惹的禍》,作者: zhangkunhn 。 典型場景 經常遇到小伙伴問到: 我是管理員賬號,怎麼還沒有許可權? 管理員給我賦權了 ...
  • 使用SDLocalize高效完成iOS本地化國際化工作 SDLocalize 該方案最大特點是對舊代碼幾乎沒有較多修改就可以完成從單語言項目修改為多語言的項目。並支持XIB的控制項本地化,無需創建不同語言版本的XIB文件。 SDLocalize的工作原理: 首先標記一組需要本地化的控制項 然後在恰當時機 ...
  • Android 13(API 33)於 2022年8月15日 正式發佈(發佈時間較往年早了一些),正式版Release源代碼也於當日被推送到AOSP Android開源項目。 截止到筆者撰寫這篇文章時,國內部分應用軟體開發廠商已逐步接到手機廠商(華米OV等)的新版本適配要求。當前,對於Android... ...
  • 隨著互聯網的不斷普及,越來越多老百姓使用智能設備觸達互聯網。但用戶經常發現自己無意間提到的東西,打開App就收到相關產品的廣告推送,甚至有人懷疑手機App是通過麥克風來竊取自己平時聊天信息中的關鍵詞進行定向的廣告推送。 這種懷疑不無道理,與傳統廣告相比,如今的媒體廣告主投放的廣告定位更準確、形式更豐 ...
  • javascript編程單線程之同步模式 主流的js 環境都是單線程嗎模式執行js 代碼, js採用為單線程的原因與最開始設計初衷有關,最早是運行在瀏覽器端的腳本語言,目的是為了實現頁面上的動態交互,實現頁面交互的核心就是dom操作,這也就決定了js必須使用單線程的模式來處理,不然就會造成嚴重的線程 ...
  • 好家伙,JS基礎接著學, 1.事件流 頁面哪個部分擁有特定的事件? 可以把頁面想象成一個同心圓, 當你戳了其中的一點,其實你同時戳中了很多個圓 當你點擊一個頁面中的按鈕,實際上你同時點擊了這個按鈕,這個按鈕的容器,以及整個頁面 於是有了這麼個概念,事件流, 我們用事件流描述頁面接受事件的順序, 舉個 ...
  • 原博客地址 01. 如何開啟js嚴格模式?js嚴格模式有什麼特點? 參考點:js基礎知識 參考答案: // 全局開啟 'use stcict' // 局部開啟 function fu(){ 'use strict' } /* 1.全局變數必須先聲明 2.禁止使用with 3.創建eval作用域 4. ...
  • 01,如何開啟JS嚴格模式?JS嚴格模式有什麼特點? 兩種方式 全局開啟在js開頭加上 'use strict' 局部開啟,在作用域開頭加上 function fn(){ 'use strict' } 特點: 1,全局變數必須先聲明 2,禁止使用with 3,創建eval作用域 有單獨的作用域 4, ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...