Vue.js 自定义指令

admin

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

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

实例

1. <div id="app">
     w# N9 m$ u3 C, y2 Z
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   * h( o/ C$ n; z+ n: R
3.     <input v-focus>
   
4. </div>
   " J7 p  G: A3 y) t/ `
5. 
   
6. <script>
   ; ]5 S# p7 u# }9 n7 \+ g5 ~* I
7. // 注册一个全局自定义指令 v-focus
   
8. Vue.directive('focus', {
   - N5 o8 a' c% a' z6 t4 T3 {  _
9.   // 当绑定元素插入到 DOM 中。
   
10.   inserted: function (el) {
    
11.     // 聚焦元素
    
12.     el.focus()
    1 I0 r1 ?7 ~) I3 M) Z& c" c
13.   }
    0 i9 n* {: o& ~8 Y! ~- z$ Q
14. })
    * n2 ?% l$ \6 u* F, U8 _; K) s
15. // 创建根实例
    
16. new Vue({
    8 R- X; f9 r2 e7 S& z7 {1 c# g7 u
17.   el: '#app'
    
18. })
    
19. </script>

复制代码

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

实例
% r+ ]3 q# N, G8 R

1. <div id="app">
   
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   ) s; r- M+ v" Q( ?! W5 c. m
3.   <input v-focus>
   / R& p  [  }3 D
4. </div>
   
5. 
   / h3 y: w& |  @2 v
6. <script>
   1 C% _$ H) E& a$ F* F1 N% {  e7 g
7. // 创建根实例
   
8. new Vue({
   
9.   el: '#app',
   0 o% q: s/ L4 \! ~0 Q! `! E/ e
10.   directives: {
    % B+ ~& T) A; n* J5 A+ _
11.     // 注册一个局部的自定义指令 v-focus
    
12.     focus: {
    
13.       // 指令的定义
    
14.       inserted: function (el) {
    
15.         // 聚焦元素
    
16.         el.focus()
    + m7 t' |/ @) X7 s( Z
17.       }
    
18.     }
    
19.   }
    ' L9 ~. Y" I$ M: _
20. })
    ) B/ v& K1 ?; n
21. </script>

复制代码

钩子钩子函数

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

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

钩子函数参数

钩子函数的参数有：

• 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 }。
    + f: e5 R: I  z+ e
• vnode: Vue 编译生成的虚拟节点。
• oldVnode: 上一个虚拟节点，仅在 update 和 componentUpdated 钩子中可用。
  

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

实例

4 ^& H3 J& ~7 N% f! d

1. <div id="app"  v-runoob:hello.a.b="message">
   # T- P9 E4 a/ `3 x3 [- T
2. </div>
   
3. 
   
4. <script>
   0 J5 \0 N4 F& y( Y/ l
5. Vue.directive('runoob', {
   ' E! }; G, R% |$ Z/ d7 o& I
6.   bind: function (el, binding, vnode) {
   4 W* f. U: o- C" d
7.     var s = JSON.stringify
   
8.     el.innerHTML =
   
9.       'name: '       + s(binding.name) + '<br>' +
   
10.       'value: '      + s(binding.value) + '<br>' +
    
11.       'expression: ' + s(binding.expression) + '<br>' +
    * n4 P9 H; F* K3 \' I( J1 E: u1 t
12.       'argument: '   + s(binding.arg) + '<br>' +
    , {5 N- X5 s# O" `6 H/ o
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    + ~3 E+ x+ t. A
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    
15.   }
    4 f/ B) ]' |- |% z% A1 c9 S- W
16. })
    
17. new Vue({
    - s5 f2 i% e! ]- z: {, _# D8 |
18.   el: '#app',
    
19.   data: {
    / [( R4 R& D, A1 @7 O
20.     message: '菜鸟教程!'
    
21.   }
    
22. })
      |. {1 K1 l  S5 K6 T# p2 e
23. </script>

复制代码

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

1. Vue.directive('runoob', function (el, binding) {
   9 A: r1 _2 V7 n1 M9 v
2.   // 设置指令的背景颜色
   - l8 g* ^9 w) a7 d0 y3 Z% z
3.   el.style.backgroundColor = binding.value.color
   & W1 A( E; H5 u" ~# h& ?/ ^
4. })

复制代码

+ m! r0 D( l' V- B

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

实例

1. <div id="app">
   
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   ' |: x& _9 k; k, ?9 [3 p1 K
3. </div>
   
4. 
   
5. <script>
   
6. Vue.directive('runoob', function (el, binding) {
   
7.     // 简写方式设置文本及背景颜色
   ; R* H! W, ]; L3 l9 g
8.     el.innerHTML = binding.value.text
   / e: v& L5 E9 G; x8 K- r% z4 w
9.     el.style.backgroundColor = binding.value.color
   
10. })
    
11. new Vue({
    ( C0 i. @/ X3 a) v7 X2 r, G
12.   el: '#app'
    
13. })
    # I( m, u( @  J4 F5 B# ~
14. </script>

复制代码

0 ^8 ]9 p6 d! n& v