Vue自定义指令

发表于   |   分类于   |  

Vue借鉴了AngularJS中的Directive的概念，不仅支持默认设置的核心指令（如上文提到的v-bind等），还支持自定义指令。

Vue指令

Vue的指令以v-开头，作用在HTML元素上，将指令绑定在元素上，给绑定的元素添加一些特殊行为。

例如：

1
<h1 v-if="yes">Yes</h1>

其中，v-是Vue的标识，if是指令ID，yes是expression。yes是MVVM中的VM即ViewModel，当它的值发生变化，就会触发指令，改变View视图的显示。

expression还可以使用内联的模式，任何依赖的属性发生变化时都会触发指令的执行。如：

1
<h1 v-if="'yes '+ user.name + ', ' + time"></h1>

可以使用逗号分割多重指令，如：

1
<div v-on="click:onClick, keyup:onKeyup, keydown:onKeydown"></div>

Vue自定义指令

自定义指令语法

Vue自定义指令语法如下：

1
Vue.directive(id, definition)

传入的两个参数，id是指指令ID，definition是指定义对象。其中，定义对象可以提供一些钩子函数。

钩子函数

定义对象的钩子函数如下:

钩子函数 描述
bind 只调用一次，指令第一次绑定到元素时调用，用这个钩子函数可以定义一个在绑定时执行一次的初始化动作
inserted 被绑定元素插入父节点时调用（父节点存在即可调用，不必存在于 document 中）
update 被绑定元素所在的模板更新时调用，而不论绑定值是否变化。通过比较更新前后的绑定值，可以忽略不必要的模板更新
componentUpdated 被绑定元素所在模板完成一次更新周期时调用
unbind 只调用一次，指令与元素解绑时使用

钩子函数参数

定义对象的钩子函数参数如下：

  • el: 指令所绑定的元素，可以用来直接操作 DOM 。
  • binding: 一个对象，包含以下属性：
    • name: 指令名，不包括 v- 前缀。
    • value: 指令的绑定值， 例如： v-my-directive="1 + 1"，value 的值是 2。
    • oldValue: 指令绑定的前一个值，仅在 update 和 componentUpdated 钩子中可用。无论值是否改变都可用。
    • expression: 绑定值的字符串形式。 例如 v-my-directive="1 + 1" ， expression 的值是 "1 + 1"。
    • arg: 传给指令的参数。例如 v-my-directive:foo， arg 的值是 "foo"。
    • modifiers: 一个包含修饰符的对象。 例如： v-my-directive.foo.bar, 修饰符对象 modifiers 的值是 { foo: true, bar: true }。
  • vnode: Vue 编译生成的虚拟节点。
  • oldVnode: 上一个虚拟节点，仅在 update 和 componentUpdated 钩子中可用。

使用例子

Vue自定义指令常见使用例子如下：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
Vue.directive('my-directive', {
  bind: function(){
    //做绑定的准备工作
    //比如添加事件监听器，或是其他只需要执行一次的复杂操作
  },
  inserted: function(){
    //...
  },
  update: function(){
    //根据获得的新值执行对应的更新
    //对于初始值也会调用一次
  },
  componentUpdated: function(){
    //...
  },
  unbind: function(){
    //做清理操作
    //比如移除bind时绑定的事件监听器
  }
})

当指令的定义对象中只使用update时，只需直接传入函数即可，如下：

1
2
3
Vue.directive('my-directive', function(){
  //...
})

一个简单示例

下面将讲解一个简单的例子，当页面加载时，input输入框将自动聚焦。
代码如下：

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
<!DOCTYPE html>
<html lang="en">
    <head>
        <meta charset="utf-8">
        <script src="https://unpkg.com/vue/dist/vue.js"></script>
    </head>
    <body>
        <div id="app">
            <input v-focus>
        </div>
        <script>
            //注册一个全局自定义指令v-focus
            Vue.directive('focus', {
                // 当绑定元素插入到DOM中
                inserted: function (el) {
                // 聚焦元素
                el.focus()
                }
            });
            var app = new Vue({
                el: '#app'
            });
        </script>
    </body>
</html>

运行截图：

使用钩子函数参数的例子

下面将讲解一个使用钩子函数参数的例子，将元素的字体色设置为#fff，将背景色设置为传入指令的参数red，并将指令名，指令绑定值，指令绑定值的表达式，传入指令的参数显示在<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
26
27
28
29
<!DOCTYPE html>
<html>
    <head lang="en">
        <meta charset="utf-8">
        <script src="https://unpkg.com/vue/dist/vue.js"></script>
    </head>
    <body>
        <div id="hook-arguments-example" v-demo-directive:red="message"></div>
        <script>
        Vue.directive('demoDirective', {
            bind: function(el, binding, vnode){
                el.style.color = '#fff'
                el.style.backgroundColor = binding.arg
                el.innerHTML = 
                    '指令名name - '       + binding.name + '<br>' +
                    '指令绑定值value - '      + binding.value + '<br>' +
                    '指令绑定表达式expression - ' + binding.expression + '<br>' +
                    '传入指令的参数argument - '   + binding.arg + '<br>'
            },
        });
        var demo = new Vue({
            el: '#hook-arguments-example',
            data: {
                message: 'hello!'
            }
        })
        </script>
    </body>
</html>

运行截图：

对象字面量

同一个特性内部，逗号分隔的多个从句被绑定为多个指令实例。如，下例中指令被创建和调用了两次：

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

如果指令需要多个值，可以传入一个JavaScript对象字面量。如：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
<!DOCTYPE html>
<html>
    <head lang="en">
        <meta charset="UTF-8">
        <script src="https://unpkg.com/vue/dist/vue.js"></script>
    </head>
    <body>
        <div id="hook-arguments-example" v-demo-directive="{ color: 'white', text: 'hello!' }"></div>
        <script>
        Vue.directive('demoDirective', function(el, binding, vnode){
            console.log(binding.value.color);
            console.log(binding.value.text);
        });
        var demo = new Vue({
            el: '#hook-arguments-example'
        })
        </script>
    </body>
</html>

运行截图：

字面指令

若在创建自定义指令时，设置isLiterral: true，则特性值被视作字符串，并赋给该指令的expression，字面指令不会建立数据监视。

参考链接

  1. Vue.js教程 (2) : 指令 Directives
  2. Vue.JS入门篇–自定义指令
  3. vue.js笔记——指令