Vue.js 自定义指令

admin

  C8 J. c2 c8 `, O" r  Y

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

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

实例

) D& T6 S% V6 L7 c. S

1. <div id="app">
   
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   
3.     <input v-focus>
   
4. </div>
   - Y; {, G4 m  |! f% z2 l0 d
5. 
   
6. <script>
   
7. // 注册一个全局自定义指令 v-focus
   & p; ]. }3 v8 U+ e+ c9 \
8. Vue.directive('focus', {
   ' g8 @* l2 y& p: d3 Y* \# [. H
9.   // 当绑定元素插入到 DOM 中。
   
10.   inserted: function (el) {
    7 E6 {  j, s3 ^, k' S; w
11.     // 聚焦元素
    
12.     el.focus()
    
13.   }
    
14. })
    & Y* _+ t  L# I- R. T2 Z
15. // 创建根实例
    ! i1 V) O  q+ |) X
16. new Vue({
    , ?+ i4 O* L" }8 P, p! R
17.   el: '#app'
    ( e0 _, L3 i% c1 M5 d7 Z
18. })
    
19. </script>

复制代码

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

实例
0 q! w# i( M: V- K4 Q) ]; g

1. <div id="app">
     j7 o) s+ W& f
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   $ n5 F( a0 D7 h) W
3.   <input v-focus>
   
4. </div>
   , Z! n1 v+ W9 b  `* Q
5. 
   
6. <script>
   # O% ^7 y( ]* I$ k% O
7. // 创建根实例
   
8. new Vue({
   4 b1 C1 u' j( i9 }. Q+ h5 V# N2 l4 Q
9.   el: '#app',
   
10.   directives: {
    3 v+ a' t9 l  |) R! E
11.     // 注册一个局部的自定义指令 v-focus
    
12.     focus: {
    
13.       // 指令的定义
    
14.       inserted: function (el) {
    
15.         // 聚焦元素
    
16.         el.focus()
    
17.       }
    
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 }。
    ( b& E6 a( L. T/ f5 d
• vnode: Vue 编译生成的虚拟节点。
• oldVnode: 上一个虚拟节点，仅在 update 和 componentUpdated 钩子中可用。
  

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

实例
% ^# }- G* G% n; F* t

1. <div id="app"  v-runoob:hello.a.b="message">
   
2. </div>
   
3. 
   
4. <script>
   
5. Vue.directive('runoob', {
   ) l& E. T8 Q; X# O) o6 @. |
6.   bind: function (el, binding, vnode) {
   
7.     var s = JSON.stringify
   ; }8 |2 K) c  f& D' p) I. D5 ?$ _
8.     el.innerHTML =
   ( {$ p9 S5 F, p* t5 G. l$ m& n
9.       'name: '       + s(binding.name) + '<br>' +
   $ R* ~0 D" [. x
10.       'value: '      + s(binding.value) + '<br>' +
    . q; P0 }. g2 {1 `' Y- [
11.       'expression: ' + s(binding.expression) + '<br>' +
    ' E  E( W* L# {; \$ v
12.       'argument: '   + s(binding.arg) + '<br>' +
    0 T1 Q$ O( \0 c2 }$ g% h
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    $ T% R5 ?2 r% a3 s/ O0 O# |
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    . Z2 K4 E5 C$ r2 J
15.   }
    9 t' V0 n0 T; q$ l1 X
16. })
    1 X$ B" H: [8 J5 N! Q/ D# M" N
17. new Vue({
    
18.   el: '#app',
    0 G# b) K! P1 r( \, j1 F* J
19.   data: {
    
20.     message: '菜鸟教程!'
    ! }. I- |  F2 e4 }: {1 Y  I
21.   }
    
22. })
    
23. </script>

复制代码

有时候我们不需要其他钩子函数，我们可以简写函数，如下格式：
8 C' Y, i$ P2 E: N) n9 ^3 {* [. l

1. Vue.directive('runoob', function (el, binding) {
   
2.   // 设置指令的背景颜色
   , S3 S! j6 \/ T( F& X; z% w
3.   el.style.backgroundColor = binding.value.color
   % J- e  F1 r6 Y- o: f9 i! B- m0 A& n
4. })

复制代码

% [( x1 r" z- n* v5 H/ @/ ?. O0 l

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

实例
! ~4 u- u  `3 P# \
- o* o0 C+ r" N" k2 L7 b

1. <div id="app">
   
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   
3. </div>
   ) M/ c9 s! R% l  B. Z; Y
4. 
   4 P5 g6 G! i# ?! r1 x" p9 M
5. <script>
   
6. Vue.directive('runoob', function (el, binding) {
   
7.     // 简写方式设置文本及背景颜色
   
8.     el.innerHTML = binding.value.text
   5 P- v7 y, j5 Q% m
9.     el.style.backgroundColor = binding.value.color
   ( B2 W: k2 K8 {. }, F1 t, t
10. })
    : T/ x4 F6 n; Z- b( L2 u
11. new Vue({
    , X) }$ R8 T" Z  d$ e6 Z
12.   el: '#app'
    9 t% v8 y& q. a' n
13. })
    
14. </script>

复制代码

# A$ O4 v' U4 \; V+ H" E7 A7 w