Vue.js 自定义指令

admin

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

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

实例

1 T1 v- W5 j& ]0 V. ?

1. <div id="app">
   
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   
3.     <input v-focus>
   ' O9 Z/ o# O/ O0 E7 [) D+ S+ C
4. </div>
   * D' ^# U% R7 }2 o8 O
5. 
   1 L) O* u+ k) t6 Y" j
6. <script>
   3 p' |6 A3 X! `8 O! Z" Y
7. // 注册一个全局自定义指令 v-focus
   ! ~2 i  ~, P; B5 l5 N3 r
8. Vue.directive('focus', {
   , V6 n. D, b6 ]. E8 M: }* L
9.   // 当绑定元素插入到 DOM 中。
   
10.   inserted: function (el) {
    8 g8 O' y: c7 B  t9 A( Q* W
11.     // 聚焦元素
    
12.     el.focus()
    
13.   }
    . _: ?3 u  ]  e2 o% I3 V
14. })
    
15. // 创建根实例
    
16. new Vue({
    % ^: M5 r; p9 Z9 I( Z
17.   el: '#app'
    
18. })
    
19. </script>

复制代码

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

实例
! S( r; h) Z& q6 [+ y) ?  S
2 I9 B, F6 X: K  ~" |# D7 ~7 ]

1. <div id="app">
   
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   
3.   <input v-focus>
   # j- m" [5 C5 S, C6 X# Z5 p9 S
4. </div>
   + R% L9 ]4 k. e; P2 q& V
5. 
   ( a- a! \8 w2 A7 m: V9 `5 }% a  ?. }
6. <script>
   & u1 V  ~. Y- w% ?( v
7. // 创建根实例
   0 U2 s1 @* F+ X1 A0 Q
8. new Vue({
   
9.   el: '#app',
   , C. O. O( R" n. o7 [# A* \: ?6 Z7 ^
10.   directives: {
    ( e& o1 G' |: O; q! Z4 H5 s2 D
11.     // 注册一个局部的自定义指令 v-focus
    / q9 ~; k+ T" p6 l9 N
12.     focus: {
    4 Z' F" p8 v+ p! H4 @7 [1 @7 i, K- `
13.       // 指令的定义
    
14.       inserted: function (el) {
    % p+ e+ V* ?( h: c
15.         // 聚焦元素
    
16.         el.focus()
    % r4 Y, Y2 _* D  K8 B$ b
17.       }
    
18.     }
    - x- T6 L6 r& W  M* o% V% }
19.   }
    
20. })
    
21. </script>

复制代码

钩子钩子函数

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

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

钩子函数参数

钩子函数的参数有：

• 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 钩子中可用。
  / W1 v- R8 N0 f0 |" o

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

实例
: o& Y9 V" _8 H6 u0 S' `
8 ~8 }4 {0 |) u- o3 Y8 T* L

1. <div id="app"  v-runoob:hello.a.b="message">
   , S9 N# p! @8 a$ E/ c- d
2. </div>
   8 h' L/ _+ \& T3 @" J/ Q5 o
3. 
     ~+ t7 n$ r* v; ]
4. <script>
   & H( c) J. ?5 n& J/ f
5. Vue.directive('runoob', {
   
6.   bind: function (el, binding, vnode) {
   
7.     var s = JSON.stringify
   ; O" q5 h* X  T' c
8.     el.innerHTML =
   ' N4 D0 r1 R# b2 j3 g/ N% A% j8 _
9.       'name: '       + s(binding.name) + '<br>' +
   / W# T* |  }# @. h7 q- n, f  a
10.       'value: '      + s(binding.value) + '<br>' +
    
11.       'expression: ' + s(binding.expression) + '<br>' +
    7 F  ]7 z- |. N" E
12.       'argument: '   + s(binding.arg) + '<br>' +
    * v+ b/ L0 `( _
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    , T7 `0 C7 T$ ?: N/ f
15.   }
    
16. })
    ) G# n; W5 ^& K; z# G" E2 ~
17. new Vue({
    
18.   el: '#app',
    9 V+ h2 U4 R  l( O2 X: H
19.   data: {
    1 `2 ^, L2 K& y3 _. a) ?8 v
20.     message: '菜鸟教程!'
    
21.   }
    1 U" [. N* D, h) _  E  ^# J2 e5 Z
22. })
    7 U* k7 `0 b) K! Z
23. </script>

复制代码

有时候我们不需要其他钩子函数，我们可以简写函数，如下格式：
- v5 \( S3 V$ p& f' X; V

1. Vue.directive('runoob', function (el, binding) {
   
2.   // 设置指令的背景颜色
   " {" M0 i+ H0 h$ r, l
3.   el.style.backgroundColor = binding.value.color
   
4. })

复制代码

, x' E  }" l1 a. [
! L! M# m) N. p' ^+ u6 N, V' Q2 p

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

实例
0 a/ X% u" I: U7 i  I! e
* p* t* R, I8 L( J; U% h/ T, x3 @  h

1. <div id="app">
   
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   4 J  d: A9 N2 B: D- q+ Z% \. ]4 H
3. </div>
   
4. 
   
5. <script>
   
6. Vue.directive('runoob', function (el, binding) {
   
7.     // 简写方式设置文本及背景颜色
   
8.     el.innerHTML = binding.value.text
   0 @. E/ }4 T, b6 B
9.     el.style.backgroundColor = binding.value.color
   8 J5 j: y2 q5 A3 ~8 E; @
10. })
    
11. new Vue({
    
12.   el: '#app'
    
13. })
    
14. </script>

复制代码

& x* f# ?/ f' b' r4 O
2 a! S" e( x# h, \4 n& A: l9 ~/ a$ v8 R