Vue.js 自定义指令

admin

: G5 \6 F- k2 r! _9 Q" F0 ~- \4 I

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

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

实例
7 x, J9 l4 b* A7 }5 W- P8 f
( B# |5 Z4 Z/ r* z

1. <div id="app">
   ! e# ?% g7 ~$ e; y
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   1 \$ |7 y4 A! |/ M$ _6 A4 L
3.     <input v-focus>
   
4. </div>
   - N% s+ K3 o/ v, G8 n. o2 b! f8 z
5. 
   
6. <script>
   
7. // 注册一个全局自定义指令 v-focus
   / }4 A( O- N- j4 @' M/ i3 s4 L* R' X
8. Vue.directive('focus', {
   
9.   // 当绑定元素插入到 DOM 中。
   & o  @+ Z$ |) M. ?8 U$ B  J$ A* D
10.   inserted: function (el) {
    
11.     // 聚焦元素
    
12.     el.focus()
    
13.   }
    3 b2 P1 u& A$ ^/ s( P3 g
14. })
    2 q7 @- O  E1 ^8 U4 ~4 s1 K0 ]
15. // 创建根实例
    ) ]& ~, Q) L. p8 o. q
16. new Vue({
    
17.   el: '#app'
    ! R. C) l) X: K
18. })
    2 j( J# Q/ L* T" ?0 T+ c
19. </script>

复制代码

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

实例
$ f; b, s6 g! j4 \- q
- C# L% P0 n( `* ~- [; N% g0 H. S

1. <div id="app">
   
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   
3.   <input v-focus>
   
4. </div>
   
5. 
   
6. <script>
   
7. // 创建根实例
   ; f( _, h8 C" l3 }
8. new Vue({
     z) n, e" u; ^" D) ~  ]; O
9.   el: '#app',
   
10.   directives: {
    # H- C* o! p) b4 H
11.     // 注册一个局部的自定义指令 v-focus
    
12.     focus: {
    
13.       // 指令的定义
    * o. v  X# i$ h5 o1 `, S
14.       inserted: function (el) {
    - E* A' W4 e% X; q2 Z$ `( V: p
15.         // 聚焦元素
    2 {# T, p/ l/ w- r/ M9 v
16.         el.focus()
    
17.       }
    
18.     }
    ( O5 b' r1 Z! ]- V4 R
19.   }
    
20. })
    
21. </script>

复制代码

钩子钩子函数

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

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

钩子函数参数

钩子函数的参数有：

• 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 钩子中可用。
  , l" N* B! M. q) p6 \/ _9 m

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

实例
2 a# x0 j( H- ]4 R- i+ n. w3 q, P. m

1. <div id="app"  v-runoob:hello.a.b="message">
   
2. </div>
   $ F+ O$ f' d6 l, `+ {% u
3. 
   % q5 H: L, a  T0 A2 G- ~1 E# M
4. <script>
   
5. Vue.directive('runoob', {
   $ }* Y: @! f  B8 k+ y: @7 l
6.   bind: function (el, binding, vnode) {
   
7.     var s = JSON.stringify
   
8.     el.innerHTML =
   
9.       'name: '       + s(binding.name) + '<br>' +
   
10.       'value: '      + s(binding.value) + '<br>' +
    
11.       'expression: ' + s(binding.expression) + '<br>' +
    ( \% S0 I" p3 Z, C- ~
12.       'argument: '   + s(binding.arg) + '<br>' +
    ( E3 Z4 N' V) s- t2 W! Q' Y+ i
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    1 D7 D4 I  \5 B6 H! F( ^
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    + z2 S2 s9 q/ ^
15.   }
    % c5 |6 v& O$ c% I, l
16. })
    
17. new Vue({
    
18.   el: '#app',
    
19.   data: {
      [: k7 q0 c! U6 f- q
20.     message: '菜鸟教程!'
    
21.   }
    0 m6 U: |! s( j
22. })
    
23. </script>

复制代码

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

1. Vue.directive('runoob', function (el, binding) {
   
2.   // 设置指令的背景颜色
   3 s: c0 k/ D# e7 n6 c# \) ~
3.   el.style.backgroundColor = binding.value.color
   ( h- Y4 G" S, |
4. })

复制代码

8 x% e4 K7 D9 {
6 S& U. D( B$ U- U; C$ O! U+ ?

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

实例
3 @" C( `$ v# r7 ]2 m$ ]. R) e5 a' E
' h- t+ y2 n- e2 j9 N( i- b

1. <div id="app">
   : B, X5 `9 o) W7 t1 c
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   , T0 u( G" T0 N3 y' c
3. </div>
   / [( D$ v3 g0 |" v9 o: o
4. 
   $ D0 ]" {& X* m2 |
5. <script>
   # v7 d6 f& S, k, W9 ]" K
6. Vue.directive('runoob', function (el, binding) {
   $ ^- T& e. s+ G, f
7.     // 简写方式设置文本及背景颜色
   
8.     el.innerHTML = binding.value.text
   
9.     el.style.backgroundColor = binding.value.color
   
10. })
    
11. new Vue({
    
12.   el: '#app'
    3 r" F" o! F% O
13. })
    % F' _& y. z, r: t; J; N: j
14. </script>

复制代码

6 F' @) B: q* `. e7 q0 F