Vue.js 自定义指令

admin

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

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

实例

3 n7 P7 O5 P* @% L4 `

1. <div id="app">
   6 T0 I6 Q8 [$ X  F) T  x) A
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   - F6 \/ k- L* G3 T8 j8 n* L) S
3.     <input v-focus>
     M$ z( w! d& @  J( v
4. </div>
   , L) Q" O2 @* p) h" D: @7 {3 C
5. 
   5 @  H/ v! e- m  X5 d  \& b  w" Q5 k
6. <script>
   ( i( X& N* j6 V! M2 v  d
7. // 注册一个全局自定义指令 v-focus
   
8. Vue.directive('focus', {
   
9.   // 当绑定元素插入到 DOM 中。
   9 e* s* f  k1 L/ m
10.   inserted: function (el) {
    ; _, ?) }9 Y/ M) s& `5 l
11.     // 聚焦元素
    3 y7 O; ]4 N) ~  l8 A- n
12.     el.focus()
    : S+ O6 h  ^2 f( h
13.   }
    
14. })
    
15. // 创建根实例
    * G3 ]  [- h( P5 J
16. new Vue({
    4 L0 D  n+ @6 f* [6 ^0 }
17.   el: '#app'
    : k5 r/ @( I! J6 O( c
18. })
    9 E. V  w4 R8 `1 f4 Q* @9 X1 j, c
19. </script>

复制代码

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

实例

1. <div id="app">
   3 ^3 g5 L& [3 J5 w
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   9 m5 x5 d3 k5 j5 b
3.   <input v-focus>
   
4. </div>
   . U  o5 j- x) v7 Z# `3 I+ B! V
5. 
   
6. <script>
   
7. // 创建根实例
   , m' D" D+ u$ |, a2 l- l
8. new Vue({
   
9.   el: '#app',
   
10.   directives: {
    ! L5 E2 p: T( |; h9 h
11.     // 注册一个局部的自定义指令 v-focus
    
12.     focus: {
    9 G/ L# p& F2 f+ h4 d( X# i
13.       // 指令的定义
    : D* ]6 Z! {/ r( O2 ]
14.       inserted: function (el) {
    ! x5 H) K5 g* Q6 |% ^
15.         // 聚焦元素
    ; ^: m; S+ k/ r. N* A- H
16.         el.focus()
    ; _. b8 _8 v3 x: ^# K0 ~! f8 E
17.       }
    
18.     }
    
19.   }
    
20. })
    
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 }。
    & s& D- o- d+ R, `& _2 _6 i
• vnode: Vue 编译生成的虚拟节点。
• oldVnode: 上一个虚拟节点，仅在 update 和 componentUpdated 钩子中可用。
  

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

实例

1. <div id="app"  v-runoob:hello.a.b="message">
   
2. </div>
   * v" X) H0 z) l1 B6 m4 b
3. 
   6 Z/ b7 J" d& L8 I0 n0 U! X
4. <script>
   6 F9 t# B  e& e$ @
5. Vue.directive('runoob', {
   ' U/ a* C& v' ^& A) K* K# c
6.   bind: function (el, binding, vnode) {
   
7.     var s = JSON.stringify
   
8.     el.innerHTML =
   
9.       'name: '       + s(binding.name) + '<br>' +
   
10.       'value: '      + s(binding.value) + '<br>' +
    0 w% |/ ]2 d. k0 z" i! r  Q4 t& G
11.       'expression: ' + s(binding.expression) + '<br>' +
    $ L) v- v6 a0 y# w0 C" t" z9 p5 T
12.       'argument: '   + s(binding.arg) + '<br>' +
    ' x5 O+ V6 D6 a' T: @9 _4 D% a* g& b
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    3 @0 H  Q- ^* n& X% {) |! a, n
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    
15.   }
    
16. })
    ' @5 _/ p% o3 l( C
17. new Vue({
    ) B: T. f4 }* R8 E- V: ?
18.   el: '#app',
    
19.   data: {
    . @/ _; |$ @/ A# h: A3 S
20.     message: '菜鸟教程!'
    
21.   }
    + t! ~0 s: M$ c8 u* \9 j+ P
22. })
    
23. </script>

复制代码

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

1. Vue.directive('runoob', function (el, binding) {
   / x% n' |: o8 a. Z( }" W) t6 ~; k
2.   // 设置指令的背景颜色
   6 E5 j  j* B) g, B
3.   el.style.backgroundColor = binding.value.color
   
4. })

复制代码

  V7 \! J# n, e. S& |
1 x" s, X1 U3 x# x  J" F# J

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

实例

1. <div id="app">
   
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   
3. </div>
   
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. })
    
11. new Vue({
    
12.   el: '#app'
    
13. })
    
14. </script>

复制代码

+ X+ b) l/ V5 S
2 }% F8 `/ |+ z4 N" v& |
6 S; W1 Y2 v) p' m: w, r