Vue.js 自定义指令

admin

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

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

实例

1. <div id="app">
   
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   
3.     <input v-focus>
   8 h5 i$ Q6 d6 j; S- t/ ?) ~: I4 `4 h
4. </div>
   
5. 
   # H* P7 v) [* u1 n* m/ l
6. <script>
   . r5 g1 Y2 s9 {7 q
7. // 注册一个全局自定义指令 v-focus
   
8. Vue.directive('focus', {
   - m; U( `) h- w% ^( O6 t5 g
9.   // 当绑定元素插入到 DOM 中。
   8 J; M9 u& H7 ~8 b
10.   inserted: function (el) {
    ' d) N" X  a. l5 c
11.     // 聚焦元素
    
12.     el.focus()
    
13.   }
    
14. })
    : j8 d' Q) D( x' v& n
15. // 创建根实例
    * D+ q: f4 b+ O4 y/ d9 ~
16. new Vue({
    0 j# N6 b% t. d5 c5 y- Z. r
17.   el: '#app'
    5 I8 K' M' `( A0 Q) Q! m% x6 @# i5 r  J
18. })
    # }) i  p6 Y% F+ N0 Y& P1 a) f
19. </script>

复制代码

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

实例

1. <div id="app">
   ' O- X2 T5 w" f1 v
2.   <p>页面载入时，input 元素自动获取焦点：</p>
     T* ^$ R2 Z7 X* u1 h
3.   <input v-focus>
   
4. </div>
   ' m# _# \1 C7 |) I3 z# N
5. 
   , {3 }2 m5 m* @7 V; E
6. <script>
   6 d' l. F5 w/ i
7. // 创建根实例
   
8. new Vue({
   
9.   el: '#app',
   " b9 r' ?  b5 a
10.   directives: {
    
11.     // 注册一个局部的自定义指令 v-focus
    - B8 |* G' B5 W$ [( V
12.     focus: {
    
13.       // 指令的定义
    
14.       inserted: function (el) {
    
15.         // 聚焦元素
    
16.         el.focus()
    . p& F5 o6 q% u% j! \) t9 E- S: N
17.       }
    
18.     }
    
19.   }
    , e6 h3 l/ S+ U2 |7 A
20. })
    2 W% S9 G8 Y9 Q; v
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 }。
    3 ^8 r. x+ L5 L  e4 K) O: k% g
• vnode: Vue 编译生成的虚拟节点。
• oldVnode: 上一个虚拟节点，仅在 update 和 componentUpdated 钩子中可用。
  / g8 F4 y" a" M% L

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

实例
& o0 Q1 x6 s9 _$ T6 Y0 ?

1. <div id="app"  v-runoob:hello.a.b="message">
   2 c& q% I  j' p0 [! Y$ Q
2. </div>
   3 h" S8 B( q& T5 B3 x2 M
3. 
   
4. <script>
   
5. Vue.directive('runoob', {
   # S- d' G. M! s7 w+ \! O, u
6.   bind: function (el, binding, vnode) {
   
7.     var s = JSON.stringify
   4 }1 C  O: e5 e$ r$ V
8.     el.innerHTML =
   
9.       'name: '       + s(binding.name) + '<br>' +
   
10.       'value: '      + s(binding.value) + '<br>' +
    
11.       'expression: ' + s(binding.expression) + '<br>' +
    
12.       'argument: '   + s(binding.arg) + '<br>' +
    + |) }+ l9 |6 q, M$ v7 V0 s7 f$ X
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    5 L# ?) a0 f: x8 _* C0 W
15.   }
    
16. })
    
17. new Vue({
    
18.   el: '#app',
    3 o; Q7 N( J6 u4 \
19.   data: {
    & ~' @! z1 ?+ L( h3 G+ x
20.     message: '菜鸟教程!'
    + x( P/ I/ H- C
21.   }
    
22. })
    
23. </script>

复制代码

有时候我们不需要其他钩子函数，我们可以简写函数，如下格式：
7 E- v" e: P4 E2 c* D) W" _# G

1. Vue.directive('runoob', function (el, binding) {
   
2.   // 设置指令的背景颜色
   
3.   el.style.backgroundColor = binding.value.color
   
4. })

复制代码

0 v$ h+ ~9 h& g" L7 S; d' _0 C  F

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

实例
: @. T8 g8 C4 y$ d& ^7 X1 s

1. <div id="app">
   
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   : i' k' E$ v0 o( D
3. </div>
   
4. 
   
5. <script>
   " l- s: P; x) Y
6. Vue.directive('runoob', function (el, binding) {
   
7.     // 简写方式设置文本及背景颜色
   * R) W- e0 q3 Z2 [+ o
8.     el.innerHTML = binding.value.text
   3 i* P: T) |& y' `; j
9.     el.style.backgroundColor = binding.value.color
   8 V& Y, W, Z; ?5 S% s8 o& M, ]0 d
10. })
    
11. new Vue({
      {5 Y' E1 {  b
12.   el: '#app'
    : b9 k+ @2 D- ~
13. })
    
14. </script>

复制代码

; B  H! O$ J0 K- C5 G/ T
1 X! M6 w5 [5 E6 k' z9 }; ^- a