Vue.js 自定义指令

admin

; ?+ g) T  ?  ^8 H6 I0 x( t; N

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

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

实例

% J. `' J5 D5 D! R1 ]' |6 S1 m+ e

1. <div id="app">
   ; j6 \% t5 @1 m! ~9 M  M: \
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   . ~7 H. i! O, c% e9 |, H
3.     <input v-focus>
   ! c# Y* c$ B* j: @; g& t
4. </div>
   
5. 
   
6. <script>
   7 [6 l$ d! T2 p3 {
7. // 注册一个全局自定义指令 v-focus
   + n: h2 q) L+ l$ [- a" u5 {% R
8. Vue.directive('focus', {
   
9.   // 当绑定元素插入到 DOM 中。
   ; }( J& v& Y# q+ Q6 T; a4 e
10.   inserted: function (el) {
    
11.     // 聚焦元素
    / e- z) `" R5 j% Y6 S4 \3 L
12.     el.focus()
    4 Y3 g! N( \1 C6 {# `/ n& R$ p2 @( H! z
13.   }
    5 g5 n- v8 b$ @
14. })
    4 u5 l- o/ f7 y2 F
15. // 创建根实例
    
16. new Vue({
    
17.   el: '#app'
    
18. })
    
19. </script>

复制代码

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

实例

  t" o8 X2 R  p$ m3 j3 B8 Z

1. <div id="app">
   
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   
3.   <input v-focus>
   ' w6 S# h0 o( U2 N
4. </div>
   ! Q& g, y2 g5 `5 \8 _1 b! G' \- Z
5. 
   
6. <script>
   
7. // 创建根实例
   
8. new Vue({
   
9.   el: '#app',
   " u/ I' G6 W0 e6 E: k1 z
10.   directives: {
    
11.     // 注册一个局部的自定义指令 v-focus
    
12.     focus: {
    1 U! K4 d. m7 s# ]9 v! D
13.       // 指令的定义
    # W. a+ @$ B( s* v6 b' _) A4 ]0 S8 {3 y
14.       inserted: function (el) {
    
15.         // 聚焦元素
    $ b4 _+ @" l! a: Y. L; d
16.         el.focus()
    
17.       }
    # K% O6 Y- R8 j
18.     }
    + I# Q+ }. E& X; F% U8 b3 V0 ~8 n
19.   }
    
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 }。
    
• vnode: Vue 编译生成的虚拟节点。
• oldVnode: 上一个虚拟节点，仅在 update 和 componentUpdated 钩子中可用。
  , r; G5 }. V$ y- l4 V

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

实例
: M7 C" M- q: v2 E0 w- h5 Z# g* x

1. <div id="app"  v-runoob:hello.a.b="message">
   3 b: P5 b$ E2 M: Q8 y" o* S, D/ g
2. </div>
   + d' u4 P$ M$ x. R& U5 O9 n  {
3. 
   
4. <script>
   
5. Vue.directive('runoob', {
   ) R8 S" L# M" w! ^
6.   bind: function (el, binding, vnode) {
   ! ]# \% @2 C! x: }6 e8 W0 s: 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>' +
    
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    9 }' ?0 P8 l5 W3 R; M
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    
15.   }
    
16. })
    
17. new Vue({
    
18.   el: '#app',
    
19.   data: {
    8 k; Z; _( k( }5 p0 Q
20.     message: '菜鸟教程!'
    , s9 l- d( z/ }7 W: ^) R
21.   }
    ' _) U$ v4 z  r% G/ ^
22. })
    
23. </script>

复制代码

有时候我们不需要其他钩子函数，我们可以简写函数，如下格式：
. N/ C0 o2 _: S) K. b/ L( t5 Q# a

1. Vue.directive('runoob', function (el, binding) {
   # b7 I6 V& P1 r$ a! w- B$ s4 X
2.   // 设置指令的背景颜色
   
3.   el.style.backgroundColor = binding.value.color
   ! [& H; [8 ?1 {/ c; ^
4. })

复制代码

, u( E1 M3 w  p# {( k, Z; s
( |* o/ F) I$ u2 I  Z% y4 b

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

实例
) K( G  r& B  f( c# ^+ ~, l5 k! D

1. <div id="app">
   
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   , T* E6 Y/ i% W; l
3. </div>
   9 m' S- D* `- f. F
4. 
   
5. <script>
   
6. Vue.directive('runoob', function (el, binding) {
   * x0 }- M9 k7 ~! `* @7 j
7.     // 简写方式设置文本及背景颜色
   ( U' x) M1 F# q2 z" j- o
8.     el.innerHTML = binding.value.text
   
9.     el.style.backgroundColor = binding.value.color
   
10. })
    & F5 c) d+ d8 F' G
11. new Vue({
    ) f) b2 s  e6 H' [
12.   el: '#app'
    
13. })
    
14. </script>

复制代码