vue 自定义指令
Vue 允许用户注册自定义指令。可以全局注册一个自定义指令,也可以局部注册。
钩子函数
一个指令定义对象可以提供如下几个钩子函数 (均为可选):
- 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 钩子中可用。
注册全局自定义指令
1. 新建文件custom.js:
import Vue from 'vue'
// 注册全局自定义指令
// 注册全局自定义指令 `v-square`
Vue.directive('square', {
// 指令第一次绑定到元素时调用bind函数
bind: function (el, binding) {
// 将指令所绑定的指(binding.value)的2次方,赋值给指令绑定的元素的
el.textContent = Math.pow(binding.value, 2)
},
// 指令的值更新时调用bind函数
updated: function (el, binding) {
el.textContent = Math.pow(binding.value, 2)
}
})
// 注册全局自定义指令 `v-focus`
Vue.directive('focus', {
// 当被绑定的元素插入到 DOM 中时, 执行inserted函数
inserted: function (el) {
// 聚焦元素
el.focus()
}
})
2. 在App.vue中引入cutom.js
import './components/custom.js' // 引入自定义指令文件
3. 在模板中使用自定义指令
<template>
<div class="hello">
<!-- 使用指令 v-square -->
<p v-square="25"></p>
<!-- 使用指令 v-focus -->
<input type="text" v-focus />
</div>
</template>