Vue.js 自定义指令

admin

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

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

实例

1. <div id="app">
   3 u; D" e+ u$ r: G6 _8 _; Q
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   
3.     <input v-focus>
   
4. </div>
   . {: F2 Q2 z3 X) h' Q
5. 
   
6. <script>
   
7. // 注册一个全局自定义指令 v-focus
   
8. Vue.directive('focus', {
   & q& I/ O3 e7 b/ b! E# X4 N0 R
9.   // 当绑定元素插入到 DOM 中。
   
10.   inserted: function (el) {
    
11.     // 聚焦元素
    
12.     el.focus()
    
13.   }
    0 `5 y0 }6 ~4 B% D4 ?( I$ D% n
14. })
    7 o) G1 g: X8 p8 l9 m
15. // 创建根实例
    
16. new Vue({
    
17.   el: '#app'
    3 I8 K9 Z  f- y- H9 j% y
18. })
    
19. </script>

复制代码

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

实例
+ a$ B* Y9 o2 G9 T$ ^" a8 X/ G% z

1. <div id="app">
   
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   . ]) U4 ?1 Z" A
3.   <input v-focus>
   
4. </div>
   6 V! c# J8 ~6 T
5. 
   7 ~6 n& H9 C9 j( V
6. <script>
   ! q& H; t6 @* }# N4 r7 J
7. // 创建根实例
   1 X( ~4 G1 R+ F. K  {' X- o9 e
8. new Vue({
   ! a( R; ]8 h  p  |8 j8 i( L
9.   el: '#app',
   ' b9 c( a4 C6 q. x% ?* b
10.   directives: {
    - p1 q  Y$ Q6 T/ `1 x# b4 q
11.     // 注册一个局部的自定义指令 v-focus
    
12.     focus: {
    
13.       // 指令的定义
    5 f- X: z: {* G( u. H  n. y% v2 u
14.       inserted: function (el) {
    
15.         // 聚焦元素
    * ]; s! z4 [4 E* r
16.         el.focus()
    & f9 l9 K( A- n& z
17.       }
    
18.     }
    
19.   }
    , b0 ~0 l' }2 e) ]. u% F4 P
20. })
    5 S$ U8 Q6 Q% }: d
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 钩子中可用。
  

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

实例

1. <div id="app"  v-runoob:hello.a.b="message">
   4 k0 C2 k1 B! P7 `/ z
2. </div>
   5 A/ S8 O5 z9 {$ t+ b, m% E* \
3. 
   % m  _7 @) Q) i6 }* z1 T
4. <script>
   
5. Vue.directive('runoob', {
   $ |! Q& J. q" |6 \; x$ E
6.   bind: function (el, binding, vnode) {
   
7.     var s = JSON.stringify
   ) }% B6 D# j$ B% m* Z
8.     el.innerHTML =
   , s( j0 Q4 C# p/ s: T4 C8 @
9.       'name: '       + s(binding.name) + '<br>' +
   
10.       'value: '      + s(binding.value) + '<br>' +
    
11.       'expression: ' + s(binding.expression) + '<br>' +
    , b2 U  v. M& O( z$ K1 N1 f' f
12.       'argument: '   + s(binding.arg) + '<br>' +
    
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    / b- p0 C- ?6 B: \$ T
15.   }
      w/ b+ ?1 f) ?/ K
16. })
    - }. \6 V& D% t. L  i; d
17. new Vue({
    
18.   el: '#app',
    5 N$ x! P, X% q1 [& s' ~6 b$ E
19.   data: {
    ) v+ e2 N9 ^+ x- F2 G
20.     message: '菜鸟教程!'
    
21.   }
    
22. })
    5 K3 V5 k" V/ f* K) r
23. </script>

复制代码

有时候我们不需要其他钩子函数，我们可以简写函数，如下格式：
% J# A* n9 ?( T* r" {/ ^

1. Vue.directive('runoob', function (el, binding) {
   : o- [/ W( f  j; a2 y) G& W+ \) w
2.   // 设置指令的背景颜色
   
3.   el.style.backgroundColor = binding.value.color
   ! L4 [; {5 }$ k, A
4. })

复制代码

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

实例
# @% n/ G" Q9 K2 f( a1 N6 t
* C+ M/ h) f1 J, m) o: O

1. <div id="app">
   
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   
3. </div>
   . H8 q! ?$ C3 m. N
4. 
   " q2 Q4 i' S5 p: e9 s% @( M
5. <script>
   8 M: k1 e( o2 [$ E
6. Vue.directive('runoob', function (el, binding) {
   
7.     // 简写方式设置文本及背景颜色
   
8.     el.innerHTML = binding.value.text
   : M# Y$ i4 `+ @" E9 @
9.     el.style.backgroundColor = binding.value.color
   5 V9 C1 S( g( T5 T' {) g
10. })
    9 b4 c8 J; u6 ]0 H" _& j
11. new Vue({
    . X  @7 I. |2 M+ \
12.   el: '#app'
    
13. })
    ) Z, K  ^% o. C- b% r/ O: t
14. </script>

复制代码

" I+ y6 g$ q. S& `
: l/ f- v: p: R" r9 @* s