Vue.js 自定义指令

admin

7 G8 f7 X3 C7 b: r

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

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

实例
4 b  X7 J9 m# a, H

1. <div id="app">
   
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   
3.     <input v-focus>
   
4. </div>
   
5. 
   
6. <script>
   
7. // 注册一个全局自定义指令 v-focus
   
8. Vue.directive('focus', {
   
9.   // 当绑定元素插入到 DOM 中。
   9 b( j8 d$ g- W' a
10.   inserted: function (el) {
    
11.     // 聚焦元素
    3 V) a4 ^( A' A" B1 X8 g
12.     el.focus()
    
13.   }
    
14. })
    6 |4 h" N2 I; r
15. // 创建根实例
    
16. new Vue({
    ( i4 n( D  m! o! }2 ]/ A
17.   el: '#app'
    
18. })
    
19. </script>

复制代码

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

实例

1. <div id="app">
   
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   
3.   <input v-focus>
   
4. </div>
   
5. 
   
6. <script>
   
7. // 创建根实例
   
8. new Vue({
   
9.   el: '#app',
   
10.   directives: {
    
11.     // 注册一个局部的自定义指令 v-focus
    
12.     focus: {
      k6 M; B4 j8 n  r& z9 C* j
13.       // 指令的定义
    3 }5 @- p0 F! l- a7 n1 _
14.       inserted: function (el) {
    ; L" f" p7 U" i! g3 h
15.         // 聚焦元素
    % ~8 K2 g$ D, k3 C/ L. j
16.         el.focus()
    ! U  ~4 F3 P3 [( s/ S1 C
17.       }
    
18.     }
    
19.   }
    ( g4 u7 n" a$ k
20. })
    $ ]) [% A1 r* W; g6 y- F
21. </script>

复制代码

钩子钩子函数

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

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

钩子函数参数

钩子函数的参数有：

• 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 }。
    4 g8 }; ~! F" Q# O! P$ d; i
• vnode: Vue 编译生成的虚拟节点。
• oldVnode: 上一个虚拟节点，仅在 update 和 componentUpdated 钩子中可用。
  ) q  E  d8 M9 C2 A9 A, Y

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

实例

' O4 |  y/ I+ }0 F

1. <div id="app"  v-runoob:hello.a.b="message">
   
2. </div>
   
3. 
   0 _9 L$ N5 ^3 j
4. <script>
   - G6 {0 i, W+ G6 Q
5. Vue.directive('runoob', {
   
6.   bind: function (el, binding, vnode) {
   
7.     var s = JSON.stringify
   % f1 L/ b; m* @/ `) g/ R
8.     el.innerHTML =
   + C# i7 c- y: A. ~0 d: w6 L1 S
9.       'name: '       + s(binding.name) + '<br>' +
   3 v9 x! R' L4 c4 T- G. N+ D# n
10.       'value: '      + s(binding.value) + '<br>' +
    3 l7 P! i" ?, C/ {1 b5 F4 a  F* C; Q
11.       'expression: ' + s(binding.expression) + '<br>' +
    
12.       'argument: '   + s(binding.arg) + '<br>' +
    " _/ L- s4 L* l  w3 u5 F; Z% t, `
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    . W: {- T+ W0 _# q8 d
15.   }
    
16. })
    : ]+ k+ o# p/ i6 |
17. new Vue({
    * _  z# O- c: _2 P
18.   el: '#app',
      d  ^5 f; }0 C# R0 d$ u2 _2 K/ }
19.   data: {
    6 J( W4 H( `9 _6 w0 K
20.     message: '菜鸟教程!'
    
21.   }
    0 K2 S# ]0 Q& d# D& n; F9 v' X" g
22. })
    
23. </script>

复制代码

有时候我们不需要其他钩子函数，我们可以简写函数，如下格式：
7 A" y) t6 k# n8 c

1. Vue.directive('runoob', function (el, binding) {
   1 P  p8 T0 D4 w( m6 {
2.   // 设置指令的背景颜色
   % z9 P! p, k* c% `
3.   el.style.backgroundColor = binding.value.color
   
4. })

复制代码

/ g9 U4 N% M! P6 j) f! r

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

实例
& k1 F& D/ [8 c) _
8 }2 d0 N! |4 q1 E: \  s

1. <div id="app">
   : O# {- J% r4 J7 ^, d
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   ' R3 ?( N' i" W5 ?/ N
3. </div>
   ( n* T# S- A6 F  `* \. Z0 J5 j
4. 
   
5. <script>
   9 H( s2 F, p$ I  A
6. Vue.directive('runoob', function (el, binding) {
   
7.     // 简写方式设置文本及背景颜色
   
8.     el.innerHTML = binding.value.text
   
9.     el.style.backgroundColor = binding.value.color
   
10. })
      Q1 O1 F- |; B2 a; D
11. new Vue({
    ! G+ Z3 F" L9 \- u/ ^  Y- z
12.   el: '#app'
    
13. })
    
14. </script>

复制代码

- @7 l1 O: z: m! T1 o$ n3 w