Vue.js 自定义指令

admin

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

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

实例

) [* [, b" t1 r4 m* F: {# K7 E

1. <div id="app">
   
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   5 ^  m" c$ X8 C
3.     <input v-focus>
   
4. </div>
   6 ~- Z8 W, j, K1 |2 F; I+ p, R8 K
5. 
   
6. <script>
   
7. // 注册一个全局自定义指令 v-focus
   
8. Vue.directive('focus', {
   0 F# ]- \/ F) X% x' ^* \% h
9.   // 当绑定元素插入到 DOM 中。
   
10.   inserted: function (el) {
    ) ^5 k! f( J+ Q& E2 Z2 O- P
11.     // 聚焦元素
    
12.     el.focus()
    
13.   }
    # c9 {# M1 G9 V- H
14. })
    
15. // 创建根实例
    + r9 w1 _8 g/ \+ R. L" L
16. new Vue({
    
17.   el: '#app'
    % E3 {4 y/ J, e$ d/ \
18. })
    
19. </script>

复制代码

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

实例

2 @" J% r' {2 p5 C, Z% N

1. <div id="app">
   / Q+ y. s2 M* ?
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   3 D  @: M& W" A
3.   <input v-focus>
   
4. </div>
   
5. 
   3 E2 ], _5 f) z9 M/ d6 ?
6. <script>
   
7. // 创建根实例
   
8. new Vue({
   : q3 r9 k: |- ~. \7 o2 R, K4 d7 n5 ?
9.   el: '#app',
   , x3 s1 n& c+ |* e( `
10.   directives: {
    & N1 M* Y  c2 }# s0 q- p
11.     // 注册一个局部的自定义指令 v-focus
    
12.     focus: {
    
13.       // 指令的定义
    
14.       inserted: function (el) {
    
15.         // 聚焦元素
    / J) d  m! `9 c5 K0 s% J- v8 f; f
16.         el.focus()
    
17.       }
    . M0 d" ~( ^* v
18.     }
    $ ?9 Y. I% ~3 S
19.   }
    
20. })
    3 Z8 x% A) s: m, ^
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 钩子中可用。
  ) y1 k5 x! P( U1 o

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

实例

% F# a2 \( a! K% ?2 Y/ k

1. <div id="app"  v-runoob:hello.a.b="message">
   
2. </div>
   
3. 
   ' u' u" I" {4 ]0 I0 x/ J
4. <script>
     l+ ~3 ?9 J" m6 L( N
5. Vue.directive('runoob', {
   - N4 ?/ z( e, P9 e3 z% w5 D
6.   bind: function (el, binding, vnode) {
   : F. ]2 i& C% }: ^: n+ q# h
7.     var s = JSON.stringify
   
8.     el.innerHTML =
   
9.       'name: '       + s(binding.name) + '<br>' +
   . V; v) y, E" s4 f
10.       'value: '      + s(binding.value) + '<br>' +
    
11.       'expression: ' + s(binding.expression) + '<br>' +
    # O+ Y- v  _: I! c
12.       'argument: '   + s(binding.arg) + '<br>' +
    + t+ Z8 Y' N6 R5 y* s* K: g) t3 Q
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    0 J- g5 d% m7 J$ h3 I* P  K; D$ R
15.   }
    
16. })
    
17. new Vue({
    
18.   el: '#app',
    " m8 l5 d; @7 w4 V% {
19.   data: {
    9 F' {; f& G! j1 R, T. P
20.     message: '菜鸟教程!'
    + W# @# X  [& {2 e
21.   }
    5 ?; J+ _9 d7 F% B
22. })
    
23. </script>

复制代码

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

1. Vue.directive('runoob', function (el, binding) {
   0 ^- f0 P/ e6 M8 c/ X2 H
2.   // 设置指令的背景颜色
   1 v0 X& v0 R1 _' |+ {; R
3.   el.style.backgroundColor = binding.value.color
   , `- ?. [6 ^# y+ f* s
4. })

复制代码

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

实例

. X( j1 `! }2 G- X& U1 h9 W2 G

1. <div id="app">
   , w! C& d  k3 K( _+ P+ B
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   ( d, ~: T8 r7 q& Z! M
3. </div>
   5 t0 i: H/ A+ @4 F
4. 
   
5. <script>
   
6. Vue.directive('runoob', function (el, binding) {
   
7.     // 简写方式设置文本及背景颜色
   
8.     el.innerHTML = binding.value.text
   
9.     el.style.backgroundColor = binding.value.color
   
10. })
    8 j+ ~/ ~4 t& W8 f+ D- q% @0 |# C
11. new Vue({
    
12.   el: '#app'
    0 Q* ]2 c( C  R
13. })
    ; x, A2 J9 g$ u
14. </script>

复制代码

& T, u" P" H$ P; i8 i