Vue.js 自定义指令

admin

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

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

实例
* X. y! z1 b/ ^# i: I; v; F
9 ^5 d; _5 W' L& h* ^4 S3 }

1. <div id="app">
   
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   
3.     <input v-focus>
   . b* p( }1 q- v8 Y
4. </div>
   7 q, t8 M7 u2 ^3 ?: P: i
5. 
   
6. <script>
   " i/ K7 g" j6 J; p" Y! N2 W( }; _
7. // 注册一个全局自定义指令 v-focus
   & q1 x' a0 P+ ], W* U1 y; b! w
8. Vue.directive('focus', {
   & l+ V5 ]/ I: V; J
9.   // 当绑定元素插入到 DOM 中。
   ! o! Y3 Z. T7 d/ ]" p% K
10.   inserted: function (el) {
    - U8 S9 @; U9 D/ u, \
11.     // 聚焦元素
    
12.     el.focus()
    % J* I: w% ]0 B3 i
13.   }
    
14. })
      {$ S% t# \  O( i* b) e7 a+ {
15. // 创建根实例
    
16. new Vue({
    
17.   el: '#app'
    
18. })
    $ J/ v3 B5 m4 \7 Y4 O, a4 W
19. </script>

复制代码

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

实例

( H0 X+ T( Q8 ^" y5 l

1. <div id="app">
   ) M# H* A+ x& r: d" Y6 a
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   + H* d$ V! P% i$ v7 S
3.   <input v-focus>
   2 [8 U3 k" m, W' t
4. </div>
   ' [" f; A& u, ^9 r0 h1 Z
5. 
   
6. <script>
   
7. // 创建根实例
   
8. new Vue({
   
9.   el: '#app',
   * y; C0 F/ `( d) C
10.   directives: {
      E" {! U. B% e  |1 Z: P
11.     // 注册一个局部的自定义指令 v-focus
    
12.     focus: {
    
13.       // 指令的定义
    
14.       inserted: function (el) {
    ! D4 M, i# \- n/ B; Y: r3 N
15.         // 聚焦元素
    
16.         el.focus()
    9 g# g1 z6 X3 Q) S" y; z
17.       }
    8 ~! r6 ^# L6 C, z7 E2 a
18.     }
    
19.   }
    
20. })
    ' t* a$ m$ N" H. \; g
21. </script>

复制代码

钩子钩子函数

指令定义函数提供了几个钩子函数（可选）：

• bind: 只调用一次，指令第一次绑定到元素时调用，用这个钩子函数可以定义一个在绑定时执行一次的初始化动作。
• inserted: 被绑定元素插入父节点时调用（父节点存在即可调用，不必存在于 document 中）。
• update: 被绑定元素所在的模板更新时调用，而不论绑定值是否变化。通过比较更新前后的绑定值，可以忽略不必要的模板更新（详细的钩子函数参数见下）。
• componentUpdated: 被绑定元素所在模板完成一次更新周期时调用。
• unbind: 只调用一次， 指令与元素解绑时调用。
  
  5 d& d0 y) h) [+ r

钩子函数参数

钩子函数的参数有：

• 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 w  N/ }4 g% q7 N! G' w
• vnode: Vue 编译生成的虚拟节点。
• oldVnode: 上一个虚拟节点，仅在 update 和 componentUpdated 钩子中可用。
  

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

实例

  h' @7 }5 `+ Y; ]4 R0 T* Y* S5 h

1. <div id="app"  v-runoob:hello.a.b="message">
   , T" ~# K. C0 T
2. </div>
   
3. 
   7 ~4 p! W3 S3 q) y0 c( z7 R- q
4. <script>
   
5. Vue.directive('runoob', {
   4 |7 ?* j2 Z  t% C& A: ]
6.   bind: function (el, binding, vnode) {
   
7.     var s = JSON.stringify
   ; r; k' {6 ?! i2 f5 L9 s$ O; @
8.     el.innerHTML =
   ; M. Y' {# g; o: B7 K! X
9.       'name: '       + s(binding.name) + '<br>' +
   
10.       'value: '      + s(binding.value) + '<br>' +
    % g, M  S& U7 P& y5 f5 c, B
11.       'expression: ' + s(binding.expression) + '<br>' +
    ! B$ a3 @: K' }3 B# r( ~3 Z2 \+ ?/ j
12.       'argument: '   + s(binding.arg) + '<br>' +
    
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    ( `! x) _0 U. c& }9 k4 Z
15.   }
    : [# G9 T6 h' b
16. })
    
17. new Vue({
    2 ^/ |+ V" A7 z2 T1 G  ~' n# J5 l
18.   el: '#app',
    
19.   data: {
    
20.     message: '菜鸟教程!'
    : w, F5 R1 y; ?, q, I" U) L( b: k
21.   }
    
22. })
    9 P6 I- \5 J. Y% ^5 I
23. </script>

复制代码

有时候我们不需要其他钩子函数，我们可以简写函数，如下格式：
; ^) R2 D  R5 P; R

1. Vue.directive('runoob', function (el, binding) {
   / v4 A0 u4 u! ?; Z/ g# z+ }
2.   // 设置指令的背景颜色
   6 m7 h7 p. L3 _3 J
3.   el.style.backgroundColor = binding.value.color
   
4. })

复制代码

' y$ ^5 T7 S2 q  G5 W- o( J! O/ W8 r

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

实例

2 w* x" u# G' \! {

1. <div id="app">
   
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   
3. </div>
   
4. 
   
5. <script>
   
6. Vue.directive('runoob', function (el, binding) {
   
7.     // 简写方式设置文本及背景颜色
   
8.     el.innerHTML = binding.value.text
   & u5 a3 s! d# @; |, g& d
9.     el.style.backgroundColor = binding.value.color
     U# ^- S* x8 B+ R, p2 \
10. })
    
11. new Vue({
    
12.   el: '#app'
    9 f, M2 F* V9 f+ H7 f
13. })
    0 t' P; ~# n% o( ]& G0 n
14. </script>

复制代码

0 s1 V* r& L* H7 O4 ~