-
使用场景
除了核心功能默认内置的指令,Vue 也允许注册自定义指令, 在你需要对普通 DOM 元素进行底层操作的情况下,这时候就会用到自定义指令directive
。
-
注册方式以及用法
directive
分为全局注册以及局部注册两种,注册后在标签上使用 v-
注册名
即可使用,在下例中,使用 v-name
// 全局注册
Vue.directive('name',function(){
// do something
});
// 局部注册
new Vue({
directives:{
name:{
// do something
}
}
});
-
钩子函数
在注册
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 }
-
-
vnode
:Vue 编译生成的虚拟节点 -
oldVnode
:上一个虚拟节点,仅在update
和componentUpdated
钩子中可用
注意!除了
el
之外,其它参数都应该是只读的,切勿进行修改。如果需要在钩子之间共享数据,建议通过元素的dataset
来进行。
举个例子,我们在项目中的按钮需要通过权限来控制是否渲染,那么我们可以做一个权限指令来判断是否渲染,
<template>
<div>
<button v-permission="['add_btn']">新增</button>
<button v-permission="['edit_btn']">编辑</button>
<button v-permission="['remove_btn']">删除</button>
</div>
</template>
<script>
// 模拟从后端拿到权限数据为一个数组,里面有新增以及编辑两个按钮权限:
const data = [ 'add_btn', 'edit_btn' ]
export default {
name: '',
directives: {
// 定义一个 permission 的指令
permission: {
// 在节点被插入父节点时调用
inserted (el, binding, vnode) {
const { value } = binding
const permissionRoles = value
const hasPermission = data.some(role => {
return permissionRoles.includes(role)
})
// 如果没有权限,则移除按钮节点
if (!hasPermission) {
el.parentNode && el.parentNode.removeChild(el)
}
}
}
}
}
</script>
这样,就完成了一个按钮级别的权限管理, 自定义指令当然还有更多的用处,比如按钮的点击波纹,按钮点击请求返回前的禁用,某节点加载时loading,如开头所说的,在你需要对普通 DOM 元素进行底层操作的情况下,这时候就会用到自定义指令directive
。
网友评论