Vue.js 自定义指令

admin

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

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

实例

1. <div id="app">
   $ [+ x& r# K9 H; }' B2 F" _- Z; @
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   
3.     <input v-focus>
   
4. </div>
   
5. 
   % j, J; N( X9 G, {& P& h
6. <script>
   
7. // 注册一个全局自定义指令 v-focus
   
8. Vue.directive('focus', {
   
9.   // 当绑定元素插入到 DOM 中。
   ' F. @4 v! n, m: M: k7 Y; e
10.   inserted: function (el) {
    
11.     // 聚焦元素
    
12.     el.focus()
    
13.   }
    0 K3 I" o1 A0 K* h1 S  u
14. })
    
15. // 创建根实例
    
16. new Vue({
    2 ^( X2 ^* Y2 }6 |8 T
17.   el: '#app'
    
18. })
    , y7 [8 z0 C. K' {
19. </script>

复制代码

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

实例

1. <div id="app">
   $ }+ E- M5 z; ~0 m1 l# N3 a
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   # V$ W) i0 u- c% C9 Y! I
3.   <input v-focus>
   ! s( |* D9 p$ [1 t) M& i3 a7 ]; Y1 y
4. </div>
   7 {! Q; H% q* K( c; B; p& ~
5. 
   " Z# a* s( Q, `7 m, i9 u, Q# k
6. <script>
   
7. // 创建根实例
   3 z) t  ]/ M/ i9 Y, c. i: q6 F
8. new Vue({
   ' O5 c4 L$ G$ l
9.   el: '#app',
   - \  o# V) e. b: d  z) X) G1 i
10.   directives: {
    
11.     // 注册一个局部的自定义指令 v-focus
    . E1 w& M( Y5 Z) t  i
12.     focus: {
    6 p5 p+ U& z3 i) ^
13.       // 指令的定义
    4 f  z, A6 \8 P! o& b4 R
14.       inserted: function (el) {
    5 l+ y# v5 t* q% V1 _7 \% @
15.         // 聚焦元素
    / ?: s+ i/ D; e" w
16.         el.focus()
    # X$ O0 Z: |/ `9 c
17.       }
    
18.     }
    
19.   }
    
20. })
    " S5 J" \6 B) o0 {) V% X
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 G# I9 b) a6 v# G/ J2 i
• vnode: Vue 编译生成的虚拟节点。
• oldVnode: 上一个虚拟节点，仅在 update 和 componentUpdated 钩子中可用。
  

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

实例
9 X, Q0 O: u( Q/ W: x( V
) s* p- u, y; b5 Z

1. <div id="app"  v-runoob:hello.a.b="message">
   
2. </div>
   
3. 
   
4. <script>
   
5. Vue.directive('runoob', {
   8 e9 @  [+ t( [8 ?* C
6.   bind: function (el, binding, vnode) {
   
7.     var s = JSON.stringify
   
8.     el.innerHTML =
   
9.       'name: '       + s(binding.name) + '<br>' +
   
10.       'value: '      + s(binding.value) + '<br>' +
    
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(', ')
    
15.   }
    
16. })
    + K& ^, G# a0 T* V
17. new Vue({
    
18.   el: '#app',
    
19.   data: {
    0 k5 r- `/ T/ F% ~9 P4 O9 N: }
20.     message: '菜鸟教程!'
    
21.   }
    ' C9 n1 X: M: N2 X
22. })
    
23. </script>

复制代码

有时候我们不需要其他钩子函数，我们可以简写函数，如下格式：
0 `9 @; Y- m7 A' I1 h

1. Vue.directive('runoob', function (el, binding) {
   
2.   // 设置指令的背景颜色
     n% a) g- m& \
3.   el.style.backgroundColor = binding.value.color
   
4. })

复制代码

' S; }8 Y( K6 v' n% J

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

实例
$ Z7 K: _8 g/ o: h1 u* y' {3 c

1. <div id="app">
   5 y& G8 p4 [0 J/ m* Z; s. [! c* {
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   
3. </div>
     y# b1 P2 n3 Z) K* e5 a2 @. |& B
4. 
   7 F9 K) i: x: N
5. <script>
   $ g2 c+ G7 S) [1 h
6. Vue.directive('runoob', function (el, binding) {
   % e2 W! s3 B+ N
7.     // 简写方式设置文本及背景颜色
   3 H' b; J* \& }2 _. S5 V0 B6 n
8.     el.innerHTML = binding.value.text
   
9.     el.style.backgroundColor = binding.value.color
   1 a5 L1 X  g" ^+ G! @
10. })
    ' J# }4 k) V: F. N
11. new Vue({
    # \' p' A* Y3 l" J7 I: G, E/ N
12.   el: '#app'
    " }! D* ?0 U! x/ H; k$ l
13. })
    
14. </script>

复制代码

: Q' \% y+ @  H3 q$ Z: V$ }$ f: T