Vue.js 自定义指令

admin

& W( A9 _/ t+ E7 w$ J

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

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

实例

. h$ `* g* [' c0 ^# A" P6 s8 h

1. <div id="app">
   
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   ! r: P" _, b5 W
3.     <input v-focus>
   
4. </div>
   
5. 
   
6. <script>
   5 a" B6 U1 h/ S5 p4 f
7. // 注册一个全局自定义指令 v-focus
   
8. Vue.directive('focus', {
   
9.   // 当绑定元素插入到 DOM 中。
   
10.   inserted: function (el) {
    ; ?( e. i( j0 B6 ^# N3 s- Q
11.     // 聚焦元素
    6 o. X9 e5 [! ^& f% B% h$ r& `
12.     el.focus()
    
13.   }
    1 J# T' E& h3 S( N) M" W- C
14. })
    0 r" o6 H! }* }1 K+ n
15. // 创建根实例
    
16. new Vue({
    5 t9 T9 s1 o9 F8 Y& H
17.   el: '#app'
    
18. })
    
19. </script>

复制代码

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

实例

1. <div id="app">
   
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   
3.   <input v-focus>
   " ^0 W) J! U) l" m0 D/ u, Q% w+ {( I
4. </div>
   4 m3 \% y7 w% E: W% y
5. 
   - o7 S+ w- h- k. p# i! @
6. <script>
   
7. // 创建根实例
   
8. new Vue({
   
9.   el: '#app',
   4 Q* y2 |2 p0 K9 _3 e8 v. g, E& [0 Z7 A
10.   directives: {
    
11.     // 注册一个局部的自定义指令 v-focus
    
12.     focus: {
    
13.       // 指令的定义
    
14.       inserted: function (el) {
    5 v/ i1 ^1 ]" a5 b0 `
15.         // 聚焦元素
    
16.         el.focus()
    / u( g1 G, G. h3 N  n0 Q
17.       }
    
18.     }
    
19.   }
    
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 }。
    1 }6 t( L; ^1 E+ B. i1 n
• vnode: Vue 编译生成的虚拟节点。
• oldVnode: 上一个虚拟节点，仅在 update 和 componentUpdated 钩子中可用。
  

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

实例

* v7 `1 G& G5 K) ~* n

1. <div id="app"  v-runoob:hello.a.b="message">
   & s# X- S3 T& S' I, R. ~% E
2. </div>
   
3. 
   ' w0 `+ Z& e  X
4. <script>
     E. i7 d) y! W$ V
5. Vue.directive('runoob', {
   
6.   bind: function (el, binding, vnode) {
   
7.     var s = JSON.stringify
   - C! [$ \( c1 }" s6 a5 g; Q* G
8.     el.innerHTML =
   
9.       'name: '       + s(binding.name) + '<br>' +
   3 v7 N: E) S" W& ]  ]9 F
10.       'value: '      + s(binding.value) + '<br>' +
    2 K7 e. u1 b, k9 U
11.       'expression: ' + s(binding.expression) + '<br>' +
    
12.       'argument: '   + s(binding.arg) + '<br>' +
    
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    * o. x5 Z1 P+ H: m/ u4 U+ ^1 L) R
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    
15.   }
    
16. })
    
17. new Vue({
    
18.   el: '#app',
    
19.   data: {
    
20.     message: '菜鸟教程!'
    6 n* R9 Z& x1 C: N* ?" d
21.   }
    
22. })
    
23. </script>

复制代码

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

1. Vue.directive('runoob', function (el, binding) {
   
2.   // 设置指令的背景颜色
     n8 G+ d2 Z! M/ ^" d
3.   el.style.backgroundColor = binding.value.color
   
4. })

复制代码

% t5 I0 C8 q4 Y3 H' N

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

实例

+ S: A# b5 M5 B+ h% {' F: e

1. <div id="app">
   - @1 [) f- A3 i3 _" K! _
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   
3. </div>
   * n) B% |* l4 B& @8 z+ v
4. 
   
5. <script>
   
6. Vue.directive('runoob', function (el, binding) {
   
7.     // 简写方式设置文本及背景颜色
   
8.     el.innerHTML = binding.value.text
   
9.     el.style.backgroundColor = binding.value.color
   
10. })
    ; d+ ^; v  I! Q" [0 d
11. new Vue({
    
12.   el: '#app'
    $ @, u' h, L# t5 Q: a
13. })
    / }! U9 h2 }1 N9 }5 M9 S
14. </script>

复制代码

6 N6 r) a# E3 A: d& J" m- u6 K6 w
6 T0 f+ y7 H4 G/ |. q1 e