除了核心功能默认内置的指令 (v-model 和 v-show),Vue 也允许注册自定义指令。而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
来进行。
函数简写
在很多时候,你可能想在 bind 和 update 时触发相同行为,而不关心其它的钩子。比如这样写:
Vue.directive('color-swatch', 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!"
})