Vue.js 自定义指令

admin

1 b2 I0 z# o1 e1 p4 ?+ |! V

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

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

实例
& L0 }" s7 N, Z7 l2 c

1. <div id="app">
   6 x8 `8 m$ D! ~  \0 G$ o7 Q5 o
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   ! J4 N8 ~+ x- t* h0 R
3.     <input v-focus>
   5 p7 K. k/ l  o) R. l4 {
4. </div>
   
5. 
   ) C' R" }9 t) X% W/ ~# r/ I9 u' x& E
6. <script>
   2 n# K6 G8 Q% I' }4 e2 z8 h
7. // 注册一个全局自定义指令 v-focus
   ! E  C! `# H' `7 N" V% R2 K5 w
8. Vue.directive('focus', {
   ' ^7 S6 w( j) E& o
9.   // 当绑定元素插入到 DOM 中。
   1 Q3 E' @8 p% S7 a
10.   inserted: function (el) {
    
11.     // 聚焦元素
    
12.     el.focus()
    
13.   }
    9 G- C& |7 ^7 M
14. })
    . t# e- x; e1 L1 ^5 n* G; M
15. // 创建根实例
      |+ Y+ A/ z0 `# o1 h
16. new Vue({
    
17.   el: '#app'
    
18. })
    
19. </script>

复制代码

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

实例
6 C' q5 f+ m" d
0 m& a7 T8 E9 Q6 Y8 w

1. <div id="app">
   
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   
3.   <input v-focus>
   
4. </div>
   
5. 
   1 o( k* `$ Y8 c- M( J
6. <script>
   
7. // 创建根实例
   : |7 f$ [  f* q9 ^1 v: Z
8. new Vue({
   
9.   el: '#app',
   ; X) H( ~+ ^8 y
10.   directives: {
    
11.     // 注册一个局部的自定义指令 v-focus
    ; c) f. L* M% }8 k  ]
12.     focus: {
    
13.       // 指令的定义
    
14.       inserted: function (el) {
    
15.         // 聚焦元素
    
16.         el.focus()
    9 _- d: y: l$ p3 r, u
17.       }
    2 g' ]$ }9 m2 Z( {
18.     }
    
19.   }
    
20. })
    ; ]+ R# i, g4 J
21. </script>

复制代码

钩子钩子函数

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

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

钩子函数参数

钩子函数的参数有：

• 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 }。
    % y+ M# J- @$ ~/ R( z* U
• vnode: Vue 编译生成的虚拟节点。
• oldVnode: 上一个虚拟节点，仅在 update 和 componentUpdated 钩子中可用。
  

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

实例
9 J, a, p7 P; i# l* V( G1 [
( `+ o7 {$ m1 M, ?7 H7 d7 ?0 B

1. <div id="app"  v-runoob:hello.a.b="message">
   
2. </div>
   
3. 
   . m& u2 ]( y4 z& d  k. \; G8 j
4. <script>
   2 F9 F, ^' x* ?8 Q/ F8 |$ I
5. Vue.directive('runoob', {
   
6.   bind: function (el, binding, vnode) {
   
7.     var s = JSON.stringify
   ; h  G8 B: e) P
8.     el.innerHTML =
   & R* ^* F5 y: q6 e4 U
9.       'name: '       + s(binding.name) + '<br>' +
   0 f6 |  |+ Z, w
10.       'value: '      + s(binding.value) + '<br>' +
    3 z+ Z" Z7 s% O
11.       'expression: ' + s(binding.expression) + '<br>' +
    " B3 l  e4 ]: v$ `) }
12.       'argument: '   + s(binding.arg) + '<br>' +
    
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    
15.   }
    # b& i2 J9 U: H6 M8 }; P
16. })
    : k. ]: i2 Z/ j# e- G0 f8 V
17. new Vue({
    
18.   el: '#app',
    
19.   data: {
      l, c2 j6 m& c1 F% Y# p2 C9 u
20.     message: '菜鸟教程!'
    
21.   }
    1 f8 s4 A% R5 o; A9 o/ \( ?7 y+ p
22. })
    
23. </script>

复制代码

有时候我们不需要其他钩子函数，我们可以简写函数，如下格式：
5 V" T  Y' g  {' w9 a/ V

1. Vue.directive('runoob', function (el, binding) {
   
2.   // 设置指令的背景颜色
   4 J+ V& C8 ?! V# a: r8 K
3.   el.style.backgroundColor = binding.value.color
   
4. })

复制代码

- P  j! [! a9 \

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

实例
' S8 B3 `/ q, [. A
' U* C6 G& t, M! |! j7 U

1. <div id="app">
   / O' d9 x  t" _+ F
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   
3. </div>
   ; |) B! h1 w+ n4 {  \
4. 
   5 z  ^1 g8 |; h
5. <script>
   7 M( |2 s& ^* N; i$ Q
6. Vue.directive('runoob', function (el, binding) {
   " A+ G; F, U& k2 S! p
7.     // 简写方式设置文本及背景颜色
   
8.     el.innerHTML = binding.value.text
   * @% W4 u' d- w! \- K/ q& W- h
9.     el.style.backgroundColor = binding.value.color
   4 c) y9 ]& b" Z8 J  q
10. })
    ) x/ s( D% p' H, V$ ^
11. new Vue({
    
12.   el: '#app'
    
13. })
    
14. </script>

复制代码

4 Z1 m: O' Z# c

. F+ w1 D" M) |$ u$ o