Vue.js 自定义指令

admin

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

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

实例
. B/ |* ?4 [" x& n: x, M; P
  q9 I9 r. `( _# y

1. <div id="app">
   3 [; g/ I$ g! r# A2 o" ^
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   % k) @9 k+ M. m2 Q& K& N
3.     <input v-focus>
   
4. </div>
   
5. 
   - K7 i  q& M3 f; m5 c
6. <script>
   3 A; s- @+ {2 u- \& ]% J
7. // 注册一个全局自定义指令 v-focus
   
8. Vue.directive('focus', {
   , d, ~7 A4 R. l: P, u6 t  O
9.   // 当绑定元素插入到 DOM 中。
   
10.   inserted: function (el) {
    
11.     // 聚焦元素
    ' k( x! P  Q, Q4 B# b3 u
12.     el.focus()
    4 m$ |1 P% O6 H4 R0 S; l3 Q
13.   }
    
14. })
    4 |4 R4 S! P5 O
15. // 创建根实例
    / F$ J, ^7 R; z6 Y6 w
16. new Vue({
    / K) }/ Q; h3 C" c" h
17.   el: '#app'
    
18. })
    
19. </script>

复制代码

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

实例
" ?4 V7 d6 e" ]" x
* X) r9 K  F! R/ m7 |8 S: \5 Q

1. <div id="app">
   : \) [& w2 h6 `
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   0 T0 j! G( p4 J/ f* ~
3.   <input v-focus>
   2 e: i; b( C6 y; R/ V: X+ W8 A- X
4. </div>
   ! O& f9 M' z4 k" |6 N( j' h
5. 
   
6. <script>
   % s+ k- s+ g( d0 |
7. // 创建根实例
   
8. new Vue({
   2 E! J4 E" N# }; A
9.   el: '#app',
   * J# Y& Y# O0 T" \0 {
10.   directives: {
    ' J" u  b* S$ N9 t: a% N) a) R; y
11.     // 注册一个局部的自定义指令 v-focus
    ' e4 ^3 E$ ]) \7 H# r
12.     focus: {
    
13.       // 指令的定义
    
14.       inserted: function (el) {
    
15.         // 聚焦元素
    
16.         el.focus()
    
17.       }
    
18.     }
    9 B: \+ N6 }, Y$ l  P" v  p
19.   }
    
20. })
    : b; A* `' w: `
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 钩子中可用。
  - B5 L, G- N7 M5 A

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

实例
6 K+ G+ B( H1 ?3 c8 |

1. <div id="app"  v-runoob:hello.a.b="message">
   ' w5 b* t; G& Z; d( [6 M! b' B
2. </div>
   " ~* G9 m) p: Q+ R) g3 A0 D: c, F
3. 
   
4. <script>
   
5. Vue.directive('runoob', {
   
6.   bind: function (el, binding, vnode) {
   2 Y( a, G4 p& `) a: y" e) Y3 H
7.     var s = JSON.stringify
     t" C# J3 C6 N
8.     el.innerHTML =
   ( v; I9 X" t: f6 ~4 o: w$ p) A4 H
9.       'name: '       + s(binding.name) + '<br>' +
   . I1 F9 N$ k) b0 K8 d
10.       'value: '      + s(binding.value) + '<br>' +
    
11.       'expression: ' + s(binding.expression) + '<br>' +
    
12.       'argument: '   + s(binding.arg) + '<br>' +
    
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
      ~; d0 b$ c6 Z4 b
15.   }
    
16. })
    ; b4 L1 q; U& N- v. U- W. A
17. new Vue({
    
18.   el: '#app',
    
19.   data: {
    
20.     message: '菜鸟教程!'
    . h% M. u) q4 Y' Y8 X* S8 ~
21.   }
    - n6 N5 y  H! r7 A4 v
22. })
    
23. </script>

复制代码

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

1. Vue.directive('runoob', function (el, binding) {
   ! x. h/ O9 v) c* Y. y
2.   // 设置指令的背景颜色
   , h/ p+ T2 m1 g
3.   el.style.backgroundColor = binding.value.color
   
4. })

复制代码

- f. h( M- ?# I8 K0 Z9 m

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

实例

; q5 h2 ~1 S* }5 U; e& p# M3 K

1. <div id="app">
   
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   $ ?/ q* B) M! |* _7 \
3. </div>
   
4. 
   
5. <script>
   1 A* n) b* b7 J' v& j
6. Vue.directive('runoob', function (el, binding) {
   
7.     // 简写方式设置文本及背景颜色
   ( \* r. i0 u3 P$ }  U
8.     el.innerHTML = binding.value.text
   , q3 j7 Z6 m. N/ k2 ~8 m( P! L7 p
9.     el.style.backgroundColor = binding.value.color
   : @" c3 O; }% ^# |
10. })
    & V4 `! o2 ~, k. i
11. new Vue({
    
12.   el: '#app'
    
13. })
    
14. </script>

复制代码

) W0 V6 z2 x% L  x0 Y