关于前端:分享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 开发罕用技巧（干货满满哦！）