Vue.js 自定义指令

admin

除了默认设置的核心指令( v-model 和 v-show ), Vue 也允许注册自定义指令。

下面我们注册一个全局指令 v-focus, 该指令的功能是在页面加载时，元素获得焦点：

实例
  y* g" D7 o! S

1. <div id="app">
   
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   
3.     <input v-focus>
   2 q9 [, X1 o9 e9 W4 B8 Q$ o
4. </div>
   
5. 
   
6. <script>
   
7. // 注册一个全局自定义指令 v-focus
   5 `8 D1 W0 O( y' K- R
8. Vue.directive('focus', {
   
9.   // 当绑定元素插入到 DOM 中。
   
10.   inserted: function (el) {
    
11.     // 聚焦元素
    
12.     el.focus()
    2 t3 l+ E, i0 e
13.   }
    
14. })
    1 d7 o, W; L( s# k6 s
15. // 创建根实例
    ! x$ O* l+ F6 W7 y4 A
16. new Vue({
    : }# F0 v- C$ r: f& W% L" m
17.   el: '#app'
    9 s7 X* R4 L1 X$ m
18. })
    3 l( z. A1 s; ?2 ]) {5 d3 t
19. </script>

复制代码

我们也可以在实例使用 directives 选项来注册局部指令，这样指令只能在这个实例中使用：

实例

1. <div id="app">
   
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   9 x9 I* ^$ w2 O, l4 Z, |$ v3 b
3.   <input v-focus>
   * l7 M, }1 y& K" c9 R/ G& L
4. </div>
   / H! i& d- w* ]7 S2 M( n
5. 
   / V/ h' j  }/ b0 g2 B/ I% W5 b
6. <script>
   + J% n+ v1 {* F3 w6 v. |
7. // 创建根实例
   . h* A2 Q# S5 d, Z
8. new Vue({
   
9.   el: '#app',
   4 z. {) L6 N$ g- e9 A; o2 r- i
10.   directives: {
    
11.     // 注册一个局部的自定义指令 v-focus
    
12.     focus: {
    % _% P7 g$ X' }6 i
13.       // 指令的定义
    
14.       inserted: function (el) {
    
15.         // 聚焦元素
      x9 w" E: y( C8 q, i2 ]
16.         el.focus()
    
17.       }
    
18.     }
    6 K+ Q/ B0 x/ h" e2 C: B
19.   }
    ; g  y, S$ p# @. |' ^
20. })
    # c" {# [7 Z# v4 O
21. </script>

复制代码

钩子钩子函数

指令定义函数提供了几个钩子函数（可选）：

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

以下实例演示了这些参数的使用：

实例

: k3 E' i$ j% D2 m: L, y8 A' Z1 _

1. <div id="app"  v-runoob:hello.a.b="message">
   ; E: k, }5 _6 E3 M% M, @: G
2. </div>
   
3. 
   
4. <script>
   
5. Vue.directive('runoob', {
   
6.   bind: function (el, binding, vnode) {
   
7.     var s = JSON.stringify
   
8.     el.innerHTML =
   9 y) c( ?. v1 ?
9.       'name: '       + s(binding.name) + '<br>' +
   
10.       'value: '      + s(binding.value) + '<br>' +
    
11.       'expression: ' + s(binding.expression) + '<br>' +
    
12.       'argument: '   + s(binding.arg) + '<br>' +
    - q/ K/ g% S9 b1 h6 E3 z
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    $ [: G* o) h7 |6 g! F/ q
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    
15.   }
    
16. })
    
17. new Vue({
    
18.   el: '#app',
    $ x  \6 P2 s" f, o/ E; X3 t- C7 V
19.   data: {
    
20.     message: '菜鸟教程!'
    1 g; G/ C/ t6 T! p3 _( Z, c
21.   }
    
22. })
    $ L# A* \8 v' e; P' {, ?( q1 L
23. </script>

复制代码

有时候我们不需要其他钩子函数，我们可以简写函数，如下格式：
7 L5 A, \5 _8 ^+ X' Z9 C

1. Vue.directive('runoob', function (el, binding) {
   
2.   // 设置指令的背景颜色
   
3.   el.style.backgroundColor = binding.value.color
   
4. })

复制代码

& V2 r1 G8 h5 W) O; a

指令函数可接受所有合法的 JavaScript 表达式，以下实例传入了 JavaScript 对象：

实例
  [; c3 o. a+ [  q

1. <div id="app">
   
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   + a5 }7 Y" f3 K( z7 z
3. </div>
   / d; F! T+ M+ M/ k+ ?+ f1 F
4. 
   
5. <script>
     i$ R  B  \" o5 |- L% K
6. Vue.directive('runoob', function (el, binding) {
   
7.     // 简写方式设置文本及背景颜色
   1 L/ O9 C, ]- ^
8.     el.innerHTML = binding.value.text
   
9.     el.style.backgroundColor = binding.value.color
   
10. })
    
11. new Vue({
    
12.   el: '#app'
    
13. })
    * ?% p' O& R& h0 W' ]3 O
14. </script>

复制代码

% \% @" f& g" p* {- y