Vue自定义指令:通过Vue.directive实现集成第三方插件,拖拽功能,图片加载等功能

时间: 2017-12-25阅读: 1950标签: 指令

什么时候需要Vue自定义指令?

当我们需要对Dom元素进行底层操作的时候,这时候我们就需要使用vue的自定义指令。


如何注册自定义指令?

1.全局注册,需要注意的是全局注册自定义指令需在实例化Vue之前:

Vue.directive('指令名称','指令对象');

2.局部组件注册

export default{ 
     directives:{
        '指令名称':'指令配置'
     },
 }


Vue的钩子函数

bind:只调用一次,指令第一次绑定到元素时调用。在这里可以进行一次性的初始化设置。

inserted:被绑定元素插入父节点时调用 (仅保证父节点存在,但不一定已被插入文档中)。

update:所在组件的 VNode 更新时调用,但是可能发生在其子 VNode 更新之前。指令的值可能发生了改变,也可能没有。

componentUpdated:指令所在组件的 VNode 及其子 VNode 全部更新后调用。 

unbind:只调用一次,指令与元素解绑时调用。

Vue.directive('drag',{
    bind:function(el,binding){ //第一次绑定到元素时调用,进行一次性的初始化设置

    },
    inserted:function(el,binding){ //当被绑定的元素插入到 DOM 中时
    
    },
   update:function(el,binding){ //组件的 VNode 更新时调用
    
    },
    componentUpdated:function(el,binding){ //指令所在组件的 VNode 及其子VNode全部更新后调用。
    
    },
    unbind:function(el,binding){//只调用一次,指令与元素解绑时调用。
    	
    }
});


vue钩子函数参数

el:指令所绑定的元素,可以用来直接操作 DOM 。 

binding:一个对象,包含以下属性:

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 编译生成的虚拟节点。移步 VNode API 来了解更多详情。
oldVnode:上一个虚拟节点,仅在 update 和 componentUpdated 钩子中可用。

注意:除了el之外,其它参数都应该是只读的,切勿进行修改。如果需要在钩子之间共享数据,建议通过元素的 dataset 来进行。  


vue自定义指令例子:

1.实现拖拽功能

html:

<body>
	<style>
		.box{
			width:100px; height:100px; background:red; position:absolute; left:0;top:0;
		}
	</style>
	<div id="box">
		<div v-drag class="box" v-text="name"></div>
	</div>
</body>

js:

<script src="https://cdn.jsdelivr.net/npm/vue"></script>
<script>
	/* vue-自定义指令-拖拽 */
	Vue.directive('drag',{
		inserted:function(el) { //钩子函数-//当被绑定的元素插入到 DOM 中时……
			let elem = el; //el触发的DOM元素
			elem.onmousedown = function(e) {
				let l = e.clientX - elem.offsetLeft;
				let t = e.clientY - elem.offsetTop;
				document.onmousemove = function(e) {
					elem.style.left = e.clientX - l + 'px';
					elem.style.top = e.clientY - t + 'px';
				};
				elem.onmouseup = function() {
					document.onmousemove = null;
					elem.onmouseup = null;
				}
			}
		},
	});
	var vm = new Vue({
		el: '#box',
		data: {
			name: 'drag'
		}
	});
</script>


2.实现图片加载功能:

图片在加载过程中,未加载完成时,使用一个随机的颜色占位,图片加载完后直接显示,可以使用自定义指令来完成 

html:

<body>
	<style>
		.imgdiv{
			width:100px; height:100px;
		}
	</style>
	<div id="box">
		<div v-img="urlimg" class="imgdiv"></div> 
	</div>
</body>

js:

<script src="https://cdn.jsdelivr.net/npm/vue"></script>
<script>
     Vue.directive('img',function(el,binding){//函数简写,在 bind 和 update时触发相同行为,而不关心其它的钩子。
	  var color=Math.floor(Math.random()*1000000);//设置随机颜色
	  el.style.backgroundColor='#'+color;
	  var img=new Image();
	  img.src=binding.value;// -->binding.value指的是指令后的参数
	  img.onload=function(){
	    el.style.backgroundColor='';el.src=binding.value;      
	  }
	});
	var vm = new Vue({
		el: '#box',
		data: {
			urlimg: '/20171225/5a40612fcc533.jpg'
		}
	});
</script>


Vue自定义指令集成第三方插件 

自定义指令的另一个好处是用于集成第三方js插件,这样插件就可以直接拿来使用,而不需要改造或重构。这里已highlight.js为例,我们可以直接将其封装为一个自定义指令,这样highlight.js就变成了Vue的一个新功能。

<script>
	var hljs=require("highligh.js")
	Vue.directive('highligh',function(el){
			hljs.highlightBlock(el);
		},
    });	
</script>

使用:

<pre><code v-highligh></code></pre>