Vue.js 自定义指令

admin

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

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

实例
. ^7 Z1 S0 C, t2 t6 n4 O

1. <div id="app">
   % F8 ~3 V" ?3 H" H
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   $ U" |( c+ ?$ |; v
3.     <input v-focus>
   
4. </div>
   3 Z( I& g! q' H' |
5. 
   ; \# k. e$ b! m' V
6. <script>
   / z2 ]! k  D5 @
7. // 注册一个全局自定义指令 v-focus
   
8. Vue.directive('focus', {
   7 Y+ w- F# P" W) U
9.   // 当绑定元素插入到 DOM 中。
   
10.   inserted: function (el) {
      C$ h+ ~' |- N) {! f
11.     // 聚焦元素
    
12.     el.focus()
      j  c. \( [& y; y) z
13.   }
    ( D3 g: V) W' X4 i' A3 w9 n7 k
14. })
    
15. // 创建根实例
    * x. Q/ Q3 W! l( t  i# k5 k
16. new Vue({
    
17.   el: '#app'
    
18. })
    
19. </script>

复制代码

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

实例
1 R1 x; z3 F) m  j

1. <div id="app">
   . i2 F9 Q- S* L# L
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   ' s6 u* [  h/ z* a
3.   <input v-focus>
   
4. </div>
   0 T2 o$ u6 f4 Q! s
5. 
   
6. <script>
   : \4 J4 @7 R5 h+ |1 v; e
7. // 创建根实例
   8 k, w3 ?7 [# q+ H( F; {) B0 v
8. new Vue({
   
9.   el: '#app',
   
10.   directives: {
    
11.     // 注册一个局部的自定义指令 v-focus
    / B9 v+ G  {2 L! ?" W, b: s4 |
12.     focus: {
    
13.       // 指令的定义
    
14.       inserted: function (el) {
    
15.         // 聚焦元素
    
16.         el.focus()
    
17.       }
    ( ^  _1 N, z0 B2 K' r3 I
18.     }
    
19.   }
    ) I7 I" I& h: `. f, a" _
20. })
    
21. </script>

复制代码

钩子钩子函数

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

• bind: 只调用一次，指令第一次绑定到元素时调用，用这个钩子函数可以定义一个在绑定时执行一次的初始化动作。
• inserted: 被绑定元素插入父节点时调用（父节点存在即可调用，不必存在于 document 中）。
• update: 被绑定元素所在的模板更新时调用，而不论绑定值是否变化。通过比较更新前后的绑定值，可以忽略不必要的模板更新（详细的钩子函数参数见下）。
• componentUpdated: 被绑定元素所在模板完成一次更新周期时调用。
• unbind: 只调用一次， 指令与元素解绑时调用。
  
  7 U- D2 Q: Q8 R1 F+ r8 V/ j

钩子函数参数

钩子函数的参数有：

• 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 }。
    - _$ T+ ?8 q8 b) e
• vnode: Vue 编译生成的虚拟节点。
• oldVnode: 上一个虚拟节点，仅在 update 和 componentUpdated 钩子中可用。
  5 v' J3 a+ ^/ @0 b: a1 Q

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

实例
( E. I) D& Q' {- r: A: X
- A) j# ]. C# {  t( c; |

1. <div id="app"  v-runoob:hello.a.b="message">
   : z! K* ^# V+ P5 X& g0 X- J3 N" B
2. </div>
   ) f! I  P  u. `- j0 h/ @) @
3. 
   * o) w; |! M* C/ N) |
4. <script>
   5 i$ T  ]: W- I) E8 u4 [
5. Vue.directive('runoob', {
   5 J- C1 Z, N5 s- f" f8 m0 b
6.   bind: function (el, binding, vnode) {
   
7.     var s = JSON.stringify
   
8.     el.innerHTML =
   
9.       'name: '       + s(binding.name) + '<br>' +
   * A8 C! y* U/ i5 M0 Y
10.       'value: '      + s(binding.value) + '<br>' +
    4 c3 e- [0 y) g
11.       'expression: ' + s(binding.expression) + '<br>' +
    2 v8 P7 Z: A! A% r6 e. B
12.       'argument: '   + s(binding.arg) + '<br>' +
    
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    5 ?, ]. X/ X) p2 l& ~1 Z0 }% {
15.   }
    9 f. n# o$ \' `+ N3 X
16. })
    0 ~. l# a, ]) I6 B, W# y  S* `
17. new Vue({
    
18.   el: '#app',
    3 E% f2 n; O$ R! Z
19.   data: {
    
20.     message: '菜鸟教程!'
    , F- `; C  Q* L/ \* I, X1 z% w. m
21.   }
    + ~6 c, x# Y/ V1 j% Q
22. })
    + G+ G9 x1 N9 @
23. </script>

复制代码

有时候我们不需要其他钩子函数，我们可以简写函数，如下格式：
' Q, J0 ], V- u3 @3 n0 k% J' i

1. Vue.directive('runoob', function (el, binding) {
   
2.   // 设置指令的背景颜色
   & |9 L* t/ {6 m7 J
3.   el.style.backgroundColor = binding.value.color
   
4. })

复制代码

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

实例

4 l% f; w- r5 f+ q- a

1. <div id="app">
   
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   ! l4 H; w2 C' F8 K
3. </div>
   & m' i& g, q4 S0 a. P& v1 R% C1 W
4. 
   9 [' V  Y5 p* K
5. <script>
   
6. Vue.directive('runoob', function (el, binding) {
   ; h( u0 n! T; X% Z  ^- k3 d
7.     // 简写方式设置文本及背景颜色
   
8.     el.innerHTML = binding.value.text
   ; J5 u+ D5 `" V1 Y& G
9.     el.style.backgroundColor = binding.value.color
   
10. })
    ( B) T( N2 V* _9 ]5 _, z: u
11. new Vue({
    
12.   el: '#app'
    9 w5 G" u8 m& Q$ q& g1 a
13. })
    - l, @4 s; ~9 B. L7 U4 _. o
14. </script>

复制代码

' V, R# Y1 A* d6 B7 t- t) w0 T