Vue.js 自定义指令

admin

( E" V) F- h( S3 Q- t

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

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

实例
& g3 @% y4 a- X  E# K

1. <div id="app">
   
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   
3.     <input v-focus>
   & V' w' K) s% o0 \- o! J8 F
4. </div>
   , `  _8 V/ j3 g2 }0 p. ~" ~1 `9 U
5. 
   
6. <script>
   
7. // 注册一个全局自定义指令 v-focus
   , H: w  H2 }( \$ t  y3 N: w; p1 l
8. Vue.directive('focus', {
   2 c0 d! J# R6 s0 F# B$ ?' P
9.   // 当绑定元素插入到 DOM 中。
   ' l( @2 [+ j/ P+ S  [
10.   inserted: function (el) {
    
11.     // 聚焦元素
    / x7 ?. J+ k+ Z8 s; J" k6 r5 B
12.     el.focus()
    
13.   }
    
14. })
    
15. // 创建根实例
    
16. new Vue({
    
17.   el: '#app'
    # F9 d6 e- p2 F: ?8 n
18. })
    
19. </script>

复制代码

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

实例
3 o; d3 k/ X( V  K% P$ y  v% y0 y4 u

1. <div id="app">
   8 O; s& b3 a- \, y9 O$ c
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   / F' N- f, d$ l: Z6 C
3.   <input v-focus>
   & L1 R+ R% t. E
4. </div>
   ' @( g. c; r) a3 X0 Y& u. q
5. 
   
6. <script>
   
7. // 创建根实例
   * g9 ^7 V, E# @5 T2 ^* q* X' z9 k3 V- Y
8. new Vue({
   0 f2 q( F( W; s: B3 J; o0 s
9.   el: '#app',
   
10.   directives: {
    , E/ K+ \3 c! F( f
11.     // 注册一个局部的自定义指令 v-focus
    7 n, Q3 \: K# L3 O
12.     focus: {
    
13.       // 指令的定义
    
14.       inserted: function (el) {
    
15.         // 聚焦元素
    5 L' M2 M3 {* D9 m' g  ~
16.         el.focus()
      s8 M8 `" @6 S) k, K
17.       }
    
18.     }
    3 N. j) ]: R& f- K0 T2 M1 T* Z7 q
19.   }
    
20. })
    
21. </script>

复制代码

钩子钩子函数

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

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

钩子函数参数

钩子函数的参数有：

• 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& E+ w9 o6 x# S9 J
• vnode: Vue 编译生成的虚拟节点。
• oldVnode: 上一个虚拟节点，仅在 update 和 componentUpdated 钩子中可用。
  

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

实例
% O; b/ i5 h2 ^' a4 d

1. <div id="app"  v-runoob:hello.a.b="message">
   
2. </div>
   
3. 
   
4. <script>
   ) z, `0 X0 K. X/ [1 {. ^0 y1 Y. \
5. Vue.directive('runoob', {
   
6.   bind: function (el, binding, vnode) {
   
7.     var s = JSON.stringify
   
8.     el.innerHTML =
   
9.       'name: '       + s(binding.name) + '<br>' +
   2 g. `. _1 a, P$ |
10.       'value: '      + s(binding.value) + '<br>' +
    
11.       'expression: ' + s(binding.expression) + '<br>' +
    
12.       'argument: '   + s(binding.arg) + '<br>' +
    
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    ' T- ?* C, Q4 [. H/ R
15.   }
    
16. })
    : }; ?. z; m7 ^0 V' C) r) c8 l
17. new Vue({
    ; n+ J- Y: R$ f5 m
18.   el: '#app',
    
19.   data: {
    
20.     message: '菜鸟教程!'
    : k) z) L7 a9 c0 z- }/ q% w# w
21.   }
    
22. })
    
23. </script>

复制代码

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

1. Vue.directive('runoob', function (el, binding) {
   + ~, a# _; e8 J% A* h5 c  M
2.   // 设置指令的背景颜色
   
3.   el.style.backgroundColor = binding.value.color
   " c% V; }. r/ R9 p2 v5 d5 _" C
4. })

复制代码

. x0 E: F* F, N: v# P1 ~7 h  A! @
: S9 K( y5 @; O$ {% |

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

实例
! E" D& N6 s) z) o* r
2 D: B4 E: {' j# p( L

1. <div id="app">
   
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   % }6 F5 F! X% _1 z2 y8 z6 a4 c
3. </div>
   + h, h5 o, L: o9 }6 \
4. 
   4 E  Q4 \7 h5 q
5. <script>
   
6. Vue.directive('runoob', function (el, binding) {
   
7.     // 简写方式设置文本及背景颜色
   , `4 M/ }5 [+ B& T/ [% m
8.     el.innerHTML = binding.value.text
   2 f8 N& G  j8 J
9.     el.style.backgroundColor = binding.value.color
   
10. })
    # c9 @7 u& G% f
11. new Vue({
    % Q# ^9 \* S( n7 f) ^) }6 B
12.   el: '#app'
    ) E% L0 a! G: t/ |; D  Q2 F
13. })
    
14. </script>

复制代码