前言
在vue项目中我们经常使用到 v-show ,v-if,v-for等内置的指令,除此之外vue还提供了非常方便的自定义指令,供我们对普通的dom元素进行底层的操作。使我们的日常开发变得更加方便快捷。本文就来总结一下自定义指令的使用方法及常用的场景。
正文
全局注册
// 注册一个全局自定义指令 `v-focus`
Vue.directive('focus', {
// 当被绑定的元素插入到 DOM 中时……
inserted: function (el) {
// 聚焦元素
el.focus()
}
})
局部注册
directives: { focus: {
// 指令的定义
inserted: function (el) {
el.focus()
}
}
}
注意:当同一个元素及使用了全局指令和局部指令对统一属性进行操作的时候,会优先使用局部自定义指令,这里采用就近原则,局部指令会优先于全局指令对统一属性操作的调用。
钩子函数及参数设置
看了上面的介绍我们值都了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 }。
- name:指令名,不包括
-
vnode:Vue 编译生成的虚拟节点。移步 VNode API 来了解更多详情。
-
oldVnode:上一个虚拟节点,仅在 update 和 componentUpdated 钩子中可用。
v-Img
// 自定义指令 设置默认头像
Vue.directive('errorImg', {
inserted(el, binding) {
// 元素加载执行的时候出现错误就会触发这个事件,表示资源加载失败
el.onerror = function() {
// 如果图片加载失败,就显示默认图片,加载成功不用管
el.src = binding.value
}
}
})
v-showBtn
// 自定义指令,判断是否有权限,显示隐藏按钮
Vue.directive('showBtn', {
inserted(el, binding) {
// 数据存在了vuex中,所以在store中找
const points = store.state.user.userInfo.roles.points
//points权限中是否包含你传过来的数据
const flag = points.includes(binding.value)
if (!flag) {
// 不显示就要移除按钮,需要父元素移除自己
el.parentNode.removeChild(el)
}
}
})