Vue.js 自定义指令

admin

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

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

实例
/ \4 N! j5 ?+ V' @
4 r' X/ g, w* `2 N6 q5 l  e

1. <div id="app">
   ! C8 |2 [- H% K
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   6 X1 @# o- t8 F2 z3 Q" F# x+ a6 [- [
3.     <input v-focus>
   * S3 K1 o* `: v
4. </div>
   8 B2 X3 S$ c% K+ a6 m0 s& b
5. 
   
6. <script>
   
7. // 注册一个全局自定义指令 v-focus
   
8. Vue.directive('focus', {
   ( m# |9 J3 X  O' u" N  G9 G
9.   // 当绑定元素插入到 DOM 中。
   
10.   inserted: function (el) {
    
11.     // 聚焦元素
    
12.     el.focus()
    $ K% S/ x/ g$ t2 [" f, }- }$ {  R
13.   }
    - n4 n2 j) }1 L3 [: R: P
14. })
    5 w) X/ \8 h6 |5 I1 a% e/ A1 @
15. // 创建根实例
    - F% K3 I* p8 P+ @9 B& F
16. new Vue({
    
17.   el: '#app'
    5 J8 h1 ]) V( A: b/ _) O0 J1 a
18. })
    9 q5 `7 \  {: |: I" m, h
19. </script>

复制代码

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

实例
. P5 V3 @( O& T8 p4 o. S

1. <div id="app">
   
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   
3.   <input v-focus>
   
4. </div>
   ) u% @) X) w, o% F! E1 v3 j
5. 
   
6. <script>
   
7. // 创建根实例
     N/ `' K9 i! N" ]/ q. j# o
8. new Vue({
   " z5 @* ]1 d% |7 c8 t# T
9.   el: '#app',
   
10.   directives: {
    
11.     // 注册一个局部的自定义指令 v-focus
    
12.     focus: {
    
13.       // 指令的定义
    # Q# a6 a9 S' x4 ~3 @
14.       inserted: function (el) {
    3 m; e& g& M1 u$ @5 A, ]! B: E
15.         // 聚焦元素
    
16.         el.focus()
    
17.       }
    
18.     }
    
19.   }
    ; Z% z3 ], W5 x" t6 a
20. })
    5 B! H' ^8 k- n  G7 C( ?+ X, F
21. </script>

复制代码

钩子钩子函数

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

• bind: 只调用一次，指令第一次绑定到元素时调用，用这个钩子函数可以定义一个在绑定时执行一次的初始化动作。
• inserted: 被绑定元素插入父节点时调用（父节点存在即可调用，不必存在于 document 中）。
• update: 被绑定元素所在的模板更新时调用，而不论绑定值是否变化。通过比较更新前后的绑定值，可以忽略不必要的模板更新（详细的钩子函数参数见下）。
• componentUpdated: 被绑定元素所在模板完成一次更新周期时调用。
• unbind: 只调用一次， 指令与元素解绑时调用。
  
  5 Q# i# A3 `; M. l# r( s* ]) x5 [

钩子函数参数

钩子函数的参数有：

• 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 D' r! u* s4 ~; Z
• vnode: Vue 编译生成的虚拟节点。
• oldVnode: 上一个虚拟节点，仅在 update 和 componentUpdated 钩子中可用。
  + i/ v) |/ M( s% y0 X% s2 W

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

实例

; {, W! W) n4 x4 z, Q

1. <div id="app"  v-runoob:hello.a.b="message">
   4 [! d. K- f! l) ~
2. </div>
   * X$ a+ L6 B7 w5 k  f! W) u: `% R
3. 
   
4. <script>
   
5. Vue.directive('runoob', {
   
6.   bind: function (el, binding, vnode) {
   4 p: J# l0 }$ R; w+ h/ D
7.     var s = JSON.stringify
   
8.     el.innerHTML =
   # z& {1 y2 A) D7 c
9.       'name: '       + s(binding.name) + '<br>' +
   
10.       'value: '      + s(binding.value) + '<br>' +
    
11.       'expression: ' + s(binding.expression) + '<br>' +
    
12.       'argument: '   + s(binding.arg) + '<br>' +
    
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    
15.   }
    
16. })
    
17. new Vue({
    3 k7 K8 C% t' J2 V7 n4 q# N
18.   el: '#app',
    $ l1 M7 o9 f. K9 [) n5 ~( M
19.   data: {
    
20.     message: '菜鸟教程!'
      w, i* H% T* v8 ~  z. K1 p
21.   }
    
22. })
    
23. </script>

复制代码

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

1. Vue.directive('runoob', function (el, binding) {
   - e5 K4 N# ~" _) J( |  g
2.   // 设置指令的背景颜色
   2 g0 p) I2 S3 \" B" u$ @+ ]; `
3.   el.style.backgroundColor = binding.value.color
   
4. })

复制代码

. a7 o5 v: t4 |) P3 Q

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

实例

1. <div id="app">
   
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   
3. </div>
   1 F. i2 r2 H- D  Q3 s! }* F, f
4. 
   
5. <script>
   
6. Vue.directive('runoob', function (el, binding) {
   $ i+ c5 ?' v1 ~8 W9 v
7.     // 简写方式设置文本及背景颜色
   
8.     el.innerHTML = binding.value.text
   
9.     el.style.backgroundColor = binding.value.color
   $ A( U% _* G- j8 i3 ~# y& Z7 c2 ^
10. })
    * {/ F8 x% ~9 j; u! F  n, Q
11. new Vue({
    # z- v2 e# d/ N) i. U
12.   el: '#app'
    
13. })
    8 o" A* y* d3 z% z
14. </script>

复制代码

, {0 @) o) ~+ E" f: I
4 Y) ~0 R- P8 G- a, d% Q% _
6 N9 o" j* }! t! z% D* Y