Vue.js 自定义指令

admin

- d: u/ Y: M' j/ l. z

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

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

实例
; |% J: t/ u! g8 k& a+ r

1. <div id="app">
   
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   0 F6 Y& h( m7 z/ c$ K
3.     <input v-focus>
   : x" \, R: w- X4 o9 _
4. </div>
   : y' O5 E' h/ F) X4 y4 x+ ~7 J& K+ N' z
5. 
   ; |2 U7 W( q$ j4 Y$ v: V6 Y9 A
6. <script>
   , V4 J, i2 O" p2 P  E' u
7. // 注册一个全局自定义指令 v-focus
   
8. Vue.directive('focus', {
   1 I6 A* m/ d0 S; p. W
9.   // 当绑定元素插入到 DOM 中。
   , c2 o+ u0 f' {3 B
10.   inserted: function (el) {
    7 n* N3 s; ~# q
11.     // 聚焦元素
    
12.     el.focus()
    : H. M9 ^( `: }) t0 v
13.   }
    
14. })
    " x  p* W# K& S. j; V, o! Z% I
15. // 创建根实例
    
16. new Vue({
    1 {* h" ^0 V+ _. L
17.   el: '#app'
    ' G0 [9 y7 W2 T5 ~7 A( C
18. })
    4 D- h& e5 S+ v* l  l* n
19. </script>

复制代码

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

实例
7 P" [0 w, q) q$ U! p5 N* U
5 m' b2 d7 ?/ m9 B

1. <div id="app">
   , U6 R3 Q5 Q  B; B
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   
3.   <input v-focus>
   
4. </div>
   
5. 
   
6. <script>
   
7. // 创建根实例
   
8. new Vue({
   
9.   el: '#app',
     \( q* K# S/ u- C
10.   directives: {
    
11.     // 注册一个局部的自定义指令 v-focus
    
12.     focus: {
    & G; M7 ~, {. {" U
13.       // 指令的定义
    - W' n- [2 Q- i' g/ H
14.       inserted: function (el) {
    9 M- S$ H* B) k1 V
15.         // 聚焦元素
    
16.         el.focus()
    ) A; _- c, v3 n
17.       }
      e9 V& m+ n$ h/ i2 I: _& d) [2 Z
18.     }
    3 Z. E" Q+ V5 Z$ k
19.   }
    . |! a# p! P- N# W8 s  h
20. })
    
21. </script>

复制代码

钩子钩子函数

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

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

钩子函数参数

钩子函数的参数有：

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

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

实例
! l% b( A( I) P. W4 K
  s( `( ?# n& l* \

1. <div id="app"  v-runoob:hello.a.b="message">
   8 n/ \) F) h) }) d6 E& B& w5 l2 w
2. </div>
   
3. 
   
4. <script>
   
5. Vue.directive('runoob', {
   
6.   bind: function (el, binding, vnode) {
   " c4 H/ q. f+ A6 y$ V2 D* {
7.     var s = JSON.stringify
   
8.     el.innerHTML =
   1 X, B1 M$ Y. s5 F: r/ y+ Z
9.       'name: '       + s(binding.name) + '<br>' +
   
10.       'value: '      + s(binding.value) + '<br>' +
    7 I5 @  H/ w+ X& F4 N5 b
11.       'expression: ' + s(binding.expression) + '<br>' +
    
12.       'argument: '   + s(binding.arg) + '<br>' +
    
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    / m+ L; u! K- Y9 B0 L  T
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    
15.   }
    
16. })
    : B2 I4 [( v8 p. A
17. new Vue({
    
18.   el: '#app',
    * f6 @- e% L' n  V' n) t
19.   data: {
    
20.     message: '菜鸟教程!'
    
21.   }
    
22. })
    
23. </script>

复制代码

有时候我们不需要其他钩子函数，我们可以简写函数，如下格式：
& Y2 }+ k. a$ g# |: J

1. Vue.directive('runoob', function (el, binding) {
   
2.   // 设置指令的背景颜色
   + [+ a+ T  g2 S3 ?; `
3.   el.style.backgroundColor = binding.value.color
   
4. })

复制代码

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

实例
8 D& i/ R  Q- R7 F! l' E: p. b

1. <div id="app">
   + r/ g% E6 f. a9 m
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   
3. </div>
   
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. })
    
11. new Vue({
    + c% S3 \+ l' ~7 {6 d+ e. B" b
12.   el: '#app'
    
13. })
    
14. </script>

复制代码