在vue中,有的情况下,仍然需要对普通 DOM 元素进行底层操作,这时候就会用到自定义指令。也就是说我们在操作普通DOM的时候有可能会用到自定义指令。
自定义指令和自定义组件一样,也是先注册后使用,其注册和组件的注册很类似,也分为全局注册和局部注册。只是注册组件时是使用的component关键字,而注册指令时要使用directive关键字。
自定义指令有以下几个钩子函数:
-
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 编译生成的虚拟节点。移步 VNode API 来了解更多详情。
- oldVnode:上一个虚拟节点,仅在
update
和componentUpdated
钩子中可用。
除了 el 之外,其它参数都应该是只读的,切勿进行修改。如果需要在钩子之间共享数据,建议通过元素的 dataset 来进行。
举个例子:
<div id="app">
<input v-mydirective:[pos]="100"/>
<div>
<!-- 这里的pos是动态指令参数 -->
全局注册使用自定义指令:
Vue.directive('mydirective',{
// 钩子函数bind:只调用一次,指令第一次绑定到元素时调用。在这里可以进行一次性的初始化设置
bind:function(el,binding,vnode){
el.style.position = 'fixed'
var s = (binding.arg == 'left' ? 'left' : 'top')
el.style[s] = binding.value + 'px'
},
inserted: function (el) {
// 聚焦元素
el.focus()
},
// 钩子函数update:每当元素本身更新(但是子元素还未更新)时触发
update:function(el,binding,vnode,oldVnode){
if(bingding.oldValue!== bingding.value){
...
}
},
})
局部注册:
new Vue({
data:{
pos: 'left'
},
directives:{
'mydirective':{
bind:function(el,binding,vnode){
el.style.position = 'fixed'
var s = (binding.arg == 'left' ? 'left' : 'top')
el.style[s] = binding.value + 'px'
},
inserted: function (el) {
// 聚焦元素
el.focus()
},
update:function(el,binding,vnode,oldVnode){
...
},
}
}
})
template内部写法:
export default{
data(){
return{
pos: 'left'
}
},
directives:{
'mydirective':{
bind:function(el,binding,vnode){
el.style.position = 'fixed'
var s = (binding.arg == 'left' ? 'left' : 'top')
el.style[s] = binding.value + 'px'
},
inserted: function (el) {
// 聚焦元素
el.focus()
},
update:function(el,binding,vnode,oldVnode){
...
},
}
}
}
参考:
vue官网-自定义指令