Vue 自定义指令

前言 最近搞了毕设,需要实现一个场景,点击一块区域,弹出一个编辑区域,点击页面的其他地方的时候,这个编辑区域就隐藏,本想想之前写模态框一样写个方法的时候,突然
image

觉得可以尝试用 vue 相关的东西优雅的解决这个事情,然后就学了下面的自定义指令了。

1 Vue 自定义指令

1.1 定义

直接看官网的介绍吧(觉得官方文档说的很清楚了,所以我基本都是抄他的了)。

除了核心功能默认内置的指令 (v-model 和 v-show),Vue 也允许注册自定义指令。注意,在 Vue2.0 中,代码复用和抽象的主要形式是组件。然而,有的情况下,你仍然需要对普通 DOM 元素进行底层操作,这时候就会用到自定义指令。

1.2 基础实现

这个在分两种情况,如果你想定义一个全局的自定义组件的话,那么就在项目中的 main.js 里面定义了,例如定义一个官网中的自动聚焦的指令

1
2
3
4
5
6
7
8
// 注册一个全局自定义指令 `v-focus`
Vue.directive('focus', {
// 当被绑定的元素插入到 DOM 中时……
inserted: function (el) {
// 聚焦元素
el.focus()
}
})

要是你只是想定义一个局部的指令在某个组件内部用的话,那么就在相应的组件内定义了

1
2
3
4
5
6
7
8
9
// 跟 data(),methods:{} 那些同级写了
directives: {
focus: {
// 指令的定义
inserted: function (el) {
el.focus()
}
}
}

定义完后我们就能愉快的使用了

1
<input v-focus>

1.2 钩子函数

当然这个自定义指令不会就这么一点东西啦,为了解决一些现实中场景,Vue 给我们一堆钩子函数用来实现我们的一些骚操作。具体如下 (均为可选):

  • bind:只调用一次,指令第一次绑定到元素时调用。在这里可以进行一次性的初始化设置。

  • inserted:被绑定元素插入父节点时调用 (仅保证父节点存在,但不一定已被插入文档中)。

  • update:所在组件的 VNode 更新时调用,但是可能发生在其子 VNode 更新之前。指令的值可能发生了改变,也可能没有。但是你可以通过比较更新前后的值来忽略不必要的模板更新 (详细的钩子函数参数见下)。
  • componentUpdated:指令所在组件的 VNode 及其子 VNode 全部更新后调用。
  • unbind:只调用一次,指令与元素解绑时调用。
    接下来我们来看一下钩子函数的参数 (即 el、binding、vnode 和 oldVnode)。

当然要想好好用用这写钩子函数,就要懂得用下面的这些参数

1.3 钩子函数参数

指令钩子函数会被传入以下参数:

  • 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 钩子中可用。

然后官网有话说

除了 el 之外,其它参数都应该是只读的,切勿进行修改。如果需要在钩子之间共享数据,建议通过元素的 dataset 来进行。

然后下面我们给一个简单的例子

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
// 在组件内部定义一个局部指令
directives:{
demo:{
bind: function (el, binding, vnode) {
var s = JSON.stringify;
el.innerHTML =
`name: ${s(binding.name)} <br>
value: ${s(binding.value)} <br>
expression: ${s(binding.expression)} <br>
argument: ${s(binding.arg)} <br>
modifiers: ${s(binding.modifiers)} <br>
vnode keys: ${Object.keys(vnode).join(', ')}`
}
}
}
// 绑定到组件中的一个 div 中
<div v-demo:foo.a.b="message"></div>

然后我们在网页中就可以看到这么一堆文字了(当然下面的注释是我自己写的)

1
2
3
4
5
6
7
8
9
10
11
12
name: "demo" 
// 指定名称
value: "Welcome to Your Vue.js App"
// 指令绑定值
expression: "message"
// 字符串形式的指令表达式
argument: "foo"
// 传给指令的参数
modifiers: {"a":true,"b":true}
// 修饰符的对象
vnode keys: tag, data, children, text, elm, ns, context, fnContext, fnOptions, fnScopeId, key, componentOptions, componentInstance, parent, raw, isStatic, isRootInsert, isComment, isCloned, isOnce, asyncFactory, asyncMeta, isAsyncPlaceholder
Vue 编译生成的虚拟节点

1.4 函数简写

在很多时候,你可能想在 bindupdate 时触发相同行为,而不关心其它的钩子。比如这样写:

1
2
3
colorSwatch: function colorSwitch(el, binding) {
el.style.backgroundColor = binding.value
},

1.5 对象字面量

如果指令需要多个值,可以传入一个 JavaScript 对象字面量。记住,指令函数能够接受所有合法的 JavaScript 表达式。

1
<div v-demo="{ color: 'white', text: 'hello!' }"></div>

1
2
3
4
Vue.directive('demo', function (el, binding) {
console.log(binding.value.color) // => "white"
console.log(binding.value.text) // => "hello!"
})

就差不多这样吧,想看个实例的话就看一下我的另外一篇笔记《Vue 自定义指令实现点击元素外触发事件》



----------- 本文结束 -----------




小红帽 wechat
想看更多文章,那就订阅我的微信公众号吧
如果觉得我的文章对你有很大帮助的话,请我喝杯奶茶吧~(@^_^@)~