Vue.js 自定义指令

admin

1 |  R4 l: S+ [5 y" y

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

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

实例
$ }$ V7 m7 W) D( P+ W) u
- ]$ H1 ~) \5 G4 r

1. <div id="app">
   ! p" R- D  T& F6 J/ W- }+ n9 C  Q
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   
3.     <input v-focus>
   
4. </div>
   2 H: G" n# ?# f
5. 
   6 w& G! S- v) q. m' o" b
6. <script>
   
7. // 注册一个全局自定义指令 v-focus
   ; ?# U1 X# H+ w( h/ A
8. Vue.directive('focus', {
   / a. q4 f) z% o0 p
9.   // 当绑定元素插入到 DOM 中。
   0 }5 e; E; q$ Y5 {7 e
10.   inserted: function (el) {
    
11.     // 聚焦元素
    ! x; W3 |& P% F) q, R. d$ o, }" V
12.     el.focus()
    9 D( w( l9 J6 A. k( Y
13.   }
    
14. })
    $ i  V# p. j" L- S& P& G
15. // 创建根实例
    
16. new Vue({
    
17.   el: '#app'
    : G: r) u- A8 c. E4 J. G
18. })
    
19. </script>

复制代码

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

实例

1. <div id="app">
   8 L, k. X& F7 E/ l/ {9 K" a
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   4 Y" l, n4 ^" U- C5 T4 ~
3.   <input v-focus>
   $ I, G6 F& C( C
4. </div>
   
5. 
   
6. <script>
   * B, R6 [4 e! E  z: a, S
7. // 创建根实例
   * [. W1 ^/ ?1 h( z6 Z% ?
8. new Vue({
   6 `% A  U2 i4 g$ e7 R" ^
9.   el: '#app',
   & s, O1 ?, H9 G* f: s" G; F
10.   directives: {
    ) C: @9 k: P  o
11.     // 注册一个局部的自定义指令 v-focus
    
12.     focus: {
    
13.       // 指令的定义
    ; j( \+ E0 a1 O' P; a* R$ P: F
14.       inserted: function (el) {
    * P1 [" Q& a% {5 d  ~. _
15.         // 聚焦元素
    
16.         el.focus()
    
17.       }
    
18.     }
    
19.   }
    
20. })
    ; f; Q+ X% Y2 n# V) j- _, p" G
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 钩子中可用。
  

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

实例

: C$ I1 L2 E$ E" S1 Q

1. <div id="app"  v-runoob:hello.a.b="message">
   
2. </div>
   ( g- O  X. \6 |; L
3. 
   $ o- m+ I; x2 D! U" t
4. <script>
   
5. Vue.directive('runoob', {
   
6.   bind: function (el, binding, vnode) {
   # X$ ^7 k- i* k1 q- W
7.     var s = JSON.stringify
   ; R9 Y5 U1 o$ J5 u  h0 i& C$ s. {
8.     el.innerHTML =
   9 N$ z! B3 P  S4 G& s
9.       'name: '       + s(binding.name) + '<br>' +
   - i$ K% A  X1 I
10.       'value: '      + s(binding.value) + '<br>' +
    
11.       'expression: ' + s(binding.expression) + '<br>' +
    : d3 X7 d1 \# X  u
12.       'argument: '   + s(binding.arg) + '<br>' +
    
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    / z% F" p; q! L; Z
15.   }
    
16. })
    
17. new Vue({
    
18.   el: '#app',
    - B- G+ H5 }8 c5 `4 R: A8 m
19.   data: {
    0 h+ A* ~: l9 O
20.     message: '菜鸟教程!'
    1 Z- V. p2 v- ~
21.   }
    % ~# r7 U* k3 Z2 I8 X! e- f
22. })
    
23. </script>

复制代码

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

1. Vue.directive('runoob', function (el, binding) {
   7 @! Q" e3 Z- ?( O' g7 P
2.   // 设置指令的背景颜色
   1 _$ `& |4 J9 J. D
3.   el.style.backgroundColor = binding.value.color
   ) ]. G: ~! Z. x  b3 l2 y: S& O
4. })

复制代码

. u$ i" g6 R- S' j/ |
+ B) x. c  ~0 Y5 K  x$ C5 i

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

实例
; ^' K7 v0 k8 }' O3 A

1. <div id="app">
   4 a- }4 ?2 ^, g0 R9 y' q  y# y+ s/ G
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   / F' f% m! g% M# z7 s  F
3. </div>
     \! r! H- g3 {% G: d/ G! ]/ g
4. 
   
5. <script>
   ) N0 \/ r5 r+ H2 J. n! j
6. Vue.directive('runoob', function (el, binding) {
   
7.     // 简写方式设置文本及背景颜色
   ! I" Y2 j% N- O& w/ e3 ]  |1 }6 I: z
8.     el.innerHTML = binding.value.text
   5 F3 `! Z, M6 q  w9 F
9.     el.style.backgroundColor = binding.value.color
   
10. })
    ! Y* |8 u$ ], {$ z1 I. B: d2 ~2 T
11. new Vue({
    ( {! N# U+ G  q) V( {
12.   el: '#app'
    * {5 m. E% R* k# Z2 R
13. })
    ' g+ W8 R- L& o! Z6 Y6 q
14. </script>

复制代码

7 z) O. `4 `4 f

' y6 A* ?) N! K' B1 {