Vue.js 自定义指令

admin

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

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

实例
4 j4 `! L1 x  F$ r' h5 I( O
4 s; n4 l& O; z5 `; \# |" m, w

1. <div id="app">
   
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   
3.     <input v-focus>
   $ y/ Y9 ~- C& J& T6 y& F' R! F4 L
4. </div>
   
5. 
   
6. <script>
   
7. // 注册一个全局自定义指令 v-focus
   
8. Vue.directive('focus', {
   / ]" M9 c9 `, q; q1 L0 u' j
9.   // 当绑定元素插入到 DOM 中。
   $ d, _, }$ y- B/ Q3 ~* E& w7 _4 @
10.   inserted: function (el) {
    . h" Q" W0 p: s7 I
11.     // 聚焦元素
    % b9 w8 g+ q+ x( ]7 G) g
12.     el.focus()
    
13.   }
    / s% _& o: L  w& j6 l8 G* Q
14. })
    
15. // 创建根实例
    
16. new Vue({
    
17.   el: '#app'
    % W6 R: o; G$ k4 A$ ~
18. })
    1 u/ S0 l. V. H+ b8 n4 r
19. </script>

复制代码

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

实例

# z6 ]5 h+ d8 Y* ]+ e( D# u7 F1 U

1. <div id="app">
   
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   
3.   <input v-focus>
   , a# h" @# v5 }( x" X  j7 N7 a
4. </div>
   3 ]  f4 S3 z6 l, q0 w% c
5. 
     t+ d& M, ]4 o6 N+ f+ E# F3 j$ b
6. <script>
   + k8 V6 v3 B0 k/ n1 e+ E
7. // 创建根实例
   
8. new Vue({
   ' s4 F+ F/ Q( `8 f( _8 U
9.   el: '#app',
   # ]$ ~+ z. q- Q$ ?8 e7 ], n+ Q  d
10.   directives: {
    
11.     // 注册一个局部的自定义指令 v-focus
    
12.     focus: {
    ( l' ]; K% O( y9 \: H: h
13.       // 指令的定义
    
14.       inserted: function (el) {
    3 K9 d  {- G) i3 v0 `
15.         // 聚焦元素
    4 g8 o9 l0 m: R8 f! P5 D0 n
16.         el.focus()
    
17.       }
    
18.     }
    
19.   }
    3 Y% }$ h) b1 H6 q7 D
20. })
    
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 }。
    - G* m6 T+ D4 ]; r) z/ O
• vnode: Vue 编译生成的虚拟节点。
• oldVnode: 上一个虚拟节点，仅在 update 和 componentUpdated 钩子中可用。
  % r( \4 J5 m! L: o4 T6 @2 q

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

实例
6 r/ l6 D3 s" Y' t$ L

1. <div id="app"  v-runoob:hello.a.b="message">
   
2. </div>
   9 r. q# o5 }% {4 Q* R" R
3. 
   
4. <script>
   
5. Vue.directive('runoob', {
   
6.   bind: function (el, binding, vnode) {
   
7.     var s = JSON.stringify
   
8.     el.innerHTML =
   
9.       'name: '       + s(binding.name) + '<br>' +
   , {* V  @; y& r( w  z  u. w0 y
10.       'value: '      + s(binding.value) + '<br>' +
    + }# P2 F+ c3 w
11.       'expression: ' + s(binding.expression) + '<br>' +
    
12.       'argument: '   + s(binding.arg) + '<br>' +
    $ x7 F' V: y6 m4 R7 Y: t3 B0 ^
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    
15.   }
    * y3 Z: g% M  ~2 |) I+ l
16. })
    / J" P3 V  Q6 i& S0 p) f7 ?* @
17. new Vue({
    
18.   el: '#app',
    0 ^. V6 N0 M) `
19.   data: {
    
20.     message: '菜鸟教程!'
    5 C  c! p  U0 q+ Y, d/ Z4 ~+ b0 M
21.   }
    
22. })
    * y8 i6 a* i8 {4 W3 b+ S0 f
23. </script>

复制代码

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

1. Vue.directive('runoob', function (el, binding) {
   
2.   // 设置指令的背景颜色
   1 S% s  U4 ?" X% ^3 U* l! t
3.   el.style.backgroundColor = binding.value.color
   ( g0 }' R1 ~+ n5 z2 c5 x' u/ r0 L
4. })

复制代码

/ _' b) J3 }4 B) J
" q, Y# B  {) U. Z2 z, d

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

实例

1. <div id="app">
   
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   
3. </div>
   ; z4 S  C2 W" M7 {5 x  S; X
4. 
   7 _7 X9 @! O+ s
5. <script>
   
6. Vue.directive('runoob', function (el, binding) {
   
7.     // 简写方式设置文本及背景颜色
   
8.     el.innerHTML = binding.value.text
   
9.     el.style.backgroundColor = binding.value.color
   # g* s9 t: [! S
10. })
    
11. new Vue({
    
12.   el: '#app'
    ( b0 U/ u, H- N9 h) A/ l
13. })
    
14. </script>

复制代码

9 _0 V( @) v+ m( F
  G4 V7 \" a7 c( z5 O1 H
1 ]7 _3 V$ {; s. E4 V