Vue.js 自定义指令

admin

: z# m) O* j2 a' H

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

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

实例
/ Y4 S" n2 q; [2 ~3 i4 z4 n
- M$ Z) T3 ^# U- c

1. <div id="app">
   " h/ k$ W: c( ?  X& Y! G5 e, t& n: w) \
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   + ~  V: H& V' ?) {' z
3.     <input v-focus>
   
4. </div>
   
5. 
   
6. <script>
   2 Z/ N4 T# W8 t% h# D
7. // 注册一个全局自定义指令 v-focus
   1 w& {5 A6 b; d
8. Vue.directive('focus', {
   
9.   // 当绑定元素插入到 DOM 中。
   
10.   inserted: function (el) {
    
11.     // 聚焦元素
    % W& X3 B4 @6 z0 Q7 D' h: z) c
12.     el.focus()
    # N; W( Y& j  j5 K/ W1 j/ Z% N
13.   }
    
14. })
    , K2 n+ L/ ~8 m8 O
15. // 创建根实例
    ( e) ~# L% {. q+ O; s% C
16. new Vue({
    & C4 Z0 B6 c9 G7 b
17.   el: '#app'
    % n3 }. `7 r3 }
18. })
    
19. </script>

复制代码

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

实例
- _: [/ v, |# ?1 O* [/ b' p6 r; {
' W4 x5 T1 w7 r& C

1. <div id="app">
   ( F7 A- ?( s$ k6 e) ]
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   
3.   <input v-focus>
     Z! {8 d% Y( R- F2 j9 S) t
4. </div>
   8 h0 E# t+ E  O+ }. f
5. 
   
6. <script>
   
7. // 创建根实例
   3 m  C6 Z! M0 F" W* M
8. new Vue({
   . C/ u  |9 r5 e$ ~
9.   el: '#app',
   
10.   directives: {
    
11.     // 注册一个局部的自定义指令 v-focus
    2 s  W) d5 w( @9 J$ z
12.     focus: {
    
13.       // 指令的定义
    
14.       inserted: function (el) {
    ! ]( b1 Y0 n7 x" k. m4 l
15.         // 聚焦元素
    ; r2 h: t9 E+ b, s9 [8 b" u
16.         el.focus()
    % `( q) F& y1 {9 Z& z; x+ o2 p
17.       }
    
18.     }
    
19.   }
    + ^0 G7 P7 n+ }: C
20. })
    4 L2 ~1 L% b, [; Q! \- {5 n
21. </script>

复制代码

钩子钩子函数

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

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

钩子函数参数

钩子函数的参数有：

• 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 }。
    ) X' R) f- M3 U
• vnode: Vue 编译生成的虚拟节点。
• oldVnode: 上一个虚拟节点，仅在 update 和 componentUpdated 钩子中可用。
  % X' @, g6 a2 V/ g8 _

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

实例

0 h) i) B9 C: U' a& i

1. <div id="app"  v-runoob:hello.a.b="message">
   
2. </div>
   " t9 J8 @) u, x2 E' l+ `9 O/ V
3. 
   . y) a; K3 U- E2 R- F- j
4. <script>
   
5. Vue.directive('runoob', {
   4 E. C- L5 I5 X- R6 ^+ T/ ]
6.   bind: function (el, binding, vnode) {
   ! Z/ x2 t9 t0 C) F0 s
7.     var s = JSON.stringify
   
8.     el.innerHTML =
   # i) }/ Y9 J" {; D# L! X
9.       'name: '       + s(binding.name) + '<br>' +
   # k1 d6 F$ W$ i1 o
10.       'value: '      + s(binding.value) + '<br>' +
    6 ]# p0 u4 D$ Z1 C
11.       'expression: ' + s(binding.expression) + '<br>' +
    
12.       'argument: '   + s(binding.arg) + '<br>' +
    - L# J* r" B' e% J7 g
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    # F0 Q  }* ~9 N* b7 B6 h7 S
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    
15.   }
    ! q+ C; W! k, ^& A, G( A
16. })
    , c) q& _4 }" r4 d! [9 G3 P
17. new Vue({
    
18.   el: '#app',
    
19.   data: {
    9 O3 S% |7 w- n6 b* j
20.     message: '菜鸟教程!'
    % \' N3 g0 A" L, H
21.   }
    ' m9 \, F! s8 l( W
22. })
    - ?% b% ~6 V- t9 K0 J  l2 b
23. </script>

复制代码

有时候我们不需要其他钩子函数，我们可以简写函数，如下格式：
) v) [8 O6 Q9 G3 w% |  L* J0 f

1. Vue.directive('runoob', function (el, binding) {
   3 B2 a- {8 B* \3 N
2.   // 设置指令的背景颜色
   $ a5 V2 o2 |2 P
3.   el.style.backgroundColor = binding.value.color
   
4. })

复制代码

* d8 r# m: p+ F$ w4 d

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

实例
5 j0 t; |! {7 S5 t, i! d1 q
+ O4 C1 W7 d7 U! K* j  W

1. <div id="app">
   
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   
3. </div>
   
4. 
   
5. <script>
   ( N* B9 k7 M) m% E4 a
6. Vue.directive('runoob', function (el, binding) {
   
7.     // 简写方式设置文本及背景颜色
   
8.     el.innerHTML = binding.value.text
   
9.     el.style.backgroundColor = binding.value.color
   
10. })
    
11. new Vue({
      ^* W7 ?. f4 g$ ]; X. u; z
12.   el: '#app'
      p$ X# J) F  u) }
13. })
    
14. </script>

复制代码

( A8 r( f  k0 O$ Q8 r" f
5 l/ b- I5 H+ D