Vue.js 自定义指令

admin

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

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

实例
9 U- \/ B: O# \4 l# U

1. <div id="app">
   
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   
3.     <input v-focus>
   
4. </div>
   
5. 
   ) i: \* T+ _5 _! m8 m2 z* Z1 ?
6. <script>
   
7. // 注册一个全局自定义指令 v-focus
   
8. Vue.directive('focus', {
   6 ]7 L/ @# {* B- I) `8 s+ A
9.   // 当绑定元素插入到 DOM 中。
   
10.   inserted: function (el) {
    + v% o' X( }) e' Y, O' C/ R/ X
11.     // 聚焦元素
    ! o# F6 d7 ]2 ^  v* z' A) O3 Y
12.     el.focus()
    
13.   }
    
14. })
    " b4 I; u" d$ t, I4 O+ h# _
15. // 创建根实例
    
16. new Vue({
    8 n  D* D5 a; k! F0 H, B
17.   el: '#app'
    4 [+ A, A5 U6 H) s$ D3 G
18. })
    
19. </script>

复制代码

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

实例
* r: x  {3 Y: @# R1 Q
1 r+ [6 }3 I% n

1. <div id="app">
   7 E7 C" D' _' ?& f+ u: U
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   & J' U$ x# P- P2 i
3.   <input v-focus>
   
4. </div>
   
5. 
   
6. <script>
   8 {% a2 w0 |2 U/ ?7 k
7. // 创建根实例
   1 I2 y' i( r8 i3 U: H+ C
8. new Vue({
   
9.   el: '#app',
   
10.   directives: {
    
11.     // 注册一个局部的自定义指令 v-focus
    , `* M8 e2 }3 [2 e1 V  o
12.     focus: {
    ' C6 \( J* C. E! B- {& R: Q5 d
13.       // 指令的定义
    3 E: x- Y$ B1 N
14.       inserted: function (el) {
      Y" |. j! }5 a& X3 z) h! l
15.         // 聚焦元素
    
16.         el.focus()
    - i$ O/ e% N6 z
17.       }
    
18.     }
    ) s& h) O. F6 r( x5 N
19.   }
    * \$ X+ ?6 G6 W% y) }! }) j! b$ h
20. })
    ' {& Z. |+ R  I" y, S( b
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 }。
    9 H( K) T) g# M
• vnode: Vue 编译生成的虚拟节点。
• oldVnode: 上一个虚拟节点，仅在 update 和 componentUpdated 钩子中可用。
  

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

实例
1 K& i, L; s: l) f0 E$ L5 G  a
$ L7 r" [+ ~" t' a* @0 W/ e

1. <div id="app"  v-runoob:hello.a.b="message">
   
2. </div>
   
3. 
   9 y) n7 U/ ~" G3 e  p
4. <script>
   " ]+ n% V. u% X; m% p
5. Vue.directive('runoob', {
   
6.   bind: function (el, binding, vnode) {
   % k" ~+ Z$ @/ j$ P' n! D
7.     var s = JSON.stringify
   9 r1 ~9 I; c8 V: d' Z
8.     el.innerHTML =
     s0 C, M7 I4 {( A& p& d0 n
9.       'name: '       + s(binding.name) + '<br>' +
   ( m6 w' R5 u2 K
10.       'value: '      + s(binding.value) + '<br>' +
    
11.       'expression: ' + s(binding.expression) + '<br>' +
    ( C  s# S& B7 b
12.       'argument: '   + s(binding.arg) + '<br>' +
    
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    
15.   }
    
16. })
    / i: r' O9 E3 J) }) X) k  Y
17. new Vue({
    
18.   el: '#app',
    ' ^; r3 Y# n7 D4 d
19.   data: {
    0 f% C) N- H* O  T$ M+ Q
20.     message: '菜鸟教程!'
    
21.   }
    
22. })
    
23. </script>

复制代码

有时候我们不需要其他钩子函数，我们可以简写函数，如下格式：
/ ?& V9 e. _+ R- c/ C! Y7 H

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

复制代码

6 Y! k# P# ^' ?: b4 M' B3 N0 C+ h

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

实例
9 f' w' w( S- }5 e

1. <div id="app">
   ) [/ f1 [. u+ o# Q- l
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   * t& ]7 s/ r( E- h
3. </div>
   4 L  T0 b( e4 v% ~
4. 
   
5. <script>
   
6. Vue.directive('runoob', function (el, binding) {
   0 _8 v% ]4 b* [: o6 [3 R
7.     // 简写方式设置文本及背景颜色
   4 K5 T/ x* G  e9 z$ t
8.     el.innerHTML = binding.value.text
   
9.     el.style.backgroundColor = binding.value.color
   4 z/ y4 k& K4 ]- K# A( t/ M
10. })
    , n) @5 S6 U. |- e1 Z1 q. ~
11. new Vue({
    
12.   el: '#app'
    ' \% A1 U  J& R9 }4 O* b3 ~  ^1 V; J
13. })
    ( r$ s) Z+ Q7 w6 Z" l  ~
14. </script>

复制代码

' R( Y% y) {% c# ^3 g- F: r