Vue.js 自定义指令

admin

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

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

实例
# Q  y+ U0 v" q: M  P5 v8 Q/ y; w

1. <div id="app">
   ! N5 S  h8 ]. C1 C; V
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   1 g" o( |) \) }6 P1 s$ A3 T8 \
3.     <input v-focus>
   2 W! t: J  G. a1 J/ N4 u
4. </div>
   1 @4 m4 C3 b; b7 j
5. 
   
6. <script>
   
7. // 注册一个全局自定义指令 v-focus
   . I0 B" w; x5 ]# k$ A
8. Vue.directive('focus', {
   
9.   // 当绑定元素插入到 DOM 中。
   
10.   inserted: function (el) {
    + W0 ]- {# B2 Q/ `/ w  _1 i
11.     // 聚焦元素
    ' _' e2 y# ^$ Z; _' t8 W7 k
12.     el.focus()
    + s, [* L& ^# M
13.   }
    3 I1 O6 J  T( ]4 `' z" N% Y. d
14. })
    7 ^, p# z4 W2 R/ i+ R& V! \
15. // 创建根实例
    
16. new Vue({
    0 o, K! M# z- V5 J
17.   el: '#app'
    
18. })
    
19. </script>

复制代码

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

实例

3 P" G1 ], V- I; A& j5 U8 S+ w

1. <div id="app">
   * q" w0 _% [1 _$ N) s" k& n, d, [
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   
3.   <input v-focus>
   % e" l$ I: v" c( ?3 F& \, d; K( Q
4. </div>
   
5. 
   
6. <script>
   * \3 t* [# x8 g7 s# V. j4 K
7. // 创建根实例
   
8. new Vue({
   ! }! O! [% D& k3 T( G7 ?$ ^: k# ~/ h
9.   el: '#app',
   
10.   directives: {
    * I4 Y& {  I) y) V3 L
11.     // 注册一个局部的自定义指令 v-focus
    # U, r) c. \7 ]1 @# s0 y6 J" E/ o
12.     focus: {
    6 u0 }% l0 K& {- e2 z
13.       // 指令的定义
    
14.       inserted: function (el) {
    
15.         // 聚焦元素
    " z8 a# z& H6 V* t. n1 E- z, q2 G4 G, ^
16.         el.focus()
    
17.       }
    , q+ m4 v2 T, h
18.     }
    
19.   }
    
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 }。
    & O% o9 [1 O1 q/ b
• vnode: Vue 编译生成的虚拟节点。
• oldVnode: 上一个虚拟节点，仅在 update 和 componentUpdated 钩子中可用。
  $ m9 F. V" X3 U

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

实例
$ x2 T5 ^3 e0 V6 a1 n: Z3 v+ v% s

1. <div id="app"  v-runoob:hello.a.b="message">
   # \0 p8 u0 O7 Z# S( X9 i
2. </div>
   7 q+ Y; c+ @4 Y- `' C& N( g5 u
3. 
   
4. <script>
   + p! C4 @) }9 `" d
5. Vue.directive('runoob', {
   
6.   bind: function (el, binding, vnode) {
   
7.     var s = JSON.stringify
   
8.     el.innerHTML =
   6 {. P6 ?1 [  ^8 {# V
9.       'name: '       + s(binding.name) + '<br>' +
   6 o# Z1 p  s8 T4 ?. N. H- u
10.       'value: '      + s(binding.value) + '<br>' +
    7 n* l/ A) N3 W/ S& O
11.       'expression: ' + s(binding.expression) + '<br>' +
    * Z; a( t8 D, |$ C$ c: @
12.       'argument: '   + s(binding.arg) + '<br>' +
    
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    / A* X  r+ Q: J- U$ f) y- `) [
15.   }
    ; _2 \! I0 d" M. w8 j
16. })
    
17. new Vue({
    
18.   el: '#app',
    6 a! p7 \- m2 H( j. w7 \$ W
19.   data: {
    2 [  [7 ]4 E; D
20.     message: '菜鸟教程!'
    
21.   }
    , l5 Y" k. B+ \5 R
22. })
    
23. </script>

复制代码

有时候我们不需要其他钩子函数，我们可以简写函数，如下格式：
0 Q0 H) p* m2 h. k' Z3 Z/ f* B

1. Vue.directive('runoob', function (el, binding) {
   ) g3 k* c' G7 u( g( u6 j& T
2.   // 设置指令的背景颜色
   3 A; |) Q" F, K3 g2 K2 I( ~( W9 e
3.   el.style.backgroundColor = binding.value.color
   ; d$ J9 Z2 C9 m+ [9 B
4. })

复制代码

# d6 a" j' s+ u  t

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

实例

1. <div id="app">
   
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   
3. </div>
   9 e: ~& |! b7 A+ s1 ?
4. 
   : U5 m% [: `. E; e
5. <script>
   ( D9 P& I$ Z3 l# `3 P7 D9 M9 e
6. Vue.directive('runoob', function (el, binding) {
     }' r- H, Z2 a- H9 T  W
7.     // 简写方式设置文本及背景颜色
   
8.     el.innerHTML = binding.value.text
   
9.     el.style.backgroundColor = binding.value.color
   / O4 ^/ V3 q/ i$ R
10. })
    0 T& L) h/ e- V% {: a
11. new Vue({
      g( K( o  w' Y- v" C
12.   el: '#app'
    
13. })
    + ]6 {( g4 @  K2 o& W! H! J
14. </script>

复制代码

) ]3 T) B' [2 t$ h. ?' i+ `! [