vue 自定义指令

除了默认设置的核心指令(v-model和v-show),vue也允许注册自定义指令。在vue2.0版本中,代码复用的主要形式和抽象是组件--然而,有的情况下,你仍然需要对DOM元素进行底层操作,这时候就会用到自定义指令。

当页面加载时,元素将获得焦点(注意:autoFocus在移动版safari中不工作),事实上,你访问后,还没点击任何内容,input就获得了焦点。现在让我们完善这个指令:

// 注册一个全局自定义指令 v-focus
Vue.directive('focus', {
// 当绑定元素插入到 DOM 中。
inserted: function (el) {
// 聚焦元素
el.focus()
}
})
 
也可以注册局部指令,组件中接受一个directives的选项:
directives: {
focus: {
// 指令的定义---
 
}
}
 
然后你可以在模板中任何元素上使用新的v-focus属性:
<input v-focus>

钩子函数

指令定义函数提供了几个钩子函数(可选):

  • bind:只调用一次,指令第一次绑定到元素时调用,用这个钩子函数可以定义一个在绑定时执行一次的初始化动作,
  • inserted:被绑定元素插入父节点时调用,(父节点存在即可,不必存在于document中)
  • update:所在组件的VNode更新时调用,但是可能发生在其孩子的VNode更新之前。指令的值可能发生了改变也可能没有,但是你可以通过比较更新前后的值来忽略不必要的模板更新,
  • compontentUpdated:所在组件的VNode及其孩子的VNode全部更新时调用
  • unbind:只调用一次,指令与元素解绑时调用

接下来我们来看一下钩子函数的参数 (包括 elbindingvnodeoldVnode) 。

钩子函数参数

钩子函数被赋予了以下参数:

  • el:指令所绑定的元素,可以用来直接操作dom
  • binding:一个对象,包含以下属性:name:指令名,不包含v-前缀。value:指令的绑定值,例:v-my-directive = '1+1',value的值是2。oldValue:指令绑定的前一个值,仅在update和componentUpdate钩子中可用,无论值是否改变都可用。expression:绑定值的字符串形式,例v-my-directive = '1+1';expression的值是1+1。arg:传给指令的参数。例如:v-my-directive:foo,arg的值是foo。modifiers:一个包含修饰符的对象,例如:v-my-directive.foo.bar,修饰符对象modifiers:{foo:true,bar:true}。
  • VNode:vue编译生成的虚拟节点。查阅 VNode API 了解更多详情。
  • oldValue:上一个虚拟节点,仅在update和componentUpdate钩子中可用

除了el之外,其他参数都应该是只读的,尽量不要修改他们,如果需要在钩子之间共享数据,建议通过使用dataset来进行。

一个使用了这些参数的自定义钩子样例:

Vue.directive('demo', {
bind: function (el, binding, vnode) {
var s = JSON.stringify
el.innerHTML =
'name: ' + s(binding.name) + '<br>' +
'value: ' + s(binding.value) + '<br>' +
'expression: ' + s(binding.expression) + '<br>' +
'argument: ' + s(binding.arg) + '<br>' +
'modifiers: ' + s(binding.modifiers) + '<br>' +
'vnode keys: ' + Object.keys(vnode).join(', ')
}
})
 
new Vue({
el: '#hook-arguments-example',
data: {
message: 'hello!'
}
})
 
函数简写
大多数情况下,我们可能想在bind和update钩子上做重复动作,并且不想关心其他的钩子函数,可以这样写:
vue.directive('color-switch',function(el,binding){
el.style.backgroundColor = binding.value;
})
 
对象字面量
如果指令需要多个值,可以传入一个javascript对象字面量。记住,指令函数能够接受所有合法类型的javascript表达式。
<div v-demo="{ color: 'white', text: 'hello!' }"></div>
Vue.directive('demo', function (el, binding) {
console.log(binding.value.color) // => "white"
console.log(binding.value.text) // => "hello!"
})

 

 

posted @ 2017-08-25 15:02  susanws  阅读(301)  评论(0编辑  收藏  举报