Vue.js 自定义指令

admin

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

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

实例
9 \: S+ G( Y3 t3 E& o# Y, u
$ @2 }+ [& A1 |5 a0 T- w

1. <div id="app">
   1 J$ A( D" C; A" J* j+ a5 b
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   # X, Q7 H/ K/ C% h
3.     <input v-focus>
   ; g# E# n! Q0 W5 g5 p
4. </div>
   
5. 
   " O& s) Q0 ~! U$ p+ f% z5 G& o
6. <script>
   
7. // 注册一个全局自定义指令 v-focus
   6 o: A& k# m. V: _: _; Q5 ?3 l
8. Vue.directive('focus', {
   % f2 l! L. U8 n" ?, F4 \7 w
9.   // 当绑定元素插入到 DOM 中。
   
10.   inserted: function (el) {
    
11.     // 聚焦元素
    ' Q* Z6 u* ^0 F( i5 b
12.     el.focus()
    ( `: _7 j* z  _
13.   }
    
14. })
    ; N4 c7 [0 E+ Q3 f. `
15. // 创建根实例
    
16. new Vue({
    
17.   el: '#app'
    ) _6 s9 S; d( m1 v2 y
18. })
    
19. </script>

复制代码

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

实例
- f& p5 Z  C; P
7 _$ H+ J2 Q- Y' S

1. <div id="app">
   
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   + w5 _% H6 R9 z5 u6 J! f- o, I* h+ V
3.   <input v-focus>
   
4. </div>
   
5. 
   
6. <script>
   8 O4 m* `2 s: m& K, g; |
7. // 创建根实例
   
8. new Vue({
   
9.   el: '#app',
   ; y* s; n+ C$ P/ Q3 t
10.   directives: {
    
11.     // 注册一个局部的自定义指令 v-focus
      }0 n& o: [5 F1 U$ |) D
12.     focus: {
    
13.       // 指令的定义
    
14.       inserted: function (el) {
    ( m" w$ K/ O! y- J: w5 g0 Z
15.         // 聚焦元素
    
16.         el.focus()
    8 P$ h" X0 ^1 V2 m& o; s
17.       }
    8 G: c, @- E4 R
18.     }
    1 Z5 w8 ~7 w6 p$ g+ r1 m
19.   }
    
20. })
    6 ?+ w: T$ ~. r7 z2 U- r
21. </script>

复制代码

钩子钩子函数

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

• bind: 只调用一次，指令第一次绑定到元素时调用，用这个钩子函数可以定义一个在绑定时执行一次的初始化动作。
• inserted: 被绑定元素插入父节点时调用（父节点存在即可调用，不必存在于 document 中）。
• update: 被绑定元素所在的模板更新时调用，而不论绑定值是否变化。通过比较更新前后的绑定值，可以忽略不必要的模板更新（详细的钩子函数参数见下）。
• componentUpdated: 被绑定元素所在模板完成一次更新周期时调用。
• unbind: 只调用一次， 指令与元素解绑时调用。
  
  : z) D0 I8 z* l8 A& T

钩子函数参数

钩子函数的参数有：

• 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 }。
    
• vnode: Vue 编译生成的虚拟节点。
• oldVnode: 上一个虚拟节点，仅在 update 和 componentUpdated 钩子中可用。
  # ^+ r" A2 S0 e8 a& N" e

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

实例

2 L* k% Y. M, F2 s- G: Q7 V

1. <div id="app"  v-runoob:hello.a.b="message">
   
2. </div>
   
3. 
   
4. <script>
   
5. Vue.directive('runoob', {
   # |  Z7 |' B1 t
6.   bind: function (el, binding, vnode) {
   
7.     var s = JSON.stringify
   
8.     el.innerHTML =
   
9.       'name: '       + s(binding.name) + '<br>' +
   ; I9 O  u+ ]6 B1 a
10.       'value: '      + s(binding.value) + '<br>' +
    ) S+ [6 F' ~* m
11.       'expression: ' + s(binding.expression) + '<br>' +
    5 s5 r6 H# P* V. {: {0 H
12.       'argument: '   + s(binding.arg) + '<br>' +
    0 t9 {) U+ u: W
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    % c& M( f$ @, W$ n8 G. o
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    
15.   }
    
16. })
    
17. new Vue({
    
18.   el: '#app',
    
19.   data: {
    
20.     message: '菜鸟教程!'
    
21.   }
    
22. })
    
23. </script>

复制代码

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

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

复制代码

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

实例
9 @% w+ A* j2 E6 z- j( x9 _- ]

1. <div id="app">
   + b$ n5 k% b! s, f
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   
3. </div>
   
4. 
   
5. <script>
   $ T- K4 D! S9 N0 S. s
6. Vue.directive('runoob', function (el, binding) {
   7 L4 K6 S7 }0 \$ Q- `1 W+ w  o
7.     // 简写方式设置文本及背景颜色
   ' x9 Y8 B# D, W  X% ^' s9 t
8.     el.innerHTML = binding.value.text
   
9.     el.style.backgroundColor = binding.value.color
   0 n& s; K8 L5 l
10. })
    1 O0 i+ [: u; r' y" ?" E
11. new Vue({
    
12.   el: '#app'
    
13. })
    3 e1 {; S- {" k
14. </script>

复制代码

  z1 h2 H0 ~6 v5 O
' W/ W6 u" n0 y( \3 W4 C' _