Vue.js 自定义指令

admin

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

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

实例

1. <div id="app">
   
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   " f$ S" _4 i# |* u
3.     <input v-focus>
   , k4 }7 q" }' \4 T- Q; H
4. </div>
   7 T4 g; G5 \, F' g+ i# I' f8 S
5. 
   ' h2 l2 Q9 |4 A
6. <script>
   ) x. p& {) b( u/ U
7. // 注册一个全局自定义指令 v-focus
   
8. Vue.directive('focus', {
   1 H  T& P7 r: i0 O; x
9.   // 当绑定元素插入到 DOM 中。
   
10.   inserted: function (el) {
    ! r8 x; ?3 ?5 U) ?( x
11.     // 聚焦元素
    ! Z3 a8 t; K! n7 ^
12.     el.focus()
    7 r  @4 {4 T1 A
13.   }
    
14. })
    % g4 T9 G. D2 Y$ h8 x- c' m" N
15. // 创建根实例
    3 k0 O" q: q6 W0 u4 h+ ]4 Y1 F. ?
16. new Vue({
    
17.   el: '#app'
    
18. })
    
19. </script>

复制代码

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

实例

1. <div id="app">
   . S  U, k+ X$ ~# u. X9 b) ^
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   & z- T* v5 O, V. r
3.   <input v-focus>
   7 _( q4 N, C4 g. m/ m9 h
4. </div>
   
5. 
   * D7 v  s/ E% ]+ {: @) J" W8 A
6. <script>
   + u, l& |1 @) v& \! F( ^/ A
7. // 创建根实例
   
8. new Vue({
   
9.   el: '#app',
   
10.   directives: {
    * @4 Q" C8 ?: I% \3 f/ r
11.     // 注册一个局部的自定义指令 v-focus
    
12.     focus: {
    
13.       // 指令的定义
    - J: e; y& A5 X' J
14.       inserted: function (el) {
    % l4 m: D! e# h+ S; F/ M
15.         // 聚焦元素
    5 q0 ?0 E6 S/ ]- u( w8 H
16.         el.focus()
    ( q% M- V) z2 x2 x+ j2 L0 I2 G
17.       }
    & K% L. v6 Q4 Y9 M) S
18.     }
    8 L4 `0 y* L% V
19.   }
    
20. })
    # p9 T/ [* g" 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 }。
    8 I6 A3 C: c; t/ V  Z. z4 w9 ]
• vnode: Vue 编译生成的虚拟节点。
• oldVnode: 上一个虚拟节点，仅在 update 和 componentUpdated 钩子中可用。
  # j; o5 h1 A. {. R' z

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

实例
+ g% ?4 f5 O' E$ k$ H2 ?  J

1. <div id="app"  v-runoob:hello.a.b="message">
   * L) t% U4 O% \& @# ]: |, ?$ Y9 P
2. </div>
   + C" t3 A! a9 K
3. 
   ; ~7 D. z# t6 o% z, e' y8 o
4. <script>
   / i8 O9 Q+ G* D
5. Vue.directive('runoob', {
   8 y9 K9 j4 N  E$ V
6.   bind: function (el, binding, vnode) {
   
7.     var s = JSON.stringify
   
8.     el.innerHTML =
   $ S& ?! K0 h6 D8 b/ Y, s
9.       'name: '       + s(binding.name) + '<br>' +
   
10.       'value: '      + s(binding.value) + '<br>' +
    6 \8 V$ l/ s6 w4 X  K
11.       'expression: ' + s(binding.expression) + '<br>' +
    $ `+ {: d) @- m7 x6 M" _6 j
12.       'argument: '   + s(binding.arg) + '<br>' +
    
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    4 i, w6 F3 Q% N8 h
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    1 O! S8 P4 N  d! I8 \0 k' W( `/ |4 U) k
15.   }
    ; n* A4 k1 V: A% O( C. v  ~, q* k
16. })
    
17. new Vue({
    
18.   el: '#app',
    
19.   data: {
    % t- U: S& ~/ N9 y3 y% a
20.     message: '菜鸟教程!'
    
21.   }
    
22. })
    9 Y7 U" b% R$ P9 D
23. </script>

复制代码

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

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

复制代码

& K1 \$ k: U6 h  t

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

实例
; _3 ^6 F' i/ Y+ M1 A) N# h7 b

1. <div id="app">
   
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   
3. </div>
   
4. 
   
5. <script>
   
6. Vue.directive('runoob', function (el, binding) {
   $ O1 T/ H" Q! J# p$ L8 {7 `
7.     // 简写方式设置文本及背景颜色
   
8.     el.innerHTML = binding.value.text
   / @8 G' ~  _  Z8 k( m
9.     el.style.backgroundColor = binding.value.color
   
10. })
    4 g$ ?' R+ N! [; E0 x0 o
11. new Vue({
    & S9 c& `  ~4 K) |' B3 @5 {. N
12.   el: '#app'
    . Z7 {% Q, t/ L; |; f, o
13. })
    
14. </script>

复制代码

# e5 _* u6 t; ]& _' N! `7 `9 r
$ g7 F4 u7 Z# P1 g( m! t0 d
$ {, M& n- V* h9 `$ T