Vue.js 自定义指令

admin

1 w% O  V* `; p

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

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

实例
. \7 A: C$ b) S  j; @2 V$ ~- q

1. <div id="app">
   . [6 p! w4 t% n! u4 r$ `) z
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   
3.     <input v-focus>
   
4. </div>
   " G6 p+ C* I9 u: _/ J+ F
5. 
   
6. <script>
   % r2 k# ?! q8 t# ^  A2 O/ |
7. // 注册一个全局自定义指令 v-focus
   
8. Vue.directive('focus', {
   
9.   // 当绑定元素插入到 DOM 中。
   3 v7 X& W* X8 K& [0 I' t! {0 y
10.   inserted: function (el) {
    
11.     // 聚焦元素
    
12.     el.focus()
    
13.   }
    % W1 P# ^" I1 S( v1 _& T3 Z! I& s4 F
14. })
    
15. // 创建根实例
    1 {0 H" N) j" V
16. new Vue({
    
17.   el: '#app'
    8 J" V; g- [: _3 i. j0 `
18. })
    
19. </script>

复制代码

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

实例

1. <div id="app">
   
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   ' t- I: Y% V0 @/ Z- T/ k
3.   <input v-focus>
   9 ^  n% H+ R! d3 _3 f
4. </div>
   1 \0 J2 {- r; Z: w  x* u* _
5. 
   
6. <script>
   - O2 Z/ J: ~" ?& E1 V! ?
7. // 创建根实例
   7 i$ s1 H6 V* Y% E) U& J( U
8. new Vue({
   
9.   el: '#app',
   
10.   directives: {
    - y; j0 p, ?8 A5 \; L2 r, V
11.     // 注册一个局部的自定义指令 v-focus
    ( C6 r' i0 b9 F" V# F
12.     focus: {
    ; s9 m+ h4 V/ [" r4 z3 X4 X# {
13.       // 指令的定义
    + y+ j% L  z3 U$ k1 t  A' `
14.       inserted: function (el) {
    
15.         // 聚焦元素
    
16.         el.focus()
    ! W1 j$ R6 S# Z6 f
17.       }
    
18.     }
    
19.   }
    
20. })
    7 K7 ~; |0 C# j, o1 e. T8 F! R/ G3 h
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 }。
    + Z- c7 E: [/ Z+ ^3 O" y3 Y- v
• vnode: Vue 编译生成的虚拟节点。
• oldVnode: 上一个虚拟节点，仅在 update 和 componentUpdated 钩子中可用。
  

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

实例
7 d' ~5 Y: L- Y! p2 e  ^
, q4 t" O4 }( j: T- Z- m3 _

1. <div id="app"  v-runoob:hello.a.b="message">
   
2. </div>
   
3. 
   
4. <script>
   , k3 P# j1 O2 q! K0 J- u( t9 b
5. Vue.directive('runoob', {
   % H1 g- i7 M6 Q- T! f0 J
6.   bind: function (el, binding, vnode) {
   
7.     var s = JSON.stringify
   
8.     el.innerHTML =
   5 O7 f# h7 S) S5 z6 A) J2 B
9.       'name: '       + s(binding.name) + '<br>' +
   
10.       'value: '      + s(binding.value) + '<br>' +
    
11.       'expression: ' + s(binding.expression) + '<br>' +
    # i& G8 j4 i. U. o/ R: D
12.       'argument: '   + s(binding.arg) + '<br>' +
    
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    
15.   }
    
16. })
    
17. new Vue({
    
18.   el: '#app',
    ! S4 N6 t+ \8 {, w' A( h7 Y
19.   data: {
    0 e8 F: E; P8 A/ O/ i4 J% J
20.     message: '菜鸟教程!'
    
21.   }
    3 ?& V. A: ~0 H& u* G' P6 o# `
22. })
    , k5 x6 |5 q5 h
23. </script>

复制代码

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

1. Vue.directive('runoob', function (el, binding) {
   9 a6 Z% J4 V$ a/ v/ [) b3 @
2.   // 设置指令的背景颜色
   1 ]6 g/ g+ ?, v6 u6 \  T7 L9 j' X
3.   el.style.backgroundColor = binding.value.color
   
4. })

复制代码

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

实例

1. <div id="app">
   % H# @! |. Q) D: L/ G2 T4 _
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   
3. </div>
   % a, q5 F* h/ y, t- S1 o
4. 
   & r% g1 W4 U2 e; l' H: L
5. <script>
   0 {* L2 m1 Y. C7 V
6. Vue.directive('runoob', function (el, binding) {
   % X: O; ?3 d! O$ i4 Z7 @
7.     // 简写方式设置文本及背景颜色
   $ U& p  Q$ }% I9 z5 N
8.     el.innerHTML = binding.value.text
   2 I' ]+ i4 {5 k* p6 b
9.     el.style.backgroundColor = binding.value.color
   & L0 A* b1 S+ ^: {3 f9 n
10. })
    , s7 \" @( U( d( ?
11. new Vue({
    # t# g5 P- c+ K1 y
12.   el: '#app'
    ! e  e7 K0 S: L% X
13. })
    ' ?' }& B/ M' V( {) S  \% Z, w
14. </script>

复制代码