Vue.js 自定义指令

admin

0 \) G1 @* ~/ B  f( {. z! d9 W

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

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

实例

/ t* j! P% y* _' u/ F  X/ v/ F6 O

1. <div id="app">
   + O$ S! |* Q1 L/ e# j& v/ I+ b' m, X
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   
3.     <input v-focus>
   
4. </div>
   
5. 
   $ n$ ~: H: d9 n- r# x4 C0 U4 g
6. <script>
   
7. // 注册一个全局自定义指令 v-focus
   2 N' I8 }0 w. W
8. Vue.directive('focus', {
   
9.   // 当绑定元素插入到 DOM 中。
   ; t# ?7 s" v& v
10.   inserted: function (el) {
    
11.     // 聚焦元素
    
12.     el.focus()
    ! L* h& W- M- f1 H
13.   }
    
14. })
    + F: |* P: P; z6 P- Y3 e/ G# y
15. // 创建根实例
    * s% S. p3 z+ e/ D$ }
16. new Vue({
    
17.   el: '#app'
    & X% T6 H  e  v" Q- a; G6 Q
18. })
    9 H* k; t$ O9 w
19. </script>

复制代码

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

实例
% p  T7 A9 {3 u1 ?, F

1. <div id="app">
   
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   ; D$ E* B+ ]& Q9 {/ \
3.   <input v-focus>
   
4. </div>
   
5. 
   
6. <script>
   ) O  M; m4 J6 K
7. // 创建根实例
   * O4 Z: k/ O0 L; K+ X
8. new Vue({
   5 M* A2 ^( v3 `% @5 l& `. r' w$ ?
9.   el: '#app',
   ' [* C# G9 Q' x1 u/ v
10.   directives: {
    
11.     // 注册一个局部的自定义指令 v-focus
    / V% u1 I9 m' z! C
12.     focus: {
    
13.       // 指令的定义
      e; D, g( w7 }* X' B& m+ U
14.       inserted: function (el) {
    ! G3 \) y/ x1 P* ~9 L, N
15.         // 聚焦元素
    3 m! W* Z+ r  G0 N  |7 B
16.         el.focus()
    
17.       }
    
18.     }
    $ T. c+ _. f! y2 `4 p6 n
19.   }
    
20. })
    % b' U$ u/ E# n* |& S
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 钩子中可用。
  

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

实例

7 A+ G* N% n) z" F" D

1. <div id="app"  v-runoob:hello.a.b="message">
   & v, b5 \0 y& F: ^# t9 ^' _* d
2. </div>
   1 ~* Y! ]) p. J  D
3. 
   3 @2 J# F: f! S4 F$ L
4. <script>
   $ Q, f6 w3 Q* r2 t6 \3 J% J
5. Vue.directive('runoob', {
   
6.   bind: function (el, binding, vnode) {
   
7.     var s = JSON.stringify
   . c- M, v' W  G
8.     el.innerHTML =
   
9.       'name: '       + s(binding.name) + '<br>' +
   ; c/ A1 V2 S( h; Z& V
10.       'value: '      + s(binding.value) + '<br>' +
    
11.       'expression: ' + s(binding.expression) + '<br>' +
    
12.       'argument: '   + s(binding.arg) + '<br>' +
    8 a- c3 I; ^# w8 Z" o9 g
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    ; f+ ?1 u. X0 e& c& K7 N& o
15.   }
    
16. })
    
17. new Vue({
    " {& ^& G5 R3 j6 {/ Q7 g' d) T8 O
18.   el: '#app',
    4 U& l& `3 i  S. P6 H
19.   data: {
    
20.     message: '菜鸟教程!'
    8 b' }& ]. ?1 x3 o
21.   }
    
22. })
    
23. </script>

复制代码

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

1. Vue.directive('runoob', function (el, binding) {
   
2.   // 设置指令的背景颜色
   
3.   el.style.backgroundColor = binding.value.color
     x) x# e, Y% h& K
4. })

复制代码

* a) @; g, e9 Z2 {( r

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

实例
+ |5 |. |2 h0 y' g# ^8 U% f+ j

1. <div id="app">
   
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   5 ~$ @  V2 U( K' H! E, Z* S! r+ b+ @9 l
3. </div>
   
4. 
   6 R% I6 p# C( D! d
5. <script>
   . O) J& u2 j/ t0 M
6. Vue.directive('runoob', function (el, binding) {
   
7.     // 简写方式设置文本及背景颜色
   6 h( U* u$ O' M6 x
8.     el.innerHTML = binding.value.text
   ' Y. F8 n$ L8 Z& L' Q9 H$ b4 t5 f
9.     el.style.backgroundColor = binding.value.color
   
10. })
    + q" [* n8 D7 a& o& a; i* D
11. new Vue({
    2 q0 Q) G6 Y! u) S: x- Q
12.   el: '#app'
    ' b9 }4 V) @; a
13. })
    - |% ~5 v3 [& M
14. </script>

复制代码