Vue.js 自定义指令

admin

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

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

实例
9 Q. [; h$ g7 p' v3 a. _0 X2 q

1. <div id="app">
   
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   % s  }" A  O# f* V) W+ u! x4 r
3.     <input v-focus>
   5 |$ E5 y2 ?" `% S* ^' d* I1 Z
4. </div>
   
5. 
   : V/ d- |' i2 c2 v
6. <script>
   + R" m2 I" ^. G- g
7. // 注册一个全局自定义指令 v-focus
   
8. Vue.directive('focus', {
   % o+ O3 t% c  M5 k9 G$ N
9.   // 当绑定元素插入到 DOM 中。
   ) @8 `0 B3 j# T% U( l4 v2 r0 n
10.   inserted: function (el) {
    
11.     // 聚焦元素
    
12.     el.focus()
    
13.   }
    6 M8 r/ s* n. M5 ?6 g1 ?
14. })
    
15. // 创建根实例
    
16. new Vue({
    
17.   el: '#app'
    ! K8 S9 g) Q- r
18. })
    
19. </script>

复制代码

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

实例

1. <div id="app">
   
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   . K1 y" y+ V5 e  G* O
3.   <input v-focus>
   & R5 a. k% v- h2 U: H
4. </div>
   
5. 
   
6. <script>
   ' I- E" v0 X% j! U
7. // 创建根实例
   & y* e" C8 ]; u- i* u1 _
8. new Vue({
   * N. J" d3 o5 X* [
9.   el: '#app',
   
10.   directives: {
    ; P* @& J/ Q5 _% ?; Y2 d
11.     // 注册一个局部的自定义指令 v-focus
    
12.     focus: {
    4 x* }; G; \0 Z9 O6 l  R
13.       // 指令的定义
    
14.       inserted: function (el) {
    2 q) d% G# t& B- N- U  k: l
15.         // 聚焦元素
    ' T2 L( S6 |' o
16.         el.focus()
    
17.       }
    + f) G. w9 @1 f7 J/ @
18.     }
    & h0 `, y5 F6 V7 H9 u
19.   }
    2 ?4 @' i. c/ A3 H$ W2 s) I
20. })
    # c( _6 b* C1 i1 m$ T
21. </script>

复制代码

钩子钩子函数

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

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

钩子函数参数

钩子函数的参数有：

• 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 }。
    ( s8 `# M' ?7 D! W& o9 f0 g6 Y3 e
• vnode: Vue 编译生成的虚拟节点。
• oldVnode: 上一个虚拟节点，仅在 update 和 componentUpdated 钩子中可用。
  2 f. f. f1 D6 ~) O

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

实例
8 I; e/ S* N  K+ P0 W7 V3 x9 h
5 b+ ~: o8 h/ h! K; {

1. <div id="app"  v-runoob:hello.a.b="message">
   
2. </div>
   1 a6 {/ @+ I$ V  U  P: }6 M, z
3. 
   
4. <script>
   % N  t; ~+ Z* F
5. Vue.directive('runoob', {
   . _: H, t- m- S$ V0 D- ]: a
6.   bind: function (el, binding, vnode) {
   5 U4 e5 _$ V( Q( E
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>' +
    
12.       'argument: '   + s(binding.arg) + '<br>' +
    4 {( w4 j( Q( _/ [2 G
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    
15.   }
    
16. })
    
17. new Vue({
    1 S) ]% k1 ^! s
18.   el: '#app',
    3 v* B% t: U- e9 j( C
19.   data: {
    2 Z2 P( W( R+ `3 j1 ]
20.     message: '菜鸟教程!'
    
21.   }
    ' s  s  e4 _' X% m
22. })
    - v' x! k, p2 C1 M! c
23. </script>

复制代码

有时候我们不需要其他钩子函数，我们可以简写函数，如下格式：
. Y$ ~9 u/ y( E8 C' G: T% I

1. Vue.directive('runoob', function (el, binding) {
   
2.   // 设置指令的背景颜色
   
3.   el.style.backgroundColor = binding.value.color
   # E! K. {3 q/ O$ h0 a
4. })

复制代码

& P2 L6 g8 ?) D2 Y( B/ l. b' D$ J
$ Z+ s# `9 u* x* ]/ W8 m0 t

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

实例

1. <div id="app">
   + O/ f, ]7 c. P4 N0 ]. _0 k3 l6 e' X
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   6 N' s+ _3 Y  a3 G# D1 P! Q* u- ^
3. </div>
   
4. 
   
5. <script>
   * k" K' @! P! j* p) k
6. Vue.directive('runoob', function (el, binding) {
   ; v  `! a8 Q# n! P/ X
7.     // 简写方式设置文本及背景颜色
   
8.     el.innerHTML = binding.value.text
   # I2 }1 T. P% A) g1 |1 ~
9.     el.style.backgroundColor = binding.value.color
   
10. })
    ' o3 x# K$ F3 B& O$ C* V+ Y
11. new Vue({
    
12.   el: '#app'
    
13. })
    ) a1 o1 ~1 F3 a- j) M# [
14. </script>

复制代码

" T8 p( \$ V/ ^; ~% X4 v
$ c* r: b; l& Q" _5 A4 k