自定义指令
Vue.js已经为我们提供了很多默认的指令,例如:v-for
、v-if
、v-bind
、v-on
等,这些指令已经可以帮助我们完成很多的事情,但是当我们有一些特殊化的需求时就需要自己做定制了,这时候自定义指令就登场了。
注册
自定义指令的注册方式和组件的注册类似,也有全局注册和局部注册两种方式。
- 全局注册
// 注册一个全局自定义指令 v-focus
Vue.directive('focus', {
// 当绑定元素插入到 DOM 中。
inserted: function (el) {
// 聚焦元素
el.focus()
}
})
- 局部注册
directives: {
focus: {
// 指令的定义---
}
}
这样我们就可以在标签中使用注册的指令了。
<input v-focus>
钩子函数
-
bind:
只调用一次,指令第一次绑定到元素时调用,用这个钩子函数可以定义一个在绑定时执行一次的初始化动作。 -
inserted
被绑定元素插入父节点时调用(父节点存在即可调用,不必存在于 document 中)。 -
update
被绑定元素所在的模板更新时调用,而不论绑定值是否变化。通过比较更新前后的绑定值,可以忽略不必要的模板更新(详细的钩子函数参数见下)。 -
componentUpdated
被绑定元素所在模板完成一次更新周期时调用。 -
unbind
只调用一次, 指令与元素解绑时调用。
钩子函数的参数
-
el
指令所绑定的元素,可以用来直接操作 DOM 。 -
binding
一个对象,包含以下属性:-
name
指令名,不包括 v- 前缀。 -
value
指令的绑定值, 例如: v-my-directive="1 + 1", value 的值是 2。 -
oldValue
指令绑定的前一个值,仅在 update 和 componentUpdated 钩子中可用。无论值是否改变都可用。 -
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 了解更多详情。 -
oldVnode
上一个虚拟节点,仅在 update 和 componentUpdated 钩子中可用。
下面通过一个🌰来看下这些参数。
<div id="hook-arguments-example" v-demo:hello.a.b="message"></div>
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>'
}
})
new Vue({
el: '#hook-arguments-example',
data: {
message: 'hello!'
}
})
// 结果
name: demo
value: hello!
expression: message
argument: hello
modifiers: {a: true, b: true}
网友评论