关于自定义指令
- 在实际项目开发过程中，除了vue自身提供的一些固定指令，如v-if,v-show,v-model等除外，我们可能根据项目的需求来自己注册一些自定义的指令，更好的提高开发和工作效率。
如何实现
注册自定义指令有全局注册与局部注册
- 全局注册注册主要是用过Vue.directive(''指令string",{...})方法进行注册
Vue.directive第一个参数是指令的名字（不需要写上v-前缀），第二个参数可以是对象数据，也可以是一个指令函数
// 注册一个全局自定义指令 `v-focus`
Vue.directive('focus', {
// 当被绑定的元素插入到 DOM 中时……
inserted: function (el) {
....
}
})
- 局部注册通过在组件选项中设置directives对象,和watch/filters同级。
directives: {
focus: {
// 指令的定义
inserted: function (el) {
....
}
}
}
- 自定义指令也像组件那样存在钩子函数：
bind()：只调用一次，指令第一次绑定到元素时调用。在这里可以进行一次性的初始化设置
inserted(el,binding)：被绑定元素插入父节点时调用 (仅保证父节点存在，但不一定已被插入文档中)
update()：所在组件的 VNode 更新时调用，但是可能发生在其子 VNode 更新之前。指令的值可能发生了改变，也可能没有。但是你可以通过比较更新前后的值来忽略不必要的模板更新
componentUpdated()：指令所在组件的 VNode 及其子 VNode 全部更新后调用
unbind()：只调用一次，指令与元素解绑时调用
应用场景
使用自定义组件组件可以满足我们日常一些场景，这里给出几个自定义组件的案例：
- 拖拽
- 防抖
- 图片懒加载
- 一键 Copy的功能
- 自定义全局loading
- 页面水印
- 权限校验
....... - 自定义(全局)拖拽指令v-drag
export default {
install: Vue => {
Vue.directive("drag",{
//只调用一次，指令第一次绑定到元素时调用，用这个钩子函数可以定义一个在绑定时执行一次的初始化动作
bind:function(){ },
inserted: function(el,binding){
const param = binding.value;
console.log(param);
el.onmousedown = function(e) {
const dx = e.clientX - el.offsetLeft;
const dy = e.clientY - el.offsetTop;
el.onmousemove = function(e) {
e.stopPropagation();
const left = e.clientX - dx;
const top = e.clientY - dy;
el.style.left = left + 'px';
el.style.top = top + 'px'
}
document.mouseup = function(e) {
e.onmousemove = null;
document.onmouseup = null;
}
return false
}
},
update:function() {
//被绑定元素所在的模板更新时调用，而不论绑定值是否变化。通过比较更新前后的绑定值，可以忽略不必要的模板更新
},
componentUpdated: function() {
//被绑定元素所在模板完成一次更新周期时调用
},
unbind: function() {
//只调用一次， 指令与元素解绑时调用
}
})
}
}
<template>
<div>
<div v-drag="greet" >
使用拖拽自定义指令
</div>
</div>
<template/>
//使用函数
greet(val, el) {
// 返回的val和el元素
}
- 输入框防抖
防抖这种情况设置一个v-throttle自定义指令来实现：
// 设置v-throttle自定义指令
Vue.directive('throttle', {
bind: (el, binding) => {
let throttleTime = binding.value; // 防抖时间
if (!throttleTime) { // 用户若不设置防抖时间，则默认2s
throttleTime = 2000;
}
let cbFun;
el.addEventListener('click', event => {
if (!cbFun) { // 第一次执行
cbFun = setTimeout(() => {
cbFun = null;
}, throttleTime);
} else {
event && event.stopImmediatePropagation();
}
}, true);
},
});
// 为button标签设置v-throttle自定义指令
<button @click="sayHello" v-throttle>提交</button>
- 图片懒加载
const LazyLoad = {
// install方法
install(Vue,options){
// 代替图片的loading图
let defaultSrc = options.default;
Vue.directive('lazy',{
bind(el,binding){
LazyLoad.init(el,binding.value,defaultSrc);
},
inserted(el){
// 兼容处理
if('IntersectionObserver' in window){
LazyLoad.observe(el);
}else{
LazyLoad.listenerScroll(el);
}
},
})
},
// 初始化
init(el,val,def){
// data-src 储存真实src
el.setAttribute('data-src',val);
// 设置src为loading图
el.setAttribute('src',def);
},
// 利用IntersectionObserver监听el
observe(el){
let io = new IntersectionObserver(entries => {
let realSrc = el.dataset.src;
if(entries[0].isIntersecting){
if(realSrc){
el.src = realSrc;
el.removeAttribute('data-src');
}
}
});
io.observe(el);
},
// 监听scroll事件
listenerScroll(el){
let handler = LazyLoad.throttle(LazyLoad.load,300);
LazyLoad.load(el);
window.addEventListener('scroll',() => {
handler(el);
});
},
// 加载真实图片
load(el){
let windowHeight = document.documentElement.clientHeight
let elTop = el.getBoundingClientRect().top;
let elBtm = el.getBoundingClientRect().bottom;
let 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){
let currTime = Date.now();
let 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;
- 一键 Copy的功能
import { Message } from 'ant-design-vue';
const vCopy = { //
/*
bind 钩子函数，第一次绑定时调用，可以在这里做初始化设置
el: 作用的 dom 对象
value: 传给指令的值，也就是我们要 copy 的值
*/
bind(el, { value }) {
el.$value = value; // 用一个全局属性来存传进来的值，因为这个值在别的钩子函数里还会用到
el.handler = () => {
if (!el.$value) {
// 值为空的时候，给出提示，我这里的提示是用的 ant-design-vue 的提示，你们随意
Message.warning('无复制内容');
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();
// textarea.setSelectionRange(0, textarea.value.length);
const result = document.execCommand('Copy');
if (result) {
Message.success('复制成功');
}
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 vCopy;
- 在我们实际项目开发中，一般会有多个全局的自定义指令，这时候我们需要写道多个js文件中，并且将他们导出合并成数组，在通过install方法，分别使用vue.directive方法注册指令。
例如路径: src/directives/authorization.js
export default {
key: "authorization",
func: {
inserted(el, binding) {
stepGetKeys().then(
res => {
if (res.indexOf(binding.value) === -1) {
el.style.display = "none";
// 如果没有权限，就删掉该元素
let parent = el.parentNode;
parent.removeChild(el);
}
},
() => {
throw new Error("获取到当前用户权限！");
}
);
}
}
};
然后在src/directives/index.js中引入各个指令
创建install方法，遍历注册：
import Authorization from ''....."
const directives = [......]
export default {
install: Vue => {
if(directives.length && directives.length > 0){
directives.forEach(item => {
Vue.directive(item.key, item.func)
})
}
}
}
最后在main.js中导入，并使用Vue.use()来进行挂载就好啦
参考文章：
https://mp.weixin.qq.com/s/Nq0l10W3EqT-N6Bzuy1iBQ
https://vue3js.cn/docs/zh
https://juejin.cn/post/6844904197448531975#heading-5
