1. 前言
同学们需要充分理解每个指令钩子函数执行的时机、对动态指令参数多加练习才能对指令的使用得心应手。
2. 解释
在之前的章节中我们学习了指令 v-show,他的实现原理就是操作 DOM 元素的样式 display,使之实现隐藏、显示的效果。在日常开发中,我们经常把一些对 DOM 大量相同的操作封装成指令。学好指令可以给我们的开发带来便利、提高效率。同学们需要总结业务中的各种场景,多加练习。
3.1 全局注册
-
短横线:
<my-directive>
-
驼峰式:
<MyDirective>
使用驼峰命名指令时,首字母最好以大写字母开头。
// 注册
// 驼峰命名
Vue.directive('MyDirective', {/* */})
// 短横线命名
Vue.directive('my-directive', {/* */})
// 使用
<div v-my-directive></div>
<!DOCTYPE html>
<html lang="en">
<head>
<Meta charset="UTF-8">
<Meta name="viewport" content="width=device-width, initial-scale=1.0">
<Meta http-equiv="X-UA-Compatible" content="ie=edge">
<title>Document</title>
</head>
<body>
<div id="app">
<div>
<label>姓名:</label>
<input id="name" v-focus type="text"/>
</div>
<div>
<label>年龄:</label>
<input id="age" type="text"/>
</div>
</div>
</body>
<script src="https://unpkg.com/vue/dist/vue.js"></script>
<script type="text/javascript">
Vue.directive('focus', {
inserted(el) {
el.focus()
}
})
var vm = new Vue({
el: '#app',
data() {
return {}
}
})
</script>
</html>
代码解释:
JS 代码第 3-7 行,我们定义了指令 v-focus,定义 inserted 钩子函数,在节点被插入时获得焦点。
HTML 代码第 4 行,我们在 input
元素上使用指令,当页面打开时 id 为 name 的输入框会自动获取焦点。
3.2 局部注册
// 注册
// 短横线命名
{
directives: {
'my-directive': {
inserted: function (el) {
el.focus()
}
}
}
}
// 驼峰命名
{
directives: {
'MyDirective': {
inserted: function (el) {
el.focus()
}
}
}
}
// 使用
<div v-my-directive></div>
<!DOCTYPE html>
<html lang="en">
<head>
<Meta charset="UTF-8">
<Meta name="viewport" content="width=device-width, initial-scale=1.0">
<Meta http-equiv="X-UA-Compatible" content="ie=edge">
<title>Document</title>
</head>
<body>
<div id="app">
<div>
<label>姓名:</label>
<input v-focus type="text"/>
</div>
<div>
<label>年龄:</label>
<input type="text"/>
</div>
</div>
</body>
<script src="https://unpkg.com/vue/dist/vue.js"></script>
<script type="text/javascript">
var vm = new Vue({
el: '#app',
data() {
return {}
},
directives: {
focus: {
inserted: function (el) {
el.focus()
}
}
}
})
</script>
</html>
代码解释:
JS 代码第 8-14 行,我们定义了局部指令 v-focus,定义 inserted 钩子函数,在节点被插入时获得焦点。
HTML 代码第 4 行,我们在 input
元素上使用指令,当页面打开时 id 为 name 的输入框会自动获取焦点。
4. 钩子函数
4.1 钩子函数参数
指令钩子函数会被传入以下参数:
-
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
钩子中可用。
4.2 动态指令参数
指令的参数可以是动态的。例如,在 v-mydirective:[argument]=“value” 中,argument 参数可以根据组件实例数据进行更新!这使得自定义指令可以在应用中被灵活使用。
<!DOCTYPE html>
<html lang="en">
<head>
<Meta charset="UTF-8">
<Meta name="viewport" content="width=device-width, initial-scale=1.0">
<Meta http-equiv="X-UA-Compatible" content="ie=edge">
<title>Document</title>
</head>
<body>
<div id="app">
<div v-color="color">Hello !</div>
<button @click="changeColor">切换颜色</button>
</div>
</body>
<script src="https://unpkg.com/vue/dist/vue.js"></script>
<script type="text/javascript">
Vue.directive('color', {
bind: function (el, binding, vnode) {
el.style.color = binding.value
},
update(el, binding) {
el.style.color = binding.value
}
})
var vm = new Vue({
el: '#app',
data() {
return {
color: 'red'
}
},
methods: {
changeColor() {
this.color = '#' + Math.floor( Math.random() * ).toString();
}
}
})
</script>
</html>
代码解释:
JS 代码第 3-10 行,我们定义了全局指令 v-color,定义 bind 钩子函数设置元素的字体颜色,定义 update 钩子函数,在节点更新时修改元素的字体颜色。
HTML 代码第 2 行,我们使用 v-color 指令,并动态传入值 color。
HTML 代码第 3 行,点击按钮切换 color 的值。
最终,当我们点击按钮时,“Hello !” 的字体颜色会随机变化。
上面的例子中我们通过指令动态设置了元素的字体颜色。但如果场景是我们需要修改元素的边框颜色又该怎么办呢?有些同学可能说我们可以再写一个 v-border-color 不就行了。那如果又有修改背景色的需求呢?这时使用动态参数就可以非常方便地根据每个组件实例来进行更新:
<!DOCTYPE html>
<html lang="en">
<head>
<Meta charset="UTF-8">
<Meta name="viewport" content="width=device-width, initial-scale=1.0">
<Meta http-equiv="X-UA-Compatible" content="ie=edge">
<title>Document</title>
</head>
<body>
<div id="app">
<div v-color:[colorstyle]="color" style="border: px solid #ccc;">Hello !</div>
<div v-color:[borderstyle]="color" style="border: px solid #ccc;">Hello !</div>
<div v-color:[backgroundstyle]="color" style="border: px solid #ccc;">Hello !</div>
<button @click="changeColor">切换颜色</button>
</div>
</body>
<script src="https://unpkg.com/vue/dist/vue.js"></script>
<script type="text/javascript">
Vue.directive('color', {
bind: function (el, binding, vnode) {
var s = binding.arg
el.style[s] = binding.value
},
update(el, binding) {
var s = binding.arg
el.style[s] = binding.value
}
})
var vm = new Vue({
el: '#app',
data() {
return {
color: 'red',
colorstyle: 'color',
borderstyle: 'border-color',
backgroundstyle: 'background-color',
}
},
methods: {
changeColor() {
this.color = '#' + Math.floor( Math.random() * ).toString();
}
}
})
</script>
</html>
代码解释:
JS 代码第 3-12 行,我们定义了全局指令 v-color,定义 bind 钩子函数和 update 钩子函数。
HTML 代码第 2-4 行,我们使用 v-color 指令,并动态传入值 color。
HTML 代码第 5 行,点击按钮切换 color 的值。
最终,当我们点击 "切换颜色" 按钮时,分别会修改元素的 color、border-color、background-color 样式属性。
4.3 对象字面量
<!DOCTYPE html>
<html lang="en">
<head>
<Meta charset="UTF-8">
<Meta name="viewport" content="width=device-width, initial-scale=1.0">
<Meta http-equiv="X-UA-Compatible" content="ie=edge">
<title>Document</title>
</head>
<body>
<div id="app">
<div v-font="font">Hello !</div>
</div>
</body>
<script src="https://unpkg.com/vue/dist/vue.js"></script>
<script type="text/javascript">
Vue.directive('font', {
bind: function (el, binding, vnode) {
el.style.color = binding.value.color
el.style['font-size'] = binding.value.size
}
})
var vm = new Vue({
el: '#app',
data() {
return {
font: {
size: '26px',
color: 'red'
}
}
}
})
</script>
</html>
代码解释:
JS 代码第 3-8 行,我们定义了全局指令 v-font。
JS 代码第 13-16 行,我们定义了对象类型的值 font。
HTML 代码第 2 行,我们使用 v-font 指令,并动态传入对象类型的值 font。
5. 小结
本节,我们带大家学习了自定义指令在项目中的运用。主要知识点有以下几点: