Vue.js 自定义指令

admin

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

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

实例

1 d- n2 S# b: \! ?, V& ^# I

1. <div id="app">
   
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   1 j2 a0 M& _. n+ n
3.     <input v-focus>
   8 H* j% [& D* Z+ y0 U9 ~
4. </div>
   
5. 
   6 y& r- q3 j7 x  m, s8 L, f, q
6. <script>
   
7. // 注册一个全局自定义指令 v-focus
   - P) ^2 v0 |5 H! L7 A; U9 W- m
8. Vue.directive('focus', {
   / ~1 A# q1 ~' x# j4 H9 B. }
9.   // 当绑定元素插入到 DOM 中。
   7 N$ }- l% c: [: p
10.   inserted: function (el) {
    % u) u6 J8 ^/ _2 k% \5 Z
11.     // 聚焦元素
    
12.     el.focus()
    
13.   }
    
14. })
    % ~  b  q8 o$ C% T7 ]9 l
15. // 创建根实例
    " t, g9 J0 s$ l; q$ C3 k2 V% q
16. new Vue({
    : R% s- f: K) l
17.   el: '#app'
      W4 E! f' H5 k- _+ G0 {9 K$ d) ^
18. })
    2 I1 E8 Z" n0 T$ t+ g
19. </script>

复制代码

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

实例

! I3 p/ ^! y! V

1. <div id="app">
   
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   
3.   <input v-focus>
   
4. </div>
   
5. 
   5 B4 E) T" ~# D
6. <script>
   1 C; K5 ?6 {- m8 t7 \6 v
7. // 创建根实例
   
8. new Vue({
   9 d% }* k/ q0 {
9.   el: '#app',
   
10.   directives: {
    & r; {( X, ~8 i# z" k* f* h
11.     // 注册一个局部的自定义指令 v-focus
    $ s2 x; g3 h& M3 K. ?
12.     focus: {
    
13.       // 指令的定义
    8 z8 P2 n* F6 {( b) R
14.       inserted: function (el) {
    
15.         // 聚焦元素
    1 b7 i' I9 q5 W9 f/ Q, e' G3 K7 a
16.         el.focus()
    
17.       }
    
18.     }
    8 Q* }0 T  ^3 f
19.   }
    # I) ^) N- I7 M$ w- s
20. })
    
21. </script>

复制代码

钩子钩子函数

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

• bind: 只调用一次，指令第一次绑定到元素时调用，用这个钩子函数可以定义一个在绑定时执行一次的初始化动作。
• inserted: 被绑定元素插入父节点时调用（父节点存在即可调用，不必存在于 document 中）。
• update: 被绑定元素所在的模板更新时调用，而不论绑定值是否变化。通过比较更新前后的绑定值，可以忽略不必要的模板更新（详细的钩子函数参数见下）。
• componentUpdated: 被绑定元素所在模板完成一次更新周期时调用。
• unbind: 只调用一次， 指令与元素解绑时调用。
  
  2 W# Z7 n3 Y5 U( m. S0 b

钩子函数参数

钩子函数的参数有：

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

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

实例

1. <div id="app"  v-runoob:hello.a.b="message">
   & i' t: p/ y$ |! j% q& E$ B
2. </div>
   
3. 
   4 R$ R) Z7 m4 M* K9 L' g* n: W
4. <script>
   
5. Vue.directive('runoob', {
   
6.   bind: function (el, binding, vnode) {
   . r2 g1 h+ f/ v: X, N1 G* A
7.     var s = JSON.stringify
   
8.     el.innerHTML =
   
9.       'name: '       + s(binding.name) + '<br>' +
   $ ]. j9 e. Q- m2 M% ^
10.       'value: '      + s(binding.value) + '<br>' +
    
11.       'expression: ' + s(binding.expression) + '<br>' +
    / h$ Q# V/ n1 t, L1 B& u. T# \  E5 P. y3 U
12.       'argument: '   + s(binding.arg) + '<br>' +
    
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    + s( h' x$ k, X  a$ m4 D
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    
15.   }
    : z! z/ K3 h5 T8 O- ?1 O; i+ c
16. })
    ' N6 e$ K  n0 q. \& u: N
17. new Vue({
    ( b! |) c  e" f! x1 w8 b. G- W8 h
18.   el: '#app',
    
19.   data: {
    
20.     message: '菜鸟教程!'
    
21.   }
    " U* u2 c) u1 F" E5 Y
22. })
    ; N$ R; ]- Y. S! Y8 z( S8 _% X$ F
23. </script>

复制代码

有时候我们不需要其他钩子函数，我们可以简写函数，如下格式：
1 S% |2 Y. I6 I3 z

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

复制代码

  t: l/ [4 e2 w1 l* y3 S

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

实例

1. <div id="app">
   
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   $ ?$ w! f: L( \) X; K5 }; I2 R; p9 i, e/ b
3. </div>
   7 |# I# O) O8 Q  ^3 N
4. 
   " ^: C4 T. W% B  H5 m* B/ e
5. <script>
     g  k6 n$ p6 [) M0 M$ ^
6. Vue.directive('runoob', function (el, binding) {
   8 |4 K# |% v& ^2 C- q
7.     // 简写方式设置文本及背景颜色
   1 \1 \- J0 p" p5 [7 [7 k6 a/ [
8.     el.innerHTML = binding.value.text
   
9.     el.style.backgroundColor = binding.value.color
   ( ^% ?/ Z* U# C; f0 N
10. })
    
11. new Vue({
    / C9 E$ P% e4 p8 L
12.   el: '#app'
    / G/ U" S  d# }: H+ y5 \8 W" X
13. })
    0 [& C9 t  e" z4 c
14. </script>

复制代码

6 A" [7 y$ W' K5 c8 Q2 X+ W5 i
! M3 I! l) ~6 o* l- N/ ]* _, Y