Vue.js 自定义指令

admin

( V) G2 k8 T, s3 l! h

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

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

实例

0 h/ q. K* }+ d# c+ N

1. <div id="app">
   
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   
3.     <input v-focus>
   0 {7 I- x+ s4 e4 V+ }/ m- v* Q
4. </div>
   5 C% r6 C# Z* U5 b: o! P% r* a
5. 
   % O# \9 [' I" \1 b* y0 S
6. <script>
   2 {! |* A* P- h2 S6 ^' y& `1 M4 J
7. // 注册一个全局自定义指令 v-focus
   
8. Vue.directive('focus', {
   3 Z* b! n' Q6 ?7 x
9.   // 当绑定元素插入到 DOM 中。
   
10.   inserted: function (el) {
    
11.     // 聚焦元素
    : w! Z' \) g& `* v& M, C. Y1 l
12.     el.focus()
    
13.   }
    7 A* \8 k9 v9 a2 m$ J% R% E2 h
14. })
    
15. // 创建根实例
    # t5 f( `" i1 ?
16. new Vue({
    : Y% }; g% r% K, |& `
17.   el: '#app'
    8 y6 ?  f1 ]+ @# S; h3 `+ Z
18. })
    ; M- o7 R& v6 O/ b. t
19. </script>

复制代码

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

实例

! v9 k4 P$ ?$ X) s$ ?6 m) Y

1. <div id="app">
   $ G: F' I% g& k& E
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   
3.   <input v-focus>
   - r- q5 h- ?! K) S: w% q! t
4. </div>
   ) P: K3 a5 y4 z2 q$ w9 @8 \
5. 
   
6. <script>
   
7. // 创建根实例
   2 n9 e! S& S' Z; d
8. new Vue({
   * w) j" {8 K. U4 h5 f
9.   el: '#app',
   2 Q# o# k1 I, x
10.   directives: {
    
11.     // 注册一个局部的自定义指令 v-focus
    
12.     focus: {
    . }% _; U# D1 d6 i, O- x% u
13.       // 指令的定义
    
14.       inserted: function (el) {
    
15.         // 聚焦元素
    
16.         el.focus()
    
17.       }
    ( ]' G& Q- q* ^  }/ c$ d
18.     }
    % s4 R& Y. w) m& I3 C5 F. a
19.   }
    . U6 u- d( P1 v! e2 L( S
20. })
    
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 }。
    0 y! F  U/ _6 l4 R& o5 y. U
• vnode: Vue 编译生成的虚拟节点。
• oldVnode: 上一个虚拟节点，仅在 update 和 componentUpdated 钩子中可用。
  

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

实例

, }3 V3 f# ~3 u5 W* f8 w

1. <div id="app"  v-runoob:hello.a.b="message">
   
2. </div>
   
3. 
   
4. <script>
   
5. Vue.directive('runoob', {
   
6.   bind: function (el, binding, vnode) {
   
7.     var s = JSON.stringify
   $ p0 o* l9 C" J2 s
8.     el.innerHTML =
   
9.       'name: '       + s(binding.name) + '<br>' +
   6 e7 b+ z, I' L; r$ {
10.       'value: '      + s(binding.value) + '<br>' +
    
11.       'expression: ' + s(binding.expression) + '<br>' +
    ; o- O# W4 k5 c' P7 G) Z  r- }
12.       'argument: '   + s(binding.arg) + '<br>' +
    ) b$ D! `( t! U" p* T
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    1 Q. k( x" ?' g) b# B' w+ N
15.   }
    8 G! N. @1 F' b# I8 F, Z& F
16. })
    - p1 d4 |6 _2 a
17. new Vue({
    
18.   el: '#app',
    + M& }" F/ f& S( ]/ R
19.   data: {
    9 g6 [/ ?/ Q1 d. ?* u3 D4 b
20.     message: '菜鸟教程!'
    * w' x, a( l- ?! c2 A
21.   }
    
22. })
    " C5 @4 P/ |8 q, ?
23. </script>

复制代码

有时候我们不需要其他钩子函数，我们可以简写函数，如下格式：
3 v* A9 \* U" V" D( e8 ^, J' E

1. Vue.directive('runoob', function (el, binding) {
   
2.   // 设置指令的背景颜色
   # G$ B) e( `0 d2 R2 _2 l1 H8 [
3.   el.style.backgroundColor = binding.value.color
   
4. })

复制代码

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

实例

- a. R: q' a1 A$ i% \: n

1. <div id="app">
   
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   % |4 C3 m. G0 h$ D( p
3. </div>
   
4. 
   + W5 ?/ ~" B$ X, v) I! v2 G% Y
5. <script>
   
6. Vue.directive('runoob', function (el, binding) {
   7 C7 `  b! `6 m
7.     // 简写方式设置文本及背景颜色
   
8.     el.innerHTML = binding.value.text
     K& l! b5 u4 U+ c3 I
9.     el.style.backgroundColor = binding.value.color
   2 h: H. H: M0 l, x
10. })
    8 @4 ^5 r5 n; t1 I9 ~2 W2 I
11. new Vue({
    
12.   el: '#app'
    
13. })
    
14. </script>

复制代码

+ f5 R7 c2 O6 h& K) w5 l( R
' S  A! F1 D( O7 ?
+ F2 j  _, T" V/ c/ L/ c