Vue.js 自定义指令

admin

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

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

实例
. t+ r  x, q, F7 q/ @
! T4 o* p. M& M/ h* {9 _

1. <div id="app">
   " @1 y* n2 v4 g5 L# V8 B
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   
3.     <input v-focus>
   % U6 w- w" V  K% f
4. </div>
   7 {+ w, F6 R" X2 M, L; `6 S7 `1 @
5. 
     w' w. X! Z! u9 `9 d, P+ V
6. <script>
   
7. // 注册一个全局自定义指令 v-focus
   
8. Vue.directive('focus', {
   3 ?: T1 g% e. b! C6 j3 l
9.   // 当绑定元素插入到 DOM 中。
   
10.   inserted: function (el) {
    $ |; w' o% W' t/ @! G5 L) J7 ^# E
11.     // 聚焦元素
    
12.     el.focus()
    - d9 _$ Y8 x+ R8 Q0 t- G) i" [: D
13.   }
    
14. })
    
15. // 创建根实例
    
16. new Vue({
    0 h# n. @* U5 M9 S0 Y% H  l
17.   el: '#app'
    
18. })
    
19. </script>

复制代码

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

实例

0 j4 r1 e! w( a# w1 K6 A

1. <div id="app">
   
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   1 w  A9 q8 A) e; G- D* s7 _" R6 D
3.   <input v-focus>
   
4. </div>
   1 F$ h: b* h. {0 q# T) _& |# [2 G
5. 
   
6. <script>
   9 O7 l0 p4 N1 z% b' E# [$ T2 e
7. // 创建根实例
   
8. new Vue({
   
9.   el: '#app',
   
10.   directives: {
    
11.     // 注册一个局部的自定义指令 v-focus
    . S( T3 @* m5 ?. h$ ~, f* y$ u
12.     focus: {
    
13.       // 指令的定义
    
14.       inserted: function (el) {
    + C* _% I- e; B% j8 j/ v1 s6 \0 j
15.         // 聚焦元素
    
16.         el.focus()
    $ p3 l$ N) i6 w4 Z
17.       }
    , W. k; T  F) E0 P, ?: L% ~" S
18.     }
    
19.   }
    
20. })
    
21. </script>

复制代码

钩子钩子函数

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

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

钩子函数参数

钩子函数的参数有：

• 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 }。
    % E% Y2 G2 M; J$ |: L4 K
• vnode: Vue 编译生成的虚拟节点。
• oldVnode: 上一个虚拟节点，仅在 update 和 componentUpdated 钩子中可用。
  

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

实例

1. <div id="app"  v-runoob:hello.a.b="message">
   
2. </div>
   " x5 j5 X7 |! \+ {; F
3. 
   6 t* r9 o/ u0 o8 g" V
4. <script>
   
5. Vue.directive('runoob', {
   
6.   bind: function (el, binding, vnode) {
   
7.     var s = JSON.stringify
   
8.     el.innerHTML =
   
9.       'name: '       + s(binding.name) + '<br>' +
   # D( }# }% f7 w6 }1 A$ G6 D" a6 ]( Y
10.       'value: '      + s(binding.value) + '<br>' +
    
11.       'expression: ' + s(binding.expression) + '<br>' +
    
12.       'argument: '   + s(binding.arg) + '<br>' +
    " n5 C- Q3 G* h6 ?# M7 r7 o; B
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    ( P9 K7 u; S) _% ~5 f2 C
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    
15.   }
    % O: O- N4 i6 h4 Z5 t' f0 C
16. })
    
17. new Vue({
      a2 x( z5 Q' w; F1 {! z& h
18.   el: '#app',
    + e7 x; B5 z; N; ~! {2 Q1 f
19.   data: {
    
20.     message: '菜鸟教程!'
    
21.   }
    1 Z8 s; L  S1 ^
22. })
    - ]1 S$ K+ w6 i, y7 }% ]" h* G
23. </script>

复制代码

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

1. Vue.directive('runoob', function (el, binding) {
   
2.   // 设置指令的背景颜色
   6 K9 _3 |* c% {' G8 @
3.   el.style.backgroundColor = binding.value.color
   
4. })

复制代码

; N- d2 n1 p* L+ \# ^9 T7 z
4 G/ ~3 h7 \0 n& d

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

实例

4 p0 R( H% \2 O4 p

1. <div id="app">
   
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   
3. </div>
   3 e& \1 {+ e. m; h! g4 E$ C- j
4. 
   
5. <script>
   
6. Vue.directive('runoob', function (el, binding) {
   ! R: Q" {4 {2 z& d; b) O5 k! }2 X
7.     // 简写方式设置文本及背景颜色
   
8.     el.innerHTML = binding.value.text
   / _( J4 J( a4 C  W7 L0 g- I" @
9.     el.style.backgroundColor = binding.value.color
   - {6 T/ `2 \4 X
10. })
      ^$ i" }5 o1 @' \% L0 Z5 A/ }
11. new Vue({
    
12.   el: '#app'
    , ^8 D9 d" t' D
13. })
    
14. </script>

复制代码