Vue.js 自定义指令

admin

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

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

实例

1. <div id="app">
   2 i$ v7 |) h, b2 s0 U4 P
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   ) k# l. @2 a& a% O& e& ^
3.     <input v-focus>
   
4. </div>
   
5. 
   0 s0 ]5 x1 s5 @0 K, X- s
6. <script>
   
7. // 注册一个全局自定义指令 v-focus
   
8. Vue.directive('focus', {
   ) c. [, J5 @: W+ T% B- H; B
9.   // 当绑定元素插入到 DOM 中。
     z$ u( _+ H, d5 g. c% ], A
10.   inserted: function (el) {
    
11.     // 聚焦元素
    
12.     el.focus()
    
13.   }
    
14. })
    
15. // 创建根实例
    4 ?" L) s1 _. j# q. w" r# h
16. new Vue({
    8 n9 N4 L5 \) J$ Z
17.   el: '#app'
    
18. })
    
19. </script>

复制代码

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

实例

1. <div id="app">
   
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   3 u& R% n, @! I% _9 H  y8 {
3.   <input v-focus>
   
4. </div>
   
5. 
   7 ~+ H( A: g/ Q* H8 P
6. <script>
   
7. // 创建根实例
   
8. new Vue({
     N# L; d! D0 Y( O5 Z; s0 s
9.   el: '#app',
   5 b. _  p, G6 a4 K3 |0 l: r
10.   directives: {
    ) P+ d& a* O" F  }/ u- m* I
11.     // 注册一个局部的自定义指令 v-focus
    ! D, h# O. v  X9 A4 E1 z$ R
12.     focus: {
    ' z) P3 W7 V5 e+ v! A# I
13.       // 指令的定义
    $ B% O2 ~$ Z& |
14.       inserted: function (el) {
    " _7 \$ g! d1 e: f- w$ t
15.         // 聚焦元素
    
16.         el.focus()
    
17.       }
    : j  z  k% Y& o! z7 }3 r
18.     }
    2 Y0 O) C4 z* _2 L2 W
19.   }
    ) G; n4 \$ R: I/ f8 e5 Z. c. W
20. })
    
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 钩子中可用。
  : P, ~7 U1 ^- D! B( ]

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

实例

6 j7 w( d+ u  G& ^; Z, @

1. <div id="app"  v-runoob:hello.a.b="message">
   
2. </div>
   0 e8 O5 S+ s0 M; ^+ O. N3 h, y$ x
3. 
   4 z* ?' }1 @2 B
4. <script>
   & l* _) r) ?# \# L
5. Vue.directive('runoob', {
   % O* n+ f5 q/ q
6.   bind: function (el, binding, vnode) {
   
7.     var s = JSON.stringify
   
8.     el.innerHTML =
   
9.       'name: '       + s(binding.name) + '<br>' +
   
10.       'value: '      + s(binding.value) + '<br>' +
    
11.       'expression: ' + s(binding.expression) + '<br>' +
    
12.       'argument: '   + s(binding.arg) + '<br>' +
    
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    ) E; q" F" f0 Y8 F8 B5 G' J" y
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    
15.   }
    / i1 w8 h- T0 t% a
16. })
    0 M. R1 x2 |; B  i7 x+ M
17. new Vue({
    ( L$ }; D% ^3 [% O
18.   el: '#app',
    & x" e& w1 ?, _1 @( l
19.   data: {
    
20.     message: '菜鸟教程!'
    ' F' v: V; S) l% D! Q" Q
21.   }
    4 m  |, b' r& O# c$ h  l
22. })
    2 C1 C( y5 T9 z& ^2 R4 R
23. </script>

复制代码

有时候我们不需要其他钩子函数，我们可以简写函数，如下格式：

1. Vue.directive('runoob', function (el, binding) {
   
2.   // 设置指令的背景颜色
   ( {# }8 L; m. o4 f* J! I& C9 @
3.   el.style.backgroundColor = binding.value.color
   5 u0 a6 l6 ^" b* p6 B9 y
4. })

复制代码

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

实例
- g* P( ^' ?7 r* G* q' D% M
. S' _1 r+ Q4 ]6 x

1. <div id="app">
   
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   
3. </div>
   
4. 
   9 E5 s' F1 a2 y7 Q! p
5. <script>
   
6. Vue.directive('runoob', function (el, binding) {
   7 l# }- E  U2 ]$ u: U" D& `
7.     // 简写方式设置文本及背景颜色
   - f% x# a1 @6 n; m$ ?( X% g; R# k
8.     el.innerHTML = binding.value.text
   9 \. P6 q: S/ k8 P' q* X4 Z; v4 N
9.     el.style.backgroundColor = binding.value.color
   
10. })
    
11. new Vue({
    " G* p1 H# `1 s0 z2 Q+ i' U
12.   el: '#app'
    8 B$ {* E; y9 P5 \8 T& m4 |/ `! P
13. })
    
14. </script>

复制代码

8 c; o/ e  Q# P6 l" W

1 z7 W2 `, e1 J7 g* E: X