Vue.js 自定义指令

admin

( K) K/ M  k" k8 ]- n' G

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

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

实例
1 b5 m) `" D. ]( A
- W6 l) P1 M9 s8 }, D

1. <div id="app">
   
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   4 l, q% t0 u$ k. {) o0 u
3.     <input v-focus>
   " f/ m# n4 k! v% {
4. </div>
   ( e6 s3 t. \* P- S, J8 B6 N0 h' A
5. 
   + X3 z" f, L- D2 P# p  R
6. <script>
   
7. // 注册一个全局自定义指令 v-focus
   
8. Vue.directive('focus', {
   
9.   // 当绑定元素插入到 DOM 中。
   
10.   inserted: function (el) {
    + K7 ^" O' C" Q7 I0 ?* b
11.     // 聚焦元素
    
12.     el.focus()
    
13.   }
    2 E- i/ m. M1 e  D% w0 p# p4 H
14. })
    : D( G% f; M, S6 m+ m( v( d
15. // 创建根实例
    * }2 U: O5 e' ]6 L, q
16. new Vue({
    
17.   el: '#app'
      l$ \. Q. f$ |2 E0 @) z
18. })
    
19. </script>

复制代码

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

实例

1. <div id="app">
   % q4 K6 v. A" ?. {2 s
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   8 h  ~! C$ q. Z; t4 \- u
3.   <input v-focus>
   
4. </div>
   3 B9 T: ?1 S. ]  A9 U1 l5 s* \
5. 
   % c% c0 M% B. C& h% R4 C$ {
6. <script>
   
7. // 创建根实例
   
8. new Vue({
   
9.   el: '#app',
   
10.   directives: {
    # s( n8 c7 Y1 E: U1 ]1 F5 \. a
11.     // 注册一个局部的自定义指令 v-focus
    # q8 t/ i: o/ P! P  P; |& B
12.     focus: {
    ( U9 p5 x9 l, j* e0 `2 F
13.       // 指令的定义
    7 N' R2 L  N0 D- z) E: l
14.       inserted: function (el) {
    
15.         // 聚焦元素
    
16.         el.focus()
    / J8 H) x: l, t" t1 C# Y+ b+ ^
17.       }
    
18.     }
    
19.   }
    + E3 k+ M8 }0 f9 G) ?
20. })
    ; z6 f1 D1 y9 a. o( f
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 }。
    ! K+ c* j. d1 a8 `8 f* }1 R- }
• vnode: Vue 编译生成的虚拟节点。
• oldVnode: 上一个虚拟节点，仅在 update 和 componentUpdated 钩子中可用。
  5 E: q0 |$ M5 J/ K# C' b; E" ]

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

实例

1. <div id="app"  v-runoob:hello.a.b="message">
   
2. </div>
   
3. 
   
4. <script>
   ( [# A4 }0 E4 [% @4 H; P4 O$ O
5. Vue.directive('runoob', {
   - I5 w; H* ~* j1 M1 e3 k2 s
6.   bind: function (el, binding, vnode) {
   
7.     var s = JSON.stringify
   
8.     el.innerHTML =
   
9.       'name: '       + s(binding.name) + '<br>' +
   ! K3 k! t/ K, Z$ u' v* r
10.       'value: '      + s(binding.value) + '<br>' +
    
11.       'expression: ' + s(binding.expression) + '<br>' +
    
12.       'argument: '   + s(binding.arg) + '<br>' +
    ; ^' F" p6 U! \4 P* u+ Y* G
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    
15.   }
    - f" E! o9 G6 \7 z9 ~& }* _  E
16. })
    
17. new Vue({
    , i" Z/ ^& U% v$ s  s* V
18.   el: '#app',
    " A! t1 ?* S/ s/ [- V  b+ y3 F5 F
19.   data: {
    1 A7 @; V6 c; i0 P! ?. h4 j( M( o
20.     message: '菜鸟教程!'
    
21.   }
    
22. })
    4 u3 q3 W) j. @9 J; s" g/ ~- \5 _5 f
23. </script>

复制代码

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

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

复制代码

5 L' ^' J  M: f, W, t% M' w

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

实例

1. <div id="app">
   . |& X" n2 O7 Z, c! I: W
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   & P( K6 i8 N4 Q& x* d) S
3. </div>
   
4. 
   
5. <script>
   - ]* g: V! H( z  J
6. Vue.directive('runoob', function (el, binding) {
   
7.     // 简写方式设置文本及背景颜色
   7 i4 F: F0 k8 g4 _
8.     el.innerHTML = binding.value.text
   
9.     el.style.backgroundColor = binding.value.color
   9 q. }, y% _' q# Z) |/ C& n% a
10. })
    ! J  K7 c6 s" f5 Z" Z
11. new Vue({
    
12.   el: '#app'
    
13. })
    . U6 f. b% }# Q
14. </script>

复制代码

. F& _/ c2 l$ m) f$ k
( n0 _" c% q% L3 d. W