在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

要求:用鼠标右键一键复制文本内容进行粘贴。

想法:

动态创建 textarea 标签，并设置 readOnly 属性及移出可视区域将要复制的值赋给 textarea 标签的 value 属性，并插入到 body选中值 textarea 并复制将 body 中插入的 textarea 移除在第一次调用时绑定事件，在解绑时移除事件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复制代码

使用:将v-copy和复制的文本添加到Dom。

<template> <button v-copy="copyText">复制</button></template> <script> export default { data() { return { copyText: 'a copy directives', } }, } </script>复制代码

v形长压机

要求:要实现长按，用户需要按住按钮几秒钟，触发相应的事件。

想法:

创建一个计时器， 2 秒后执行函数当用户按下按钮时触发 mousedown 事件，启动计时器；用户松开按钮时调用 mouseout 事件。如果 mouseup 事件 2 秒内被触发，就清除计时器，当作一个普通的点击事件如果计时器没有在 2 秒内清除，则判定为一次长按，可以执行关联的函数。在移动端要考虑 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>复制代码

垂直去抖

背景:在开发中，有些提交和保存按钮有时会在短时间内被多次点击，会反复请求后端接口，造成数据混乱。比如会添加一个新表单的提交按钮，多次点击会添加多个重复数据。

要求:防止按钮在短时间内被多次点击，使用防抖功能限制在规定时间内只能点击一次。

想法:

定义一个延迟执行的方法，如果在延迟时间内再调用该方法，则重新计算执行时间。将时间绑定在 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>复制代码

虚拟表情符号

背景:开发中遇到的表单输入往往对输入内容有限制，比如不能有表达式和特殊字符，只能有数字或字母等。

我们的传统方法是处理每个表单的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广告图，菜单导航图，美团等商家列表的页眉图。图片过多、图片尺寸过大往往会影响页面加载速度，造成用户体验不佳，因此优化图片的懒加载势在必行。

需求:实现一个图片惰性加载指令，只加载浏览器可见区域的图片。

想法:

图片懒加载的原理主要是判断当前图片是否到了可视区域这一核心逻辑实现的拿到所有的图片 Dom ，遍历每个图片判断当前图片是否到了可视区范围内如果到了就设置图片的 src 属性，否则显示默认图片

有两种方法可以实现图像的延迟加载。一种是绑定srcoll事件进行监控，另一种是使用IntersectionObserver判断图片是否已经到达可视区域，但是存在浏览器兼容性问题。

下面的lazy loading指令兼容两种方法，判断浏览器是否支持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-许可

背景:在一些后台管理系统中，我们可能需要根据用户的角色做一些操作权限的判断。很多时候，我们粗暴地给一个元素加上v-if/v-show来隐藏它。但如果判断条件繁琐，需要判断多个地方，这样的代码不仅不优雅而且多余。针对这种情况，我们可以通过全局自定义指令来处理。

需求:自定义一个权限指令，显示和隐藏需要权限判断的Dom。

想法:

自定义一个权限数组判断用户的权限是否在这个数组内，如果是则显示，否则则移除 Domfunction 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-water mark

要求:给整个页面添加背景水印。

想法:

使用 canvas 特性生成 base64 格式的图片文件，设置其字体大小，颜色等。将其设置为背景图片，从而实现页面或组件水印效果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型可拖动

要求:实现一个拖拽命令，可以拖拽页面可见区域的任意元素。

想法:

设置需要拖拽的元素为相对定位，其父元素为绝对定位。鼠标按下(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 < 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复制代码

使用:将v-draggable添加到Dom。

<template> <div class="el-dialog" v-draggable></div></template>