Vue.js 自定义指令

admin

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

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

实例

1. <div id="app">
   
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   * V9 ]* o* F5 \' V* U
3.     <input v-focus>
   
4. </div>
   
5. 
   2 R$ O/ @+ y5 I  x  h, y; t2 F
6. <script>
   
7. // 注册一个全局自定义指令 v-focus
   
8. Vue.directive('focus', {
   
9.   // 当绑定元素插入到 DOM 中。
   
10.   inserted: function (el) {
    6 q* x; B5 f' h
11.     // 聚焦元素
    7 M& a2 a  d: m+ Z5 f( L* ^
12.     el.focus()
    4 l9 h9 ?$ r2 B
13.   }
    ( X* r+ V5 Q+ Y  Q6 m/ U4 G
14. })
    + c4 @7 B- p3 G3 v
15. // 创建根实例
    6 }3 _) T$ T, c9 [; `; l0 f6 C
16. new Vue({
    % l6 y! J' q  k* B# @+ M
17.   el: '#app'
    
18. })
    
19. </script>

复制代码

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

实例
* ^3 L) Q0 n$ f6 E6 ^% E, s0 e+ q
0 V) }+ G1 p! C- p$ Z! `. V1 _$ N

1. <div id="app">
   5 m2 }4 R2 X: |6 ]9 W
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   7 Y+ ~6 L  g: f8 ~6 R( Z4 ~
3.   <input v-focus>
   
4. </div>
   5 K2 q4 d+ K6 j( q8 U9 L
5. 
   
6. <script>
   3 f0 L! r# |+ z& P+ w+ {9 `
7. // 创建根实例
   
8. new Vue({
   1 t0 W; ^) s+ p6 X; y
9.   el: '#app',
   
10.   directives: {
    
11.     // 注册一个局部的自定义指令 v-focus
    
12.     focus: {
    
13.       // 指令的定义
    2 t) ?: N7 U, r, E/ c
14.       inserted: function (el) {
    
15.         // 聚焦元素
    
16.         el.focus()
    - }: |; F$ T5 Y" {7 \' N3 I8 \
17.       }
    9 D; m$ ]: A+ b& V! W; ?1 g, D
18.     }
    / _3 p5 a* H/ l6 l9 {+ G: Q
19.   }
    
20. })
    
21. </script>

复制代码

钩子钩子函数

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

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

钩子函数参数

钩子函数的参数有：

• 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 钩子中可用。
  & B! ^  K$ Y: N8 v

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

实例
3 A  y5 F* \, H0 I  T6 ~
1 {6 ?7 @. h7 Q6 j- j

1. <div id="app"  v-runoob:hello.a.b="message">
   5 U4 Y4 ~1 z& b+ n" X& B' Z) s  M& ~
2. </div>
   6 ^6 o4 L# d7 C" l. S- O3 v! f4 l
3. 
   
4. <script>
   
5. Vue.directive('runoob', {
   7 X& o- Z. G! }& l& V4 I
6.   bind: function (el, binding, vnode) {
   
7.     var s = JSON.stringify
   , o* x' p9 \6 L# o# w2 E" z4 g
8.     el.innerHTML =
   
9.       'name: '       + s(binding.name) + '<br>' +
   
10.       'value: '      + s(binding.value) + '<br>' +
    
11.       'expression: ' + s(binding.expression) + '<br>' +
    ! _6 Z6 j( N; b1 L  U( h
12.       'argument: '   + s(binding.arg) + '<br>' +
    
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    2 q; Q* E- D) |% g! y1 v
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    6 N+ K# y1 P4 K
15.   }
    
16. })
    
17. new Vue({
    
18.   el: '#app',
    
19.   data: {
    
20.     message: '菜鸟教程!'
    2 I# J, |+ h1 _* F
21.   }
    
22. })
    2 U. L/ Q# X  O& ^8 y
23. </script>

复制代码

有时候我们不需要其他钩子函数，我们可以简写函数，如下格式：
, J5 o4 u$ X9 k2 {

1. Vue.directive('runoob', function (el, binding) {
   9 [9 \2 a9 M) @- W
2.   // 设置指令的背景颜色
   
3.   el.style.backgroundColor = binding.value.color
   : W7 d7 ^  E* u* Z4 w
4. })

复制代码

: [4 \* [3 P0 D/ a. H, l6 Z

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

实例
" ^" e3 q+ n) A# o! |, D/ a

1. <div id="app">
   
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   : ]' }5 @; F! B4 j! o# p
3. </div>
   , a' |" ^0 M7 h: f4 M! ~1 m$ t
4. 
   : O7 s+ j  N; j1 e
5. <script>
   ' L1 o  O# u; l3 j
6. Vue.directive('runoob', function (el, binding) {
   
7.     // 简写方式设置文本及背景颜色
   
8.     el.innerHTML = binding.value.text
   
9.     el.style.backgroundColor = binding.value.color
   ) t, l/ i. ~% w/ @
10. })
      O# B# o) s' |4 T! m) ^
11. new Vue({
    
12.   el: '#app'
    
13. })
    
14. </script>

复制代码

1 M& |0 w$ h! h: j1 H' Y' _& @
1 X" F2 d7 [' W