Vue.js 自定义指令

admin

1 T* `8 s+ ]* y( J! I

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

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

实例

1. <div id="app">
   
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   " Y7 S3 ]/ i; [) h4 C
3.     <input v-focus>
   
4. </div>
   
5. 
   
6. <script>
   " c% K" G) U+ Y- G4 Z! z# O
7. // 注册一个全局自定义指令 v-focus
   
8. Vue.directive('focus', {
   6 x+ v/ i1 y" o8 j& Y3 p' E. G/ E
9.   // 当绑定元素插入到 DOM 中。
   
10.   inserted: function (el) {
    8 F; z5 J4 V: \% @
11.     // 聚焦元素
    
12.     el.focus()
    0 H  m( q# E: N; _9 L$ {) U
13.   }
    
14. })
    4 |7 O7 ?  \( g9 x$ F9 t
15. // 创建根实例
    + C5 r+ h; D3 V/ i+ ?
16. new Vue({
    6 e1 @3 G3 m, L: L
17.   el: '#app'
    
18. })
    
19. </script>

复制代码

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

实例

1. <div id="app">
   . p3 P3 _2 h) [. H# o
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   
3.   <input v-focus>
   
4. </div>
   3 S4 U) g- B) W! H3 k3 |/ ^) R" {
5. 
   1 M% Z% _  F5 o! l1 l6 T
6. <script>
   , @% k3 a0 o: K+ R3 X3 Y+ u, v4 e
7. // 创建根实例
   8 K1 ~/ z$ m0 {9 @
8. new Vue({
   $ |& P' `( {9 u- ~6 z  \  c
9.   el: '#app',
   9 U' q$ s. L  x' L1 v! c
10.   directives: {
    6 _" o, O7 O% v  I3 }
11.     // 注册一个局部的自定义指令 v-focus
    : k5 I6 U2 Q4 v
12.     focus: {
    - i4 G( b' b6 f+ H$ R2 Y% l4 ?' t" C
13.       // 指令的定义
    8 [; ?$ W; M: E* S$ Y2 A& k- c2 F/ Q
14.       inserted: function (el) {
    $ O% k; d6 a5 y6 x- p
15.         // 聚焦元素
    ( l1 \5 u5 V$ Y! E
16.         el.focus()
    3 R! S, Y! W& }% k
17.       }
    
18.     }
    
19.   }
    9 \- P$ ^' ]1 \. `: ^
20. })
    + |+ o4 I( |& ^
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 }。
    * n) h! B3 f2 H6 w
• vnode: Vue 编译生成的虚拟节点。
• oldVnode: 上一个虚拟节点，仅在 update 和 componentUpdated 钩子中可用。
  

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

实例

1. <div id="app"  v-runoob:hello.a.b="message">
   $ J. E  B' Z5 M: T1 q
2. </div>
   2 h& Y) g5 u8 D; I0 N
3. 
   
4. <script>
   
5. Vue.directive('runoob', {
   1 S5 C: O% [6 w! `( M* D
6.   bind: function (el, binding, vnode) {
   * J! h- n! h$ k  t4 \
7.     var s = JSON.stringify
   % S7 K% h; ]/ N
8.     el.innerHTML =
   
9.       'name: '       + s(binding.name) + '<br>' +
   
10.       'value: '      + s(binding.value) + '<br>' +
    
11.       'expression: ' + s(binding.expression) + '<br>' +
    : a' ~& r9 a8 N; e' `1 Y" P$ R
12.       'argument: '   + s(binding.arg) + '<br>' +
    : m; d# M- z! ?* d
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    ' C$ O4 |0 E" @
15.   }
    
16. })
    
17. new Vue({
    1 e% }/ |8 B$ m; Z# u0 I
18.   el: '#app',
    0 h! q" y- @8 H2 E: \
19.   data: {
    
20.     message: '菜鸟教程!'
    
21.   }
    
22. })
    
23. </script>

复制代码

有时候我们不需要其他钩子函数，我们可以简写函数，如下格式：
: t' U. V3 o$ `; K& {

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

复制代码

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

实例
. _$ x  ~+ n0 }; [7 p
. r) V% p9 g2 B

1. <div id="app">
   - A/ v8 t1 Y( Y: B+ H7 o) {/ s
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   
3. </div>
   % {+ U, F) D* O9 R5 [; z+ A
4. 
   0 ?: o9 R, L* P8 F
5. <script>
   
6. Vue.directive('runoob', function (el, binding) {
   
7.     // 简写方式设置文本及背景颜色
   $ y4 L8 Q, v; o) ?* ?* w
8.     el.innerHTML = binding.value.text
   
9.     el.style.backgroundColor = binding.value.color
   3 T( G. R, T4 R' ~( ?9 \
10. })
    
11. new Vue({
    
12.   el: '#app'
    
13. })
    
14. </script>

复制代码

% _  K1 f2 k& `' j& \- C
" G+ _& u* y" l0 _- k