自定义指令介绍
# 自定义指令介绍
# 📖. 前言
在 Vue,除了核心功能默认内置的指令 ( v-model
和 v-show
),Vue
也允许注册自定义指令。它的作用价值在于当开发人员在某些场景下需要对普通 DOM
元素进行操作。
# 一. 什么是指令
开始之前我们先学习一下指令系统这个词。
指令系统 是计算机硬件的语言系统,也叫机器语言,它是系统程序员看到的计算机的主要属性。因此指令系统表征了计算机的基本功能决定了机器所要求的能力。
在 vue
中提供了一套为数据驱动视图更为方便的操作,这些操作被称为指令系统。
我们看到的 v-
开头的行内属性,都是指令,不同的指令可以完成或实现不同的功能。除了核心功能默认内置的指令(v-model
和 v-show
),Vue
也允许注册自定义指令。
- 指令的几种使用方式
//会实例化一个指令,但这个指令没有参数
`v-xxx`
// -- 将值传到指令中
`v-xxx="value"`
// -- 将字符串传入到指令中,如`v-html="'<p>内容</p>'"`
`v-xxx="'string'"`
// -- 传参数(`arg`),如`v-bind:class="className"`
`v-xxx:arg="value"`
// -- 使用修饰符(`modifier`)
`v-xxx:arg.modifier="value"`
1
2
3
4
5
6
7
8
9
10
11
12
13
14
2
3
4
5
6
7
8
9
10
11
12
13
14
# 二. 如何实现
注册一个自定义指令有全局注册与局部注册。
# 1. 全局注册
全局注册主要是通过
Vue.directive
方法进行注册。
Vue.directive
第一个参数是指指令的名字(不需要写上 v-
前缀),第二个参数可以是对象数据,也可以是一个指令函数
// 注册一个全局自定义指令 `v-focus`
Vue.directive('focus', {
// 当被绑定的元素插入到 DOM 中时……
inserted: function (el) {
// 聚焦元素
el.focus() // 页面加载完成之后自动让输入框获取到焦点的小功能
}
})
1
2
3
4
5
6
7
8
2
3
4
5
6
7
8
# 2. 局部注册
局部注册通过在组件
options
选项中设置directive
属性
<script>
export default {
directives: {
focus: {
// 指令的定义
inserted: function (el) {
el.focus() // 页面加载完成之后自动让输入框获取到焦点的小功能
}
}
}
}
</script>
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
然后你可以在模板中任何元素上使用新的 v-focus property,如下:
<input v-focus />
1
# 3. 指令钩子函数
自定义指令也像组件那样存在钩子函数:
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
来进行。
举个例子:
<div v-demo="{ color: 'white', text: 'hello!' }"></div>
<script>
Vue.directive('demo', function (el, binding) {
console.log(binding.value.color) // "white"
console.log(binding.value.text) // "hello!"
})
</script>
1
2
3
4
5
6
7
2
3
4
5
6
7
上次更新: 2022/07/08, 17:40:08