Vue.js 自定义指令

admin

) F7 \3 Y7 i0 Z- q) i* t* b2 O

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

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

实例
  R: q$ K7 V; C
2 z6 d# n( h) r. y

1. <div id="app">
   5 `% a% W( Z, U; s. r# f: G5 a
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   
3.     <input v-focus>
   
4. </div>
     n2 ?! Y; p0 u; Z
5. 
     K: i. ^( V. N7 Y
6. <script>
   ! |, `, {* R7 n/ p/ C( A
7. // 注册一个全局自定义指令 v-focus
   
8. Vue.directive('focus', {
   
9.   // 当绑定元素插入到 DOM 中。
   : v) {  [7 [" l
10.   inserted: function (el) {
    
11.     // 聚焦元素
    
12.     el.focus()
    7 K) A2 f5 d9 x) x& I- F9 j
13.   }
    
14. })
    2 ], {- S! k3 z8 F, ?0 O
15. // 创建根实例
    
16. new Vue({
    
17.   el: '#app'
    
18. })
    6 b- b& [( F  v! V& J5 j; a( y
19. </script>

复制代码

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

实例
; Q  c0 ?# W/ n; ?) ]
& J/ a8 J) X. B/ s8 L$ Q/ i/ v; q

1. <div id="app">
   ! ]$ o0 t6 `9 _: _  w
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   
3.   <input v-focus>
   : X" L" Y9 _. B3 p( a
4. </div>
   % u' v6 ?1 s, O
5. 
   
6. <script>
   9 R' u" d  V7 X" C4 |( l( l/ I
7. // 创建根实例
   0 ?- `1 T. A, n$ r8 V
8. new Vue({
   9 @9 q! A0 Q4 ~! R1 u1 M
9.   el: '#app',
   
10.   directives: {
    
11.     // 注册一个局部的自定义指令 v-focus
    , m- D9 v; t% m0 J1 C8 G& v" A+ a
12.     focus: {
    
13.       // 指令的定义
    , q5 h' E, W( j* a6 e
14.       inserted: function (el) {
    
15.         // 聚焦元素
    
16.         el.focus()
    
17.       }
    
18.     }
    ! o1 m4 Q6 b/ D
19.   }
    8 H. L3 _3 X" `4 U2 X. l
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 }。
    
• vnode: Vue 编译生成的虚拟节点。
• oldVnode: 上一个虚拟节点，仅在 update 和 componentUpdated 钩子中可用。
  ( L+ ~# n  G* \* J( q! y

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

实例
' @" U: j' T) }( d/ {6 S. M

1. <div id="app"  v-runoob:hello.a.b="message">
   
2. </div>
   4 S) J/ Z) c) i% K& t+ h: H
3. 
   
4. <script>
   
5. Vue.directive('runoob', {
   
6.   bind: function (el, binding, vnode) {
   # a/ d* B; u- ?, Z4 E) S
7.     var s = JSON.stringify
   
8.     el.innerHTML =
   
9.       'name: '       + s(binding.name) + '<br>' +
   
10.       'value: '      + s(binding.value) + '<br>' +
    ( Y, M5 e' \! H
11.       'expression: ' + s(binding.expression) + '<br>' +
    
12.       'argument: '   + s(binding.arg) + '<br>' +
    . @6 U9 V6 V) H. W& C% [. v* V/ Z# K
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    & m' G/ n& F. h; I( ~- L
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    , s1 r6 o- [3 g3 z5 a
15.   }
    6 w( S3 _( x! E6 y/ R+ P
16. })
    
17. new Vue({
    
18.   el: '#app',
    
19.   data: {
    8 O8 }! M1 m4 A  e
20.     message: '菜鸟教程!'
    " ^  V1 z3 O1 g  N1 T: Z
21.   }
    0 L7 E- v7 b; t' l% v* s
22. })
    
23. </script>

复制代码

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

1. Vue.directive('runoob', function (el, binding) {
   8 F* `7 F: u* S8 c. Y
2.   // 设置指令的背景颜色
   
3.   el.style.backgroundColor = binding.value.color
   
4. })

复制代码

5 d! r& X  l5 K! d3 O) f

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

实例
+ J! n) V$ b1 }( [  m" G

1. <div id="app">
   
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   
3. </div>
     S' l4 k7 J  H4 p( s3 ~+ ~; j* P3 G
4. 
   
5. <script>
   
6. Vue.directive('runoob', function (el, binding) {
   
7.     // 简写方式设置文本及背景颜色
   9 \9 i: L3 g- L" D
8.     el.innerHTML = binding.value.text
   4 n+ i+ Y2 O7 q6 `  p. ~5 l  a( f
9.     el.style.backgroundColor = binding.value.color
   7 \  X, _3 u, X+ N6 [  g: D
10. })
    0 j( t" n# T" M: Q0 z5 F/ g2 F( m
11. new Vue({
    
12.   el: '#app'
    
13. })
    ! V9 z4 `. J4 P1 w  r8 i& n1 e
14. </script>

复制代码

6 v: @. c3 M$ a+ @7 K

6 I3 Y# g0 L, F; ^' k0 U/ U