Vue.js 自定义指令

admin

8 {$ D; R( c+ o  I; b

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

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

实例

1. <div id="app">
   
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   . {8 l7 M0 B8 ?0 m! J& e
3.     <input v-focus>
   % L7 b! i9 [2 }
4. </div>
   2 O2 D6 I" }# J' w3 O
5. 
   . ]! S  y  s2 O% s) |( c
6. <script>
   
7. // 注册一个全局自定义指令 v-focus
   
8. Vue.directive('focus', {
   
9.   // 当绑定元素插入到 DOM 中。
   7 U' p: D+ @, Z
10.   inserted: function (el) {
    1 ]0 @6 F- |! i
11.     // 聚焦元素
    " Y  l8 G8 @  _$ \* X9 F
12.     el.focus()
    
13.   }
    1 @, m& r6 @7 i; S4 i
14. })
    4 Z$ i5 P3 ?, y
15. // 创建根实例
    9 A  T6 V/ m% X2 [7 P( @0 F8 C: d
16. new Vue({
    6 Z7 e2 @2 E' h+ l& ^  b
17.   el: '#app'
    
18. })
    
19. </script>

复制代码

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

实例

7 O3 O7 O0 `) n  _# K: `! R8 |

1. <div id="app">
   9 y( {2 X4 b% p" @. C
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   6 q5 g: i7 f5 l( b
3.   <input v-focus>
   
4. </div>
   
5. 
   
6. <script>
   
7. // 创建根实例
   4 k5 z9 w9 z0 t, E& C
8. new Vue({
   
9.   el: '#app',
   
10.   directives: {
    
11.     // 注册一个局部的自定义指令 v-focus
    6 `* n( i/ i3 W7 `/ [& f0 n5 v- S( d. {
12.     focus: {
    
13.       // 指令的定义
    9 M9 C. T7 B4 A2 \
14.       inserted: function (el) {
    
15.         // 聚焦元素
    ( A  O9 F3 A' L4 O
16.         el.focus()
    
17.       }
    % X+ t) `8 p- c$ s" Y
18.     }
    0 ?: W: t( f/ W: v% g" A1 j
19.   }
    
20. })
    
21. </script>

复制代码

钩子钩子函数

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

• bind: 只调用一次，指令第一次绑定到元素时调用，用这个钩子函数可以定义一个在绑定时执行一次的初始化动作。
• inserted: 被绑定元素插入父节点时调用（父节点存在即可调用，不必存在于 document 中）。
• update: 被绑定元素所在的模板更新时调用，而不论绑定值是否变化。通过比较更新前后的绑定值，可以忽略不必要的模板更新（详细的钩子函数参数见下）。
• componentUpdated: 被绑定元素所在模板完成一次更新周期时调用。
• unbind: 只调用一次， 指令与元素解绑时调用。
  
  - o' S# o. I9 p9 n2 m& S' k* B

钩子函数参数

钩子函数的参数有：

• 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 }。
    ; ~+ w( I, q. o: v
• vnode: Vue 编译生成的虚拟节点。
• oldVnode: 上一个虚拟节点，仅在 update 和 componentUpdated 钩子中可用。
  

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

实例
6 _, m9 c  W7 n8 b7 ]. I8 z  e
% u! }8 ]) f+ _9 }+ u. U

1. <div id="app"  v-runoob:hello.a.b="message">
   ; K7 b- o& t6 D( R* t2 K1 ?
2. </div>
   4 t& U1 x; X1 V, B, j  \
3. 
   * i3 {7 L" |4 }5 w
4. <script>
   4 |8 }7 X# e) S" A1 k& b5 |
5. Vue.directive('runoob', {
   
6.   bind: function (el, binding, vnode) {
   
7.     var s = JSON.stringify
   . U0 z8 K7 e3 }) K' f% ?) q7 D
8.     el.innerHTML =
   $ ^7 W4 n, n. C1 l+ x' e
9.       'name: '       + s(binding.name) + '<br>' +
   $ F9 r3 C/ R6 v( N1 F& [
10.       'value: '      + s(binding.value) + '<br>' +
    
11.       'expression: ' + s(binding.expression) + '<br>' +
    - u* }4 {6 m2 K. F, v
12.       'argument: '   + s(binding.arg) + '<br>' +
    
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    ' G( p+ Z3 A2 o, d" Y
15.   }
    
16. })
    
17. new Vue({
    
18.   el: '#app',
    , j( u5 ?' h! V' d1 k, ^7 P6 V
19.   data: {
    - Y( r: r" c2 |& n& A% d
20.     message: '菜鸟教程!'
    
21.   }
    
22. })
      i3 `5 X1 X3 G" N; @# B2 m! u
23. </script>

复制代码

有时候我们不需要其他钩子函数，我们可以简写函数，如下格式：
& l6 T5 Y1 ]( v# A% @% a

1. Vue.directive('runoob', function (el, binding) {
   # x& c# M# j/ o# \& @* O
2.   // 设置指令的背景颜色
   
3.   el.style.backgroundColor = binding.value.color
   + E; \7 ~) B( j! _3 e6 _* @( @" O  ~
4. })

复制代码

  w( `& U; g4 T

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

实例

1. <div id="app">
   
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   
3. </div>
   ' V7 d6 s' K. V
4. 
   
5. <script>
   
6. Vue.directive('runoob', function (el, binding) {
   9 \; O- u* t) s5 v" ?
7.     // 简写方式设置文本及背景颜色
   
8.     el.innerHTML = binding.value.text
   4 R: l4 f! G* Z0 K- B' l( U
9.     el.style.backgroundColor = binding.value.color
   
10. })
    
11. new Vue({
    : R* p3 ]- o- ]7 w4 o
12.   el: '#app'
    
13. })
    
14. </script>

复制代码