Vue.js 自定义指令

admin

& W9 n9 A# K0 u

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

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

实例

1. <div id="app">
   2 I/ _* K; ~1 `
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   0 C$ ]9 G, n- U- x, R  q0 [1 w
3.     <input v-focus>
   / n# p$ I2 I9 r- s
4. </div>
   4 ^/ K& J1 U$ l, p6 {
5. 
   1 r$ ]" w$ R2 W' R) X6 t9 u- o
6. <script>
   
7. // 注册一个全局自定义指令 v-focus
   
8. Vue.directive('focus', {
     O3 |5 T% O: }
9.   // 当绑定元素插入到 DOM 中。
   5 z" I4 d8 b" w* ~: t6 k
10.   inserted: function (el) {
    
11.     // 聚焦元素
    , T% V, J2 [8 ~2 d" o: D2 g
12.     el.focus()
    
13.   }
    
14. })
    ) |$ y1 f/ c" l/ A7 k" c) q
15. // 创建根实例
    ; _$ c6 ?9 f. t% F  @/ P: g/ e
16. new Vue({
    
17.   el: '#app'
    
18. })
    
19. </script>

复制代码

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

实例

' ?0 {% q6 j" i! m

1. <div id="app">
   
2.   <p>页面载入时，input 元素自动获取焦点：</p>
     r; h' u' M3 s* c; p3 A
3.   <input v-focus>
   - ^# O6 K8 b+ S- I7 f% i4 Y
4. </div>
   
5. 
   
6. <script>
   
7. // 创建根实例
   ; N8 t$ R6 d9 O& c- j: R2 @
8. new Vue({
   ! a' [% {$ U' X, E! q, G+ ]7 U. J
9.   el: '#app',
   3 ?# |  ~! L  ^. v/ J+ e+ @
10.   directives: {
    ( Q$ ~8 L7 `5 B' X5 `4 m
11.     // 注册一个局部的自定义指令 v-focus
    1 j, d5 l* J! G& e0 p$ a
12.     focus: {
    
13.       // 指令的定义
    
14.       inserted: function (el) {
    
15.         // 聚焦元素
    1 a0 f+ U* Y9 D/ c: c9 h
16.         el.focus()
    
17.       }
    
18.     }
    ) i$ u9 W3 d8 F: |" N" v+ C, A" s
19.   }
    4 [. h$ @/ E! ~( O3 z+ }/ W# @( q$ @+ o
20. })
    # J# O% u8 P; [  a. J/ s
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 }。
    
• vnode: Vue 编译生成的虚拟节点。
• oldVnode: 上一个虚拟节点，仅在 update 和 componentUpdated 钩子中可用。
  ' V" l; F  Z: B) A! J

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

实例

1. <div id="app"  v-runoob:hello.a.b="message">
   # V  ^' i  {% ^" M; G
2. </div>
   
3. 
     Z+ A+ p. ?6 p0 j# x8 L# T
4. <script>
   
5. Vue.directive('runoob', {
   
6.   bind: function (el, binding, vnode) {
   * R$ \+ i. x! d. N, [' B) b
7.     var s = JSON.stringify
   ; J- X: o$ l9 B' s5 s6 L. M% s( @
8.     el.innerHTML =
   * }' H0 ?2 k& g5 Y2 s: O
9.       'name: '       + s(binding.name) + '<br>' +
   1 |% ~/ E, n: o/ {
10.       'value: '      + s(binding.value) + '<br>' +
    
11.       'expression: ' + s(binding.expression) + '<br>' +
    1 m/ ~' `0 x* ^) W6 h
12.       'argument: '   + s(binding.arg) + '<br>' +
    ! S! H& i5 m# C, F$ ~( ^8 |( x
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    
15.   }
    
16. })
    " o3 A% q& e8 F$ _
17. new Vue({
    
18.   el: '#app',
    
19.   data: {
    
20.     message: '菜鸟教程!'
    ( n  `' K7 q2 @8 [
21.   }
    ! U  |9 J4 s# o1 N: v' T1 }
22. })
    
23. </script>

复制代码

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

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

复制代码

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

实例

1. <div id="app">
   : b0 e; X2 |& T) z; F& f, V
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   
3. </div>
   % P. Y& M* d& t- N# h' L
4. 
   
5. <script>
   * H1 |0 K- v3 ?4 \
6. Vue.directive('runoob', function (el, binding) {
   
7.     // 简写方式设置文本及背景颜色
   
8.     el.innerHTML = binding.value.text
   
9.     el.style.backgroundColor = binding.value.color
   0 i0 z( D: Y+ a) K# q
10. })
    / D5 _9 ]% E# a1 |& b# @
11. new Vue({
    
12.   el: '#app'
    
13. })
    9 K* d1 k8 o) g, p5 K
14. </script>

复制代码

2 p* q: G" S+ f

+ A/ U6 H' O; u