Vue.js 自定义指令

admin

& s) H2 Q2 @2 v* `, |

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

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

实例
9 B. u0 s# |. `# u4 L( c
- t! J/ D2 E/ R2 D

1. <div id="app">
   # O; @4 _1 G/ _* _- E, J
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   . j0 [, A% t( Y( L# w
3.     <input v-focus>
   8 U8 V/ @# [; |  O4 _8 \" o$ J
4. </div>
   
5. 
   
6. <script>
   9 d. h1 z* F3 |% h. k9 T: P7 [  {
7. // 注册一个全局自定义指令 v-focus
   6 S/ |9 X1 w- G4 B  a4 p
8. Vue.directive('focus', {
   
9.   // 当绑定元素插入到 DOM 中。
   3 N$ d- ]! b* F4 r( f# a
10.   inserted: function (el) {
    ; y1 i' \- i1 v. {: Z' n
11.     // 聚焦元素
    9 H$ M1 T! O) B* g* r* O2 h
12.     el.focus()
    9 |2 m1 b' k1 F4 [
13.   }
    
14. })
    9 _( @( A7 h8 y
15. // 创建根实例
    
16. new Vue({
    ' k) N& R0 [4 H# d6 q% Z
17.   el: '#app'
    $ m9 ?2 h2 i* q4 R2 M# {2 L
18. })
    
19. </script>

复制代码

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

实例
7 l. i6 h7 V& _! d- ]- o
6 s; _4 t1 P* e

1. <div id="app">
   ) x2 r3 p+ m) o1 Y. r
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   
3.   <input v-focus>
   
4. </div>
   
5. 
   8 ~: I+ {  A' W
6. <script>
   
7. // 创建根实例
   
8. new Vue({
   + P- T- M3 T' Q# X' n
9.   el: '#app',
   
10.   directives: {
    
11.     // 注册一个局部的自定义指令 v-focus
    # z5 _* X, Y( L
12.     focus: {
    
13.       // 指令的定义
    
14.       inserted: function (el) {
    
15.         // 聚焦元素
      @6 L% n; s, \/ Y! i
16.         el.focus()
    4 R: d: F; f0 A+ v: l, S: j
17.       }
    " M. m( O8 @2 q0 b8 s. |4 ?
18.     }
    1 @7 Z8 g" {& ^" n8 w
19.   }
    
20. })
    6 a) K0 \/ z3 b& [% D; x( P3 Z
21. </script>

复制代码

钩子钩子函数

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

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

钩子函数参数

钩子函数的参数有：

• 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 }。
    6 s5 l/ @( b7 k: i$ ?6 K
• vnode: Vue 编译生成的虚拟节点。
• oldVnode: 上一个虚拟节点，仅在 update 和 componentUpdated 钩子中可用。
  $ Q3 `! \$ [8 @, f/ I9 Y

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

实例
, Z6 O" E* q! q1 K6 m

1. <div id="app"  v-runoob:hello.a.b="message">
   
2. </div>
   ) H% \4 B+ j9 c0 g' R  b; P
3. 
   
4. <script>
   " j+ d0 N) E0 z5 }
5. Vue.directive('runoob', {
   ' [; ]# m( _4 U5 Z
6.   bind: function (el, binding, vnode) {
   
7.     var s = JSON.stringify
   
8.     el.innerHTML =
   
9.       'name: '       + s(binding.name) + '<br>' +
   4 P0 n/ o+ E; B, K5 ]
10.       'value: '      + s(binding.value) + '<br>' +
    3 k5 H: r6 Y) o1 k* E
11.       'expression: ' + s(binding.expression) + '<br>' +
    
12.       'argument: '   + s(binding.arg) + '<br>' +
    
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    - [- L5 X1 Y. P, W! A9 k
15.   }
    
16. })
    ! ~! }" @' p8 m  w2 P
17. new Vue({
    6 z, L7 ]! W' d# |( u
18.   el: '#app',
    
19.   data: {
    7 ^  \. t9 _2 @: K6 B& l8 a
20.     message: '菜鸟教程!'
    
21.   }
    
22. })
    3 m* N" M5 h; U5 D
23. </script>

复制代码

有时候我们不需要其他钩子函数，我们可以简写函数，如下格式：
' r% O4 C( C0 R1 |& q, n

1. Vue.directive('runoob', function (el, binding) {
   
2.   // 设置指令的背景颜色
   / \0 H2 T, r3 e+ l
3.   el.style.backgroundColor = binding.value.color
   . I: a" F0 `0 M6 A
4. })

复制代码

' f& b: Z6 U$ K1 b6 I( Y6 o  ]
  }5 Y% U5 q9 v) E8 f6 W

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

实例
3 g/ y# N  \; l! j$ Q1 e8 o
- D! K* P2 w* ^4 x/ N9 Y# S" L2 q

1. <div id="app">
   
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   - l3 w8 p, j8 o" N
3. </div>
     @/ G5 e$ b  L( [6 m
4. 
   
5. <script>
   1 t9 Y3 E5 w( F
6. Vue.directive('runoob', function (el, binding) {
   - [0 \* Q9 }2 M
7.     // 简写方式设置文本及背景颜色
   7 J2 l: B* A8 G% |) F6 F$ Q% a4 I
8.     el.innerHTML = binding.value.text
   
9.     el.style.backgroundColor = binding.value.color
   4 X6 [& [( [0 c2 O
10. })
    0 s9 r( j! ~7 [& r( A; j
11. new Vue({
    
12.   el: '#app'
    
13. })
    ! M. a* o# S: Q0 h2 x& P
14. </script>

复制代码

- V" Y5 u, X" X& h5 B/ _  i
# S* q, y! j" L# |8 R