Vue.js 自定义指令

admin

; u  G" r/ H) m  n) ^

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

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

实例
4 A9 N0 c/ ?1 i5 {
* y6 }; [8 m$ |8 f1 F; @

1. <div id="app">
   
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   
3.     <input v-focus>
   : `0 \9 k9 R( P  T- J
4. </div>
   " Z. t1 J5 h# t
5. 
   0 a8 d* W. M7 Y
6. <script>
   6 V0 _- \- M6 n6 ?
7. // 注册一个全局自定义指令 v-focus
   
8. Vue.directive('focus', {
     A6 {, e0 F5 y3 O
9.   // 当绑定元素插入到 DOM 中。
   
10.   inserted: function (el) {
    5 P' M2 [0 t9 @
11.     // 聚焦元素
    5 x0 r5 S) b+ b$ H' |. D, ~/ `" _3 f, b' X
12.     el.focus()
    
13.   }
    " J5 r. t+ M. I8 @7 \' Y' S. C' u  c
14. })
    
15. // 创建根实例
    
16. new Vue({
    9 {5 M0 e8 I  x0 [! V  ?
17.   el: '#app'
    
18. })
    ) g' v  I3 l* r$ v0 n
19. </script>

复制代码

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

实例

1. <div id="app">
   
2.   <p>页面载入时，input 元素自动获取焦点：</p>
     l6 U" d/ z) c
3.   <input v-focus>
   
4. </div>
   $ o; l$ V: C7 @; o
5. 
   
6. <script>
   6 T( ]3 L0 \7 [4 p
7. // 创建根实例
   
8. new Vue({
   $ t/ N8 M0 _& h" k+ }
9.   el: '#app',
   
10.   directives: {
    
11.     // 注册一个局部的自定义指令 v-focus
    6 Z& T. [& n' ]
12.     focus: {
    
13.       // 指令的定义
    " A( ~8 E. o, K8 O6 G
14.       inserted: function (el) {
    
15.         // 聚焦元素
    " S2 ^- N' K, N2 a% V7 `6 p! z
16.         el.focus()
    % q# ^$ c, o. ]5 u7 @
17.       }
    8 {! n4 l6 L( s' h9 W
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 }。
    , }2 `9 @9 d! Z; t
• vnode: Vue 编译生成的虚拟节点。
• oldVnode: 上一个虚拟节点，仅在 update 和 componentUpdated 钩子中可用。
  

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

实例

$ M1 s2 I0 h3 N

1. <div id="app"  v-runoob:hello.a.b="message">
   
2. </div>
   4 ?2 _/ v8 z7 O) c5 T! C1 n
3. 
   ) e, V7 d+ L4 T: r1 J
4. <script>
   6 t5 p% ]& q% k7 `
5. Vue.directive('runoob', {
   ! E) u: a, c+ N/ F! T( ?' B
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>' +
    " j6 v/ C2 ~' l: L" G8 n
11.       'expression: ' + s(binding.expression) + '<br>' +
    
12.       'argument: '   + s(binding.arg) + '<br>' +
    
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    $ U: N0 ^/ c9 v7 q  X
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    0 o6 I% P: ]; b2 c1 c0 u- z4 C
15.   }
    
16. })
    
17. new Vue({
    3 W, ?0 P8 b, `0 s; E" Q
18.   el: '#app',
    ) Q2 Z7 d! r( _9 @+ z; c
19.   data: {
    0 c! K+ K/ ?, |& H* W: v
20.     message: '菜鸟教程!'
    . \, W( `; a6 F2 L' s! R
21.   }
    
22. })
    
23. </script>

复制代码

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

1. Vue.directive('runoob', function (el, binding) {
   
2.   // 设置指令的背景颜色
   3 W# L5 W4 Y- N% {. q' ~
3.   el.style.backgroundColor = binding.value.color
   
4. })

复制代码

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

实例
" p# I: @7 W$ D" b8 `; e& N; M( N

1. <div id="app">
   ' b5 @6 _; Q* L5 _% A, ^
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   
3. </div>
   # s- ]- d% {1 f" k2 d0 j% I
4. 
   * W3 D6 J5 G% D& D
5. <script>
   ( J8 B" G7 V/ I: G6 h
6. Vue.directive('runoob', function (el, binding) {
   
7.     // 简写方式设置文本及背景颜色
   
8.     el.innerHTML = binding.value.text
   ) a5 z0 O6 i2 X* W! |! B
9.     el.style.backgroundColor = binding.value.color
   6 D8 k: d% {' M. e0 S
10. })
    1 E! F) n, a* k7 c
11. new Vue({
    ' w" P) ]0 R" ~- ?! Z
12.   el: '#app'
    5 Q2 n1 x+ ~6 ?, @3 _& f3 p7 U# M
13. })
    : Y! t) h7 Z7 S: M3 \
14. </script>

复制代码

# I9 s! o1 D2 J- V4 a" O$ u