Vue.js 自定义指令

admin

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

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

实例

0 Z' T* ?3 S) Z$ f

1. <div id="app">
   5 k) ^) [/ j+ q  i4 H
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   5 l8 [0 X0 j9 o* {0 i4 Q- j7 N
3.     <input v-focus>
   
4. </div>
   : ]$ u' d9 k8 g# I4 n1 ^1 U
5. 
   
6. <script>
   # {( _1 e; h' W4 s6 n
7. // 注册一个全局自定义指令 v-focus
   : e! `) L2 j! Q: O7 [
8. Vue.directive('focus', {
   % W; c9 r$ n0 N3 ?0 j
9.   // 当绑定元素插入到 DOM 中。
   5 Z  M8 ]: D7 h/ \
10.   inserted: function (el) {
    
11.     // 聚焦元素
    
12.     el.focus()
    
13.   }
    2 ?; K- D9 q0 R; ]% `, C3 V" e
14. })
    
15. // 创建根实例
    - r0 q$ s# R/ K$ S
16. new Vue({
    ( i% T& a* k% y) ?- ]) G
17.   el: '#app'
    
18. })
    5 {* ?6 v5 W& w2 A. g, Q
19. </script>

复制代码

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

实例
0 T  g, a1 d9 ^) |7 P- ~

1. <div id="app">
   1 c+ w9 e( ?( [  @4 m- E
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   
3.   <input v-focus>
   ' H! D  D$ Z1 r8 N, m/ r, F: ?
4. </div>
   % L1 o' s9 ]4 E& Q$ E$ r
5. 
   
6. <script>
   6 N# s! e6 E$ E; l& s
7. // 创建根实例
   6 _" ~: g0 G% h; L$ h) A
8. new Vue({
   
9.   el: '#app',
   
10.   directives: {
    
11.     // 注册一个局部的自定义指令 v-focus
    
12.     focus: {
    : A8 z0 X( {2 h- R
13.       // 指令的定义
    . X+ V! y1 e+ n; d5 u; {8 I
14.       inserted: function (el) {
    4 r+ T4 r0 U" G: W4 q0 X7 F3 u; Z
15.         // 聚焦元素
    , n' \3 }  f# r
16.         el.focus()
    # T4 p3 p2 C4 A" C4 a8 {
17.       }
    
18.     }
    ! o) ?# {$ n; [/ [$ X  |8 Y
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 }。
    / R+ T4 Y( g- e* J
• vnode: Vue 编译生成的虚拟节点。
• oldVnode: 上一个虚拟节点，仅在 update 和 componentUpdated 钩子中可用。
  ! b) C: Q6 R% v& d2 S) o) P/ o; E

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

实例

1. <div id="app"  v-runoob:hello.a.b="message">
   # B8 I. g* z. u# ?5 w$ {; W$ ?
2. </div>
   
3. 
   
4. <script>
   
5. Vue.directive('runoob', {
   
6.   bind: function (el, binding, vnode) {
   # \+ w3 _1 p0 S7 k: Q1 {
7.     var s = JSON.stringify
   # x/ w! ?/ O- u6 r% l
8.     el.innerHTML =
   0 G  u  z6 y$ g- [8 @
9.       'name: '       + s(binding.name) + '<br>' +
   
10.       'value: '      + s(binding.value) + '<br>' +
    
11.       'expression: ' + s(binding.expression) + '<br>' +
    
12.       'argument: '   + s(binding.arg) + '<br>' +
    9 E/ A) U/ A" A
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    
15.   }
    
16. })
    
17. new Vue({
    & B( v7 C2 k! M% Z' @1 i
18.   el: '#app',
    
19.   data: {
    1 V+ F2 S; Z" t. o: J/ S( C# g8 K
20.     message: '菜鸟教程!'
    
21.   }
    # K7 k' }* J, z4 L7 n+ C7 {
22. })
    
23. </script>

复制代码

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

1. Vue.directive('runoob', function (el, binding) {
   1 ^3 n8 o$ N0 [# f" V9 y& g
2.   // 设置指令的背景颜色
   - m% f6 V% \0 i8 m
3.   el.style.backgroundColor = binding.value.color
   + Q" T" m9 S8 r" H
4. })

复制代码

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

实例

; U- s$ f* t3 _# k

1. <div id="app">
   % v1 h# m  B2 M4 J' y" `1 k8 T
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   " y6 f3 ~) w0 j- r  W! F! Y
3. </div>
   
4. 
   ' i) ?& v& @$ g4 G6 J+ p( d
5. <script>
   
6. Vue.directive('runoob', function (el, binding) {
   7 f1 o" Z) |& n  @
7.     // 简写方式设置文本及背景颜色
   
8.     el.innerHTML = binding.value.text
   
9.     el.style.backgroundColor = binding.value.color
   
10. })
    ( l7 Q7 A, N" v: i
11. new Vue({
    5 H+ U4 M. @+ I
12.   el: '#app'
    
13. })
    - `( [2 a: a8 L$ r
14. </script>

复制代码

. v! R) b& F" H8 p3 c/ ]# w# n