Vue.js 自定义指令

admin

5 |; o6 ]: x8 q) m. U

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

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

实例
; U* m, z9 }5 u- i( F

1. <div id="app">
   # x0 v/ n; E# s- |7 |; r
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   - F' J. {5 m0 J7 v
3.     <input v-focus>
   
4. </div>
   / x9 k% k% ?4 A* q5 ~
5. 
   
6. <script>
   9 h6 C9 m. q' y0 G' O
7. // 注册一个全局自定义指令 v-focus
   
8. Vue.directive('focus', {
   
9.   // 当绑定元素插入到 DOM 中。
     U- }- ?; S& c
10.   inserted: function (el) {
    
11.     // 聚焦元素
    
12.     el.focus()
    0 F. V# A+ I* L( l: [
13.   }
    2 l( v9 n* E# f5 o  J! c1 o
14. })
      j1 r9 Y( O& i* e" c: M: X
15. // 创建根实例
    , x7 J% _6 u, q) A& M% G5 Z
16. new Vue({
    
17.   el: '#app'
    
18. })
    ! u  U! {! B* p! T& ]) ^7 ?
19. </script>

复制代码

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

实例

" i4 z% z5 Z( u& e  c5 S

1. <div id="app">
   * g6 X% `2 I# l9 n( l3 W+ r2 @
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   " M3 S2 V' \. F
3.   <input v-focus>
   8 d8 [9 J6 I! c5 y" d
4. </div>
   
5. 
   6 }2 [' A, Q+ q( B  b8 C1 {
6. <script>
   
7. // 创建根实例
   $ f2 ?7 ]$ S1 {( T
8. new Vue({
   4 m5 p& N( b" U6 m# c! d
9.   el: '#app',
   
10.   directives: {
    
11.     // 注册一个局部的自定义指令 v-focus
    * l1 C# [& v* |+ i
12.     focus: {
    % J2 F+ `' I0 y" |
13.       // 指令的定义
    
14.       inserted: function (el) {
    0 J  l- |( L2 o, u9 D0 G
15.         // 聚焦元素
    
16.         el.focus()
    9 A% O) k& {/ O/ e5 m
17.       }
    
18.     }
    : y! `1 X7 e( J+ W0 e& C7 t
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 钩子中可用。
  

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

实例
1 z- {: b2 M9 _8 s2 a

1. <div id="app"  v-runoob:hello.a.b="message">
   
2. </div>
   6 p% ~/ H) e) d6 Z8 m
3. 
   # t* u" @$ N( c$ k/ z4 x5 [
4. <script>
   0 O3 ?+ w" x6 I
5. Vue.directive('runoob', {
   , `5 F* t( z9 ^2 J  E2 ]3 c) i
6.   bind: function (el, binding, vnode) {
   0 ^& [0 t) g' L% s* D
7.     var s = JSON.stringify
   ! T; K' N& v, E+ S+ }, b$ E
8.     el.innerHTML =
   
9.       'name: '       + s(binding.name) + '<br>' +
   & S( G' r5 g( [7 Q
10.       'value: '      + s(binding.value) + '<br>' +
    
11.       'expression: ' + s(binding.expression) + '<br>' +
    
12.       'argument: '   + s(binding.arg) + '<br>' +
    
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    ! Y: s2 k) f" ]' G' \
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    & o1 P! ^% G( W7 ]- r7 d0 M, ?+ W- \/ b
15.   }
    
16. })
    + }% q- {+ a0 ?) |$ O& \3 }
17. new Vue({
    0 I% T9 x; }; o' |9 ~* Z  ~1 n
18.   el: '#app',
    9 \/ {% m3 I* G1 k2 k4 _
19.   data: {
    
20.     message: '菜鸟教程!'
    / N! q  Y2 L# u" |, ^) ]: _
21.   }
    
22. })
    
23. </script>

复制代码

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

1. Vue.directive('runoob', function (el, binding) {
   
2.   // 设置指令的背景颜色
   
3.   el.style.backgroundColor = binding.value.color
   , f1 V- ^0 d0 R  ]; I% {! `2 s6 r
4. })

复制代码

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

实例
$ x2 u3 J; g, B0 P5 e9 g! Z

1. <div id="app">
   
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   6 ~& y7 r, |9 {; A  [) V" ?" P) U/ T
3. </div>
   9 X: z( a$ N' n6 F% l3 N  ~
4. 
   + C0 M6 h3 a$ K# `
5. <script>
   : J+ m- J3 k# z  i
6. Vue.directive('runoob', function (el, binding) {
   - }- B) R( _/ a0 o# f0 L" U: J
7.     // 简写方式设置文本及背景颜色
   $ f4 |) m0 _3 T, e- M+ W
8.     el.innerHTML = binding.value.text
   
9.     el.style.backgroundColor = binding.value.color
   ! \, ~( M$ C( F4 }
10. })
    2 N* D% T( Z1 A
11. new Vue({
    # Z0 o7 y5 U# m: D3 v/ {2 E
12.   el: '#app'
    
13. })
    
14. </script>

复制代码

% L  e4 C: \) P
& Z6 b4 m9 C8 J3 ]4 ?4 C