除了 Vue 内置的一系列指令 (比如 v-model 或 v-show) 之外,Vue 还允许你注册自定义的指令 (Custom Directives)。
一个自定义指令由一个包含类似组件生命周期钩子的对象来定义。钩子函数会接收到指令所绑定元素作为其参数。下面是一个自定义指令的例子,当一个 input 元素被 Vue 插入到 DOM 中后,它会被自动聚焦:
// 在模板中启用 v-focus
const vFocus = {
mounted: (el) => el.focus()
}
在 中,任何以 v 开头的驼峰式命名的变量都可以被用作一个自定义指令。在上面的例子中,vFocus 即可以在模板中以 v-focus 的形式使用。
在没有使用 的情况下,自定义指令需要通过 directives 选项注册:
export default { setup() { /*...*/ }, directives: { // 在模板中启用 v-focus focus: { /* ... */ } }}
将一个自定义指令全局注册到应用层级也是一种常见的做法:
const app = createApp({})
// 使 v-focus 在所有组件中都可用
app.directive('focus', {
/* ... */
})
一个指令的定义对象可以提供几种钩子函数 (都是可选的):
const myDirective = { // 在绑定元素的 attribute 前 // 或事件监听器应用前调用 created(el, binding, vnode) {}, // 在元素被插入到 DOM 前调用 beforeMount(el, binding, vnode) {}, // 在绑定元素的父组件 // 及他自己的所有子节点都挂载完成后调用 mounted(el, binding, vnode) {}, // 绑定元素的父组件更新前调用 beforeUpdate(el, binding, vnode, prevVnode) {}, // 在绑定元素的父组件 // 及他自己的所有子节点都更新后调用 updated(el, binding, vnode, prevVnode) {}, // 绑定元素的父组件卸载前调用 beforeUnmount(el, binding, vnode) {}, // 绑定元素的父组件卸载后调用 unmounted(el, binding, vnode) {}}
如下是 Vue2 提供的几种钩子函数:
const myDirective = { // 只调用一次,指令第一次绑定到元素时调用。在这里可以进行一次性的初始化设置。 bind(el, binding, vnode) {}, // 被绑定元素插入父节点时调用 (仅保证父节点存在,但不一定已被插入文档中)。 inserted(el, binding, vnode) {}, // 所在组件的 VNode 更新时调用,但是可能发生在其子 VNode 更新之前。指令的值可能发生了改变,也可能没有。但是你可以通过比较更新前后的值来忽略不必要的模板更新 (详细的钩子函数参数见下)。 update(el, binding, vnode) {}, // 指令所在组件的 VNode 及其子 VNode 全部更新后调用。 componentUpdated(el, binding, vnode) {}, // 只调用一次,指令与元素解绑时调用。 unbind(el, binding, vnode) {},}
指令的钩子会传递以下几种参数:
1、el:指令绑定到的元素。这可以用于直接操作 DOM。
2、binding:一个对象,包含以下属性。
1. value:传递给指令的值。例如在 v-my-directive="1 + 1" 中,值是 2。2. oldValue:之前的值,仅在 beforeUpdate 和 updated 中可用。无论值是否更改,它都可用。3. arg:传递给指令的参数 (如果有的话)。例如在 v-my-directive:foo 中,参数是 "foo"。4. modifiers:一个包含修饰符的对象 (如果有的话)。例如在 v-my-directive.foo.bar 中,修饰符对象是 { foo: true, bar: true }。5. instance:使用该指令的组件实例。6. dir:指令的定义对象。
3、vnode:代表绑定元素的底层 VNode。
4、prevVnode:代表之前的渲染中指令所绑定元素的 VNode。仅在 beforeUpdate 和 updated 钩子中可用。
当在组件上使用自定义指令时,它会始终应用于组件的根节点,和透传 attributes 类似。
需要注意的是组件可能含有多个根节点。当应用到一个多根组件时,指令将会被忽略且抛出一个警告。和 attribute 不同,指令不能通过 v-bind="$attrs" 来传递给一个不同的元素。