官网传送门:directive
# 背景
除了核心功能默认内置的指令 (v-model
和 v-show
),Vue 也允许注册自定义指令。注意,在 Vue2.0
中,代码复用和抽象的主要形式是组件。然而,有的情况下,你仍然需要对普通 DOM 元素进行底层操作,这时候就会用到自定义指令。 从一个输入框自动聚焦的案例入手:
正常情况下,考虑复用性,自定义一个指令我们希望能给全局使用,因此选择全局注册
Vue.directive('focus', {
// 指令绑定的元素被插入到 DOM 中时
inserted (el) {
// 聚焦元素
el.focus()
}
})
如果你的指令只在该组件中使用,可以选择注册局部指令。在Vue的实例对象中,提供有directives
选项(注意有s
)
directives: {
inserted (el) {
el.focus()
}
}
然后你可以在模板中任何元素上使用v-focus
属性。如:
<input v-focus >
本案例希望被指令绑定的元素在插入到DOM中时,就能获取到焦点,因此使用了inserted
钩子。或许你会疑惑,以前怎么没见过这个钩子函数?因为这是指令执行的钩子,而不是Vue实例生命周期的钩子
# Vue实例生命周期钩子函数
先来回顾一下,Vue实例生命周期中都有哪些钩子函数
Vue2.0生命钩子 | 描述 |
---|---|
beforeCreate | 组件实例刚被创建,组件属性被计算之前,如:data
|
creaated | 组件实例创建完成,属性值已绑定,DOM 还未生成,$el 属性还不存在 |
beforeMount | 模板编译/挂载之前 |
mounted | 模板编译/挂载之后 |
beforeUpdate | 组件更新之前 |
updated | 组件已更新 |
activated | for keep-alive ,组件被激活时调用 |
deactivated | for keep-alive ,组件被移除时调用 |
beforeDestory | 组件被销毁之前 |
destoryed | 组件销毁后调用 |
具化如下所示
# 指令的钩子函数
一个指令定义对象可以提供如下几个钩子函数
指令的钩子 | 描述 |
---|---|
bind | 只调用一次,指令第一次绑定到元素时调用 |
inserted | 被绑定元素插入父节点时调用 |
update | 所在组件的VNode 更新时调用,可能发生在其子VNode更新之前 |
componentUpdated | 指令所在组件的VNode及其子VNode全部更新后调用 |
unbind | 只调用一次,指令与元素解绑时调用 |
$ 钩子函数的参数
钩子函数可以接受一些参数,用来指定要操作的对象或事件
-
el
:指令所绑定的元素,可以用来直接操作 DOM 。 -
binding
:一个对象,包含以下属性:-
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="hook-arguments-example" v-demo:foo.a.b="message"></div>
这里采用复用性高的全局注册
Vue.directive('demo', {
bind () {
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'
}
})
执行结果:
name: "demo"
value: "hello!"
expression: "message"
argument: "foo"
modifiers: {"a":true,"b":true}
vnode keys: tag, data, children, text, elm, ns, context,
fnContext, fnOptions, fnScopeId, key, componentOptions,
componentInstance, parent, raw, isStatic, isRootInsert,
isComment, isCloned, isOnce, asyncFactory, asyncMeta, isAsyncPlaceholder
$ 函数简写
在很多时候,你可能想在 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!"
})
网友评论