Vue 自定义指令
全局指令
使用directive
注册全局指令,我们自定义了指令v-focus
:、
<div id="app">
<p>页面载入时,input 元素自动获取焦点:</p>
<input v-focus>
</div>
<script>
// 注册一个全局自定义指令 v-focus
Vue.directive('focus', {
// 当绑定元素插入到 DOM 中。
inserted: function (el) {
// 聚焦元素
el.focus()
}
})
// 创建根实例
new Vue({
el: '#app'
})
</script>
局部指令
在Vue
实例中使用directives
选项来注册局部指令,这样指令只能在这个实例中使用:
<div id="app">
<p>页面载入时,input 元素自动获取焦点:</p>
<input v-focus>
</div>
<script>
// 创建根实例
new Vue({
el: '#app',
directives: {
// 注册一个局部的自定义指令 v-focus
focus: {
// 指令的定义
inserted: function (el) {
// 聚焦元素
el.focus()
}
}
}
})
</script>
指令钩子
在一个指令中,你可以指定下面的钩子函数,如上述两个示例中都具有inserted
函数。
钩子函数 | 描述 |
---|---|
bind() | 只调用一次,指令第一次绑定到元素时调用,用这个钩子函数可以定义一个在绑定时执行一次的初始化动作 |
inserted() | 被绑定元素插入父节点时调用(父节点存在即可调用,不必存在于 document 中) |
update() | 被绑定元素所在的模板更新时调用,而不论绑定值是否变化。通过比较更新前后的绑定值,可以忽略不必要的模板更新 |
componentUpdated() | 被绑定元素所在模板完成一次更新周期时调用 |
unbind() | 只调用一次, 指令与元素解绑时调用 |
钩子参数
每个钩子函数都有两个常用参数,分别是el
和binding
。
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
编译生成的虚拟节点。
oldValue
:上一个虚拟节点,仅在 update
和 componentUpdated
钩子中可用。
指令简写
如果你的指令只包含inserted
钩子函数,则可以进行简写:
v-rounoob="{color:'red'}"
Vue.directive('runoob', function (el, binding) {
// 设置指令的背景颜色
el.style.backgroundColor = binding.value.color
})