前言

首先如果大家对于 Vue 的指令及过滤器比较熟的话,建议直接跳过本文,本文主要是引用官网的文档对指令及过滤器做个大概的说明,其实说起来可能不太有必要,但是作为一个系列文章,我觉得还是有必要单独提一下指令及过滤器的!

Vue 项目开发中,经常遇到需要使用自定义指令和过滤器的情况,比如我们需要对输入框的输入进行限制(需要进行 DOM 操作),这时使用自定义指令会比较方便,而有时候我们需要对显示到模板的数据进行处理,但是又不想改变原数据,比如我们想让一串数字显示的时候带上千分位符,这时候就可以使用过滤器!那么本文就来详细说一下 Vue 的指令及过滤器开发!

自定义指令

上面说到,一般我们在数据到模板的绑定之外,经常还会遇到需要操作底层 DOM 的情况,这时候我们推荐使用自定指令来完成相关操作。在 Vue 中,我们可以使用 Vue.directive 注册全局指令,在组件中使用 directives 注册局部指令。

这里使用官网的例子来进行下简单说明:

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

// 注册局部指令
{
directives: {
focus: {
// 指令的定义
inserted: function (el) {
el.focus();
},
},
},
};

然后可以在模板中使用 v-focus 指令:

1
<input v-focus>

在上面的例子中我们看到了一个简单指令实现,在我们的实现中,我们经常会用的指令的函数钩子:bindinsertedupdatecomponentUpdatedunbind。关于这些钩子及参数的说明,官网有很明确的说明Vue官方文档 - 自定义指令,为了方便大家观看,我这里就对相关内容进行引用。

钩子函数:

一个指令定义对象可以提供如下几个钩子函数 (均为可选):
bind:只调用一次,指令第一次绑定到元素时调用。在这里可以进行一次性的初始化设置。
inserted:被绑定元素插入父节点时调用 (仅保证父节点存在,但不一定已被插入文档中)。
update:所在组件的 VNode 更新时调用,但是可能发生在其子 VNode 更新之前。指令的值可能发生了改变,也可能没有。但是你可以通过比较更新前后的值来忽略不必要的模板更新 (详细的钩子函数参数见下)。
componentUpdated:指令所在组件的 VNode 及其子 VNode 全部更新后调用。
unbind:只调用一次,指令与元素解绑时调用。
接下来我们来看一下钩子函数的参数 (即 el、binding、vnode 和 oldVnode)。

钩子函数参数:

指令钩子函数会被传入以下参数:
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 来进行。

过滤器

上面引用 Vue 官方文档的内容,对自定义指令有了一些简单的了解。下面我们就来简单讲讲过滤器!首先我们在实际项目开发中,经常会遇到需要对展示数据进行处理,但是又不能修改源数据,这个时候我们就可以使用过滤器来处理:

1
<div v-bind:id="rawId | formatId(1)"></div>

过滤器的定义:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
// 定义全局过滤器
import Vue from 'vue';

Vue.firlter('formatId', function(id, num) {
num = num || 0;
if (!id) {
return `dom-${num}`;
}

return `${id}-${num}`;
})

// 定义局部过滤器
{
filters: {
formatId: function (id, num) {
num = num || 0;
if (!id) {
return `dom-${num}`;
}

return `${id}-${num}`;
},
},
};

看完上面的例子,我们很容易看出来,过滤器的第一个参数为表达式的值,及例子中的 rawId,后面作为过滤器参数传入的参数会依次作为第二,第三。。。等等参数传入。并且除此之外,多个过滤器还可以同时使用:

1
<div v-bind:id="rawId | toString | formatId(1)"></div>

在上面的例子中,我们首先将表达式 rawId 的值通过 toString,过滤器,确保值一定是个字符串,然后在使用 formatId 过滤器进行处理,就像上面说的这样,过滤器是通过调用顺序执行的,会按照顺序将执行后的结果作为第一个参数传入下一个过滤器,直到全部执行完毕!

结尾

就像开头所说那样,本文其实没有多少干货,大部分地方其实官方文档上都有,熟悉的人甚至都不需要再看本文,只是作为系列来说,本篇文章还是不能或缺的!

转载说明

本文允许全文转载,转载请注明来源:
平凡公子 - vue从入门到精通入门篇插件开发之指令和过滤器