Vue.js 自定义指令

admin

3 U6 b1 U1 g3 a: q1 X" h

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

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

实例

1. <div id="app">
   - [$ m: S* W& a
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   
3.     <input v-focus>
   6 d0 {* ~7 I2 t! H& w
4. </div>
   
5. 
   : A8 ^, z7 w1 v/ }
6. <script>
   6 p- \! ~4 h/ J5 W  r
7. // 注册一个全局自定义指令 v-focus
   
8. Vue.directive('focus', {
   
9.   // 当绑定元素插入到 DOM 中。
   
10.   inserted: function (el) {
    
11.     // 聚焦元素
    ; l- h7 I2 S) `& ]% p. Q
12.     el.focus()
    5 M* W8 f% S7 n1 g+ c
13.   }
    ) i6 l. P$ v" v3 B+ n
14. })
    0 B  E2 w- ]" |
15. // 创建根实例
    
16. new Vue({
    ; n! `+ [) K" Q& j6 ^0 t" Z
17.   el: '#app'
    
18. })
    
19. </script>

复制代码

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

实例
1 r; [5 ]0 s% |2 z3 I8 a
" z' K  ^8 e6 G) Q4 @4 ]  C

1. <div id="app">
   & o+ n. z: t$ f! L- y
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   
3.   <input v-focus>
   2 ?% y+ L  z0 X: ~8 Y+ z
4. </div>
   : k: n" X" U  T0 q8 v
5. 
   
6. <script>
   
7. // 创建根实例
   + L  t9 t; C% N1 e, U4 a7 J
8. new Vue({
   6 [6 Q" t* k- Z8 `
9.   el: '#app',
   
10.   directives: {
    8 n( [* x- Y( ^. T
11.     // 注册一个局部的自定义指令 v-focus
    
12.     focus: {
    
13.       // 指令的定义
    ; b4 ~/ a! G! ~; E
14.       inserted: function (el) {
    
15.         // 聚焦元素
    ; L& r  M& ^3 z" F
16.         el.focus()
    % ^4 q; Z0 w' Z; s% V8 H, s0 K
17.       }
    : F0 b* V( n6 ^& d! M7 r
18.     }
    0 @' g/ D: g* a( }- b# m  W* y
19.   }
    2 V) @# Q7 L- p
20. })
    2 a/ N, p/ r, R! _
21. </script>

复制代码

钩子钩子函数

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

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

钩子函数参数

钩子函数的参数有：

• 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 钩子中可用。
  

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

实例
4 s% @% J* e; s8 m

1. <div id="app"  v-runoob:hello.a.b="message">
   
2. </div>
   0 `1 E* a+ c/ y  j9 K( [* i; [
3. 
     d& s8 [& ]' _0 h5 S
4. <script>
   
5. Vue.directive('runoob', {
   
6.   bind: function (el, binding, vnode) {
   + p" w; s0 X2 n  ]
7.     var s = JSON.stringify
   # D" f4 i+ l. W6 a" @5 c# _
8.     el.innerHTML =
   
9.       'name: '       + s(binding.name) + '<br>' +
   $ n+ s2 i0 o+ J
10.       'value: '      + s(binding.value) + '<br>' +
    
11.       'expression: ' + s(binding.expression) + '<br>' +
    ! ~% r5 D: ]( }2 W. A
12.       'argument: '   + s(binding.arg) + '<br>' +
    * n" v0 f6 k0 g" I+ r
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    . K. w' ]. h6 d
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    
15.   }
    
16. })
    
17. new Vue({
    
18.   el: '#app',
    . q2 ]/ U: A2 {% s7 Y
19.   data: {
    ) q9 E# S  ?& U5 R# ^, \
20.     message: '菜鸟教程!'
    
21.   }
    , l: K: @( s4 K: |" N
22. })
    
23. </script>

复制代码

有时候我们不需要其他钩子函数，我们可以简写函数，如下格式：
5 s3 l4 D; N7 o) s4 C

1. Vue.directive('runoob', function (el, binding) {
   # b0 N3 l' c* J  t. \$ @
2.   // 设置指令的背景颜色
   9 z" W+ h: L  s$ [1 M7 N
3.   el.style.backgroundColor = binding.value.color
   5 U7 c% \) l! n' j3 z
4. })

复制代码

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

实例

1. <div id="app">
   ; g: H; I$ V; c: p# `" V! f  R1 u! b
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   
3. </div>
   
4. 
   ' H7 X" U2 @# h0 U- \7 H
5. <script>
   / g" j3 v3 z  w/ ^7 W* f5 w. v
6. Vue.directive('runoob', function (el, binding) {
   : U8 X% n* v; D6 r
7.     // 简写方式设置文本及背景颜色
     q: d, u9 r1 p3 S
8.     el.innerHTML = binding.value.text
   
9.     el.style.backgroundColor = binding.value.color
     o) T- u* w2 _4 t) ]( P" F
10. })
    
11. new Vue({
    
12.   el: '#app'
    
13. })
    
14. </script>

复制代码

! x- `( _6 G5 H$ m, `+ \/ @

5 u* |& n) e2 c4 c- S) _; h  e+ {/ B