Vue.js 自定义指令

admin

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

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

实例

1 m1 T( b  f& H

1. <div id="app">
   
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   
3.     <input v-focus>
   ( F0 \1 X3 \2 f( t# j6 s
4. </div>
   & p* J; l7 F8 g2 @* i9 i) w
5. 
   : X6 @) N7 l7 h* T3 _
6. <script>
   " W2 B' j  @3 ^* M6 s
7. // 注册一个全局自定义指令 v-focus
   # `7 e6 \1 r: a5 h
8. Vue.directive('focus', {
   " q7 Z$ g% H, h+ s4 |. M3 s
9.   // 当绑定元素插入到 DOM 中。
   
10.   inserted: function (el) {
    2 c- \8 J9 e5 |% j) P5 ^2 N
11.     // 聚焦元素
    
12.     el.focus()
    , l3 I- k) C( z" z7 K4 X) ?
13.   }
    % W8 |( H0 g9 c3 p) d1 K
14. })
    ! f( D/ Y- L  o. [4 A! c. k
15. // 创建根实例
    
16. new Vue({
    ; N! y$ c$ o. @" R  ]0 \# g0 S" s& b
17.   el: '#app'
    ! O4 C8 \$ T) ]& n$ M! u2 J
18. })
    
19. </script>

复制代码

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

实例
1 b* n5 T! ]1 s# L! ~

1. <div id="app">
   
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   
3.   <input v-focus>
   
4. </div>
   ) e( J4 @$ v5 {# v6 y( j
5. 
   
6. <script>
   / z( K' j  l1 e/ W* R' j* d3 X  r
7. // 创建根实例
   
8. new Vue({
   
9.   el: '#app',
   ) ]' h: X& q$ I# F1 E
10.   directives: {
    + D- l2 C6 N5 K- k: k
11.     // 注册一个局部的自定义指令 v-focus
    4 O1 Z+ V- ]9 Z: g3 ?/ p2 h
12.     focus: {
    
13.       // 指令的定义
    6 M9 h9 ~' n$ q+ M9 a8 i6 {% i
14.       inserted: function (el) {
    
15.         // 聚焦元素
    1 K( u7 r, Y- J7 R. |, s
16.         el.focus()
    
17.       }
    
18.     }
    / J+ Z7 X: I5 M
19.   }
    0 F0 Y7 l5 \& q' T1 y- y# E/ K
20. })
    8 t. Q* j5 m. V* H' p
21. </script>

复制代码

钩子钩子函数

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

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

钩子函数参数

钩子函数的参数有：

• 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 钩子中可用。
  , \5 |. ?# j# ]. p# H

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

实例
6 ^6 }, B! v: k, B

1. <div id="app"  v-runoob:hello.a.b="message">
   8 \4 e5 ^. l3 B' @6 u( q
2. </div>
   
3. 
   + d; H: U  X2 C! |0 F* }
4. <script>
   ) I# ~) V3 @9 w+ P0 }
5. Vue.directive('runoob', {
   
6.   bind: function (el, binding, vnode) {
   ) A: n" |( e4 P) I! o& l. |
7.     var s = JSON.stringify
   3 q* F) I/ `- ~' P# Z( g* q8 f2 N
8.     el.innerHTML =
   
9.       'name: '       + s(binding.name) + '<br>' +
   5 z" `2 C9 C2 ~+ g9 C; R& c
10.       'value: '      + s(binding.value) + '<br>' +
    7 b, s! o$ n) E, X; B7 }
11.       'expression: ' + s(binding.expression) + '<br>' +
      x3 [, S2 A2 n4 G% @
12.       'argument: '   + s(binding.arg) + '<br>' +
    0 d* A  U5 r, x7 V" r( w- E0 q2 x2 `! ~
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    - V0 F  O7 Y2 s
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    
15.   }
    : K8 d1 T  _7 G* v
16. })
    
17. new Vue({
      e1 n+ p0 s- W/ Z( Z7 M
18.   el: '#app',
    
19.   data: {
    1 c& K2 X6 {% S" Z: g% @
20.     message: '菜鸟教程!'
    
21.   }
    3 s* ?3 a! g! {, y) y
22. })
    7 R" }; R* n$ I0 `% f9 b
23. </script>

复制代码

有时候我们不需要其他钩子函数，我们可以简写函数，如下格式：
% T8 m1 B# b1 ^) X" K. K) [

1. Vue.directive('runoob', function (el, binding) {
   
2.   // 设置指令的背景颜色
   ' Q! h9 W! `4 ?1 E: ^
3.   el.style.backgroundColor = binding.value.color
   , n. t2 J! u/ _/ c# C, i; ]# l( I( l
4. })

复制代码

9 m& X/ B1 W# w

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

实例
7 v" `9 y& y1 O/ \6 O$ c
$ |# }4 h+ Q6 a& b; Q

1. <div id="app">
   3 l+ L6 v' N2 E+ l' T* v
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   2 s3 l% X! c0 S" I) N2 `2 V3 {0 r7 @
3. </div>
   . C; d0 `& j7 z- t7 h6 G
4. 
   
5. <script>
   9 j; N7 O: p0 K* h
6. Vue.directive('runoob', function (el, binding) {
   
7.     // 简写方式设置文本及背景颜色
   
8.     el.innerHTML = binding.value.text
   5 g0 m' q3 I$ c/ [( l
9.     el.style.backgroundColor = binding.value.color
   ! f2 n& o9 R' A% a; g0 l) D
10. })
    
11. new Vue({
    , l& v2 D8 P+ C9 K; R7 a( s0 N
12.   el: '#app'
    5 p5 j$ g% K* j7 N1 I7 ~: N
13. })
    
14. </script>

复制代码

, z5 l$ y7 Y9 R