Vue.js 自定义指令

admin

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

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

实例

. Q' t; V, K* \3 V( C8 U& P( ?

1. <div id="app">
   
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   % |2 ?* [$ m3 S8 r4 W2 I  h+ G
3.     <input v-focus>
   
4. </div>
   
5. 
   
6. <script>
   2 F) t+ [9 x# N9 p
7. // 注册一个全局自定义指令 v-focus
   " t$ b, x' R, r$ i3 q) ?$ I
8. Vue.directive('focus', {
   * L! @2 {( b7 v+ v) d; [2 V
9.   // 当绑定元素插入到 DOM 中。
   8 d8 \  W, w& k3 D# n- F9 Z0 m
10.   inserted: function (el) {
    
11.     // 聚焦元素
    
12.     el.focus()
    
13.   }
    ( D2 c+ \, c' M  T  F0 s; f
14. })
    
15. // 创建根实例
    
16. new Vue({
    3 Y; [  x6 Z& @- V8 q
17.   el: '#app'
    * \+ y6 m/ A0 {! {0 u
18. })
    6 ^' O7 H9 j+ z% P( o
19. </script>

复制代码

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

实例

) j4 V2 r" |) t0 x

1. <div id="app">
   ; [' c0 \+ y: @
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   
3.   <input v-focus>
   1 E9 b& _: a: D$ o9 H
4. </div>
   
5. 
   
6. <script>
   
7. // 创建根实例
   
8. new Vue({
   ! C+ U. U& h: f) V7 l1 ?8 @
9.   el: '#app',
   3 V1 Q8 x- z7 c
10.   directives: {
    
11.     // 注册一个局部的自定义指令 v-focus
    ) D) b' f. o4 v" E4 j1 n0 T, o
12.     focus: {
    
13.       // 指令的定义
    
14.       inserted: function (el) {
    1 E8 A7 v% X& \/ |# |  }8 @+ V
15.         // 聚焦元素
    " A* e. p' {/ i+ ~: Y0 x
16.         el.focus()
    7 w2 ?3 \2 Z+ M; o8 |8 T6 j) S7 A7 X
17.       }
    6 ^8 G8 |; `8 I; B0 D) c
18.     }
    
19.   }
    1 y. Z% G) D; }3 h) k/ }% W5 n4 k1 F
20. })
    6 s5 s( l2 U, q/ P
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 }。
    & O' q6 V  A* V+ S2 u
• vnode: Vue 编译生成的虚拟节点。
• oldVnode: 上一个虚拟节点，仅在 update 和 componentUpdated 钩子中可用。
  & i6 o6 W2 x6 B9 y5 i+ |

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

实例

! x; @: B0 N  P

1. <div id="app"  v-runoob:hello.a.b="message">
   
2. </div>
   " S$ J: @3 C& K% Z% ^+ X3 d
3. 
   
4. <script>
   
5. Vue.directive('runoob', {
     m& a) H  @: z: X
6.   bind: function (el, binding, vnode) {
   
7.     var s = JSON.stringify
   
8.     el.innerHTML =
   " z( W# Y, z' h+ G3 s; k
9.       'name: '       + s(binding.name) + '<br>' +
   & I$ Q/ S3 I) m) {0 K
10.       'value: '      + s(binding.value) + '<br>' +
    * l+ H8 V( L% T
11.       'expression: ' + s(binding.expression) + '<br>' +
    
12.       'argument: '   + s(binding.arg) + '<br>' +
    
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    ' G" ?6 a, y% N6 G# e
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    
15.   }
    , M" o, v. U, w
16. })
    
17. new Vue({
    6 U% J, {- Q9 J+ ?8 T
18.   el: '#app',
    & l& O" n1 ?, H3 `- Q5 l2 H0 n7 T
19.   data: {
      c* I! T' l: B9 n$ A
20.     message: '菜鸟教程!'
    : }4 V! l" V- [' p  f2 K1 x
21.   }
    5 X7 n( }( ?% M0 s2 ?/ d
22. })
    7 Q) e$ c- ], u. M. Y( N  @$ o. r8 S
23. </script>

复制代码

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

1. Vue.directive('runoob', function (el, binding) {
   * W% D* ?: U% }$ {) u, F
2.   // 设置指令的背景颜色
   ' D- [# ]8 g& O+ S4 H
3.   el.style.backgroundColor = binding.value.color
   
4. })

复制代码

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

实例
1 T$ y- f; B7 p* ]+ ^0 g7 G
$ v4 ~4 @; O$ ^2 _( r

1. <div id="app">
   
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   5 h9 s0 L: |, Y
3. </div>
   
4. 
   
5. <script>
   
6. Vue.directive('runoob', function (el, binding) {
   
7.     // 简写方式设置文本及背景颜色
   
8.     el.innerHTML = binding.value.text
   
9.     el.style.backgroundColor = binding.value.color
   - B5 I' C6 r8 e0 Q" e
10. })
    
11. new Vue({
    0 t2 F) D9 U, N9 X* [% c
12.   el: '#app'
    
13. })
    
14. </script>

复制代码

( M, Z5 ?/ [( B5 F