什么是指令
指令系统是计算机硬件的语言系统,也叫机器语言,它是系统程序员看到的计算机的主要属性。因此指令系统表征了计算机的基本功能决定了机器所要求的能力
在vue中提供了一套为数据驱动视图更为方便的操作,这些操作被称为指令系统
我们看到的v-开头的行内属性,都是指令,不同的指令可以完成或实现不同的功能
除了核心功能默认内置的指令 (v-model 和 v-show),Vue 也允许注册自定义指令
指令使用的几种方式:
1 //会实例化一个指令,但这个指令没有参数
2 `v-xxx`
3
4 // -- 将值传到指令中
5 `v-xxx="value"`
6
7 // -- 将字符串传入到指令中,如`v-html="'<p>内容</p>'"`
8 `v-xxx="'string'"`
9
10 // -- 传参数(`arg`),如`v-bind:class="className"`
11 `v-xxx:arg="value"`
12
13 // -- 使用修饰符(`modifier`)
14 `v-xxx:arg.modifier="value"`
#二、如何实现
注册一个自定义指令有全局注册与局部注册
全局注册主要是通过Vue.directive方法进行注册
Vue.directive第一个参数是指令的名字(不需要写上v-前缀),第二个参数可以是对象数据,也可以是一个指令函数
1 // 注册一个全局自定义指令 `v-focus`
2 Vue.directive('focus', {
3 // 当被绑定的元素插入到 DOM 中时……
4 inserted: function (el) {
5 // 聚焦元素
6 el.focus() // 页面加载完成之后自动让输入框获取到焦点的小功能
7 }
8 })
局部注册通过在组件options选项中设置directive属性
1 directives: {
2 focus: {
3 // 指令的定义
4 inserted: function (el) {
5 el.focus() // 页面加载完成之后自动让输入框获取到焦点的小功能
6 }
7 }
8 }
然后你可以在模板中任何元素上使用新的 v-focus property,如下:
1 <input v-focus />
自定义指令也像组件那样存在钩子函数:
bind:只调用一次,指令第一次绑定到元素时调用。在这里可以进行一次性的初始化设置inserted:被绑定元素插入父节点时调用 (仅保证父节点存在,但不一定已被插入文档中)update:所在组件的VNode更新时调用,但是可能发生在其子VNode更新之前。指令的值可能发生了改变,也可能没有。但是你可以通过比较更新前后的值来忽略不必要的模板更新componentUpdated:指令所在组件的VNode及其子VNode全部更新后调用unbind:只调用一次,指令与元素解绑时调用
所有的钩子函数的参数都有以下:
-
el:指令所绑定的元素,可以用来直接操作DOM -
binding:一个对象,包含以下property:name:指令名,不包括v-前缀。value:指令的绑定值,例如:v-my-directive="1 + 1"中,绑定值为2。oldValue:指令绑定的前一个值,仅在update和componentUpdated钩子中可用。无论值是否改变都可用。expression:字符串形式的指令表达式。例如v-my-directive="1 + 1"中,表达式为"1 + 1"。arg:传给指令的参数,可选。例如v-my-directive:foo中,参数为"foo"。modifiers:一个包含修饰符的对象。例如:v-my-directive.foo.bar中,修饰符对象为{ foo: true, bar: true }
-
vnode:Vue编译生成的虚拟节点 -
oldVnode:上一个虚拟节点,仅在update和componentUpdated钩子中可用
除了
el之外,其它参数都应该是只读的,切勿进行修改。如果需要在钩子之间共享数据,建议通过元素的dataset来进行
举个例子:
1 <div v-demo="{ color: 'white', text: 'hello!' }"></div>
2 <script>
3 Vue.directive('demo', function (el, binding) {
4 console.log(binding.value.color) // "white"
5 console.log(binding.value.text) // "hello!"
6 })
7 </script>
应用场景
使用自定义指令可以满足我们日常一些场景,这里给出几个自定义指令的案例:
- 防抖
- 图片懒加载
- 一键 Copy的功能
输入框防抖
防抖这种情况设置一个v-throttle自定义指令来实现
举个例子:
1 // 1.设置v-throttle自定义指令
2 Vue.directive('throttle', {
3 bind: (el, binding) => {
4 let throttleTime = binding.value; // 防抖时间
5 if (!throttleTime) { // 用户若不设置防抖时间,则默认2s
6 throttleTime = 2000;
7 }
8 let cbFun;
9 el.addEventListener('click', event => {
10 if (!cbFun) { // 第一次执行
11 cbFun = setTimeout(() => {
12 cbFun = null;
13 }, throttleTime);
14 } else {
15 event && event.stopImmediatePropagation();
16 }
17 }, true);
18 },
19 });
20 // 2.为button标签设置v-throttle自定义指令
21 <button @click="sayHello" v-throttle>提交</button>
图片懒加载
设置一个v-lazy自定义指令完成图片懒加载
1 const LazyLoad = {
2 // install方法
3 install(Vue,options){
4 // 代替图片的loading图
5 let defaultSrc = options.default;
6 Vue.directive('lazy',{
7 bind(el,binding){
8 LazyLoad.init(el,binding.value,defaultSrc);
9 },
10 inserted(el){
11 // 兼容处理
12 if('IntersectionObserver' in window){
13 LazyLoad.observe(el);
14 }else{
15 LazyLoad.listenerScroll(el);
16 }
17
18 },
19 })
20 },
21 // 初始化
22 init(el,val,def){
23 // data-src 储存真实src
24 el.setAttribute('data-src',val);
25 // 设置src为loading图
26 el.setAttribute('src',def);
27 },
28 // 利用IntersectionObserver监听el
29 observe(el){
30 let io = new IntersectionObserver(entries => {
31 let realSrc = el.dataset.src;
32 if(entries[0].isIntersecting){
33 if(realSrc){
34 el.src = realSrc;
35 el.removeAttribute('data-src');
36 }
37 }
38 });
39 io.observe(el);
40 },
41 // 监听scroll事件
42 listenerScroll(el){
43 let handler = LazyLoad.throttle(LazyLoad.load,300);
44 LazyLoad.load(el);
45 window.addEventListener('scroll',() => {
46 handler(el);
47 });
48 },
49 // 加载真实图片
50 load(el){
51 let windowHeight = document.documentElement.clientHeight
52 let elTop = el.getBoundingClientRect().top;
53 let elBtm = el.getBoundingClientRect().bottom;
54 let realSrc = el.dataset.src;
55 if(elTop - windowHeight<0&&elBtm > 0){
56 if(realSrc){
57 el.src = realSrc;
58 el.removeAttribute('data-src');
59 }
60 }
61 },
62 // 节流
63 throttle(fn,delay){
64 let timer;
65 let prevTime;
66 return function(...args){
67 let currTime = Date.now();
68 let context = this;
69 if(!prevTime) prevTime = currTime;
70 clearTimeout(timer);
71
72 if(currTime - prevTime > delay){
73 prevTime = currTime;
74 fn.apply(context,args);
75 clearTimeout(timer);
76 return;
77 }
78
79 timer = setTimeout(function(){
80 prevTime = Date.now();
81 timer = null;
82 fn.apply(context,args);
83 },delay);
84 }
85 }
86
87 }
88 export default LazyLoad;
一键 Copy的功能
1 import { Message } from 'ant-design-vue';
2
3 const vCopy = { //
4 /*
5 bind 钩子函数,第一次绑定时调用,可以在这里做初始化设置
6 el: 作用的 dom 对象
7 value: 传给指令的值,也就是我们要 copy 的值
8 */
9 bind(el, { value }) {
10 el.$value = value; // 用一个全局属性来存传进来的值,因为这个值在别的钩子函数里还会用到
11 el.handler = () => {
12 if (!el.$value) {
13 // 值为空的时候,给出提示,我这里的提示是用的 ant-design-vue 的提示,你们随意
14 Message.warning('无复制内容');
15 return;
16 }
17 // 动态创建 textarea 标签
18 const textarea = document.createElement('textarea');
19 // 将该 textarea 设为 readonly 防止 iOS 下自动唤起键盘,同时将 textarea 移出可视区域
20 textarea.readOnly = 'readonly';
21 textarea.style.position = 'absolute';
22 textarea.style.left = '-9999px';
23 // 将要 copy 的值赋给 textarea 标签的 value 属性
24 textarea.value = el.$value;
25 // 将 textarea 插入到 body 中
26 document.body.appendChild(textarea);
27 // 选中值并复制
28 textarea.select();
29 // textarea.setSelectionRange(0, textarea.value.length);
30 const result = document.execCommand('Copy');
31 if (result) {
32 Message.success('复制成功');
33 }
34 document.body.removeChild(textarea);
35 };
36 // 绑定点击事件,就是所谓的一键 copy 啦
37 el.addEventListener('click', el.handler);
38 },
39 // 当传进来的值更新的时候触发
40 componentUpdated(el, { value }) {
41 el.$value = value;
42 },
43 // 指令与元素解绑的时候,移除事件绑定
44 unbind(el) {
45 el.removeEventListener('click', el.handler);
46 },
47 };
48
49 export default vCopy;
关于自定义指令还有很多应用场景,如:拖拽指令、页面水印、权限校验等等应用场景