Vue.js 自定义指令

admin

6 l% \. l8 b% K# m; [1 k- {1 }" E

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

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

实例
1 B3 U# j/ i+ ~7 U! a6 l

1. <div id="app">
   
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   
3.     <input v-focus>
   7 d0 P( r5 G( k; ?, V& ~! w
4. </div>
   0 B3 ]+ W; E) y! ^4 P
5. 
   ; n( E- l$ P, P) _: q$ N
6. <script>
   5 x3 C$ J% t# k( v
7. // 注册一个全局自定义指令 v-focus
   
8. Vue.directive('focus', {
   
9.   // 当绑定元素插入到 DOM 中。
   + i. t0 E' O  ?) B& _* ]- }
10.   inserted: function (el) {
    
11.     // 聚焦元素
    1 M6 J- [7 I' q
12.     el.focus()
      y! V6 m9 B! H- I0 Z3 ]8 o* f+ ^
13.   }
    ; ~, l! m% Z$ W1 x; @; ~
14. })
    ' }; s& G# u) T
15. // 创建根实例
    4 W. k; v% ], @+ E
16. new Vue({
    
17.   el: '#app'
    7 q% j  A" n7 _$ a: c) }( f
18. })
    
19. </script>

复制代码

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

实例
7 b' S+ f1 f& H- u* k8 L" p
" G; w) y- _! @7 g+ I: T

1. <div id="app">
   
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   - H5 i+ D7 G, W/ ~3 N8 \
3.   <input v-focus>
   
4. </div>
   
5. 
   / z/ A2 S0 p* v; k# u
6. <script>
   3 @" U, f$ W+ D* n
7. // 创建根实例
   
8. new Vue({
   
9.   el: '#app',
   
10.   directives: {
    
11.     // 注册一个局部的自定义指令 v-focus
    
12.     focus: {
    
13.       // 指令的定义
    
14.       inserted: function (el) {
    
15.         // 聚焦元素
    
16.         el.focus()
    
17.       }
    9 a( o- \" h! @3 R
18.     }
    4 J5 ]6 x6 H/ F; Y( S( g, ^
19.   }
    $ i# X% o) ^9 V3 Z
20. })
    & i3 P" ?$ Z$ Y
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 }。
    ' E1 ]/ b0 Z/ R) Q3 d
• vnode: Vue 编译生成的虚拟节点。
• oldVnode: 上一个虚拟节点，仅在 update 和 componentUpdated 钩子中可用。
  9 {! q3 \3 H: \5 ?& M

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

实例

1 j8 p0 L; g- L. y- {

1. <div id="app"  v-runoob:hello.a.b="message">
   
2. </div>
   $ X2 T& u' p0 `# f- g+ ~: i( k
3. 
   + D2 ?3 @; x( {
4. <script>
   # F2 [9 w: }4 O
5. Vue.directive('runoob', {
   # v! e: f& y. `8 O# m% V3 o) B
6.   bind: function (el, binding, vnode) {
   
7.     var s = JSON.stringify
   
8.     el.innerHTML =
   
9.       'name: '       + s(binding.name) + '<br>' +
   
10.       'value: '      + s(binding.value) + '<br>' +
    $ t& t/ L( F+ }
11.       'expression: ' + s(binding.expression) + '<br>' +
    
12.       'argument: '   + s(binding.arg) + '<br>' +
    
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    ' B% \1 h( {  _. q. I9 ]& `" z" |9 S
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    
15.   }
    
16. })
    
17. new Vue({
    
18.   el: '#app',
    ! f- Y& D1 S/ O9 X- i# q
19.   data: {
    5 v0 D$ O0 C: a$ e9 C3 ]
20.     message: '菜鸟教程!'
    
21.   }
      v1 R3 A3 R1 R
22. })
    & l% I" }- P9 B( K4 \
23. </script>

复制代码

有时候我们不需要其他钩子函数，我们可以简写函数，如下格式：
- e# m$ L  e- S+ w% O9 S4 G% i3 D

1. Vue.directive('runoob', function (el, binding) {
   
2.   // 设置指令的背景颜色
   ( U- B1 c% Z: ], q5 U& ]  u6 L
3.   el.style.backgroundColor = binding.value.color
   9 Q9 u8 O9 m3 n1 F! c8 J
4. })

复制代码

( @4 X" F# Z0 a1 G4 ]

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

实例

! D* Y& H2 Y: Y* Z) x

1. <div id="app">
   
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
     @7 X( @. H' s$ l. ]" ?1 e
3. </div>
   ) `( {' ?, c3 k( }4 M
4. 
   
5. <script>
   0 o& z" I) r+ v/ n0 ?7 P; {
6. Vue.directive('runoob', function (el, binding) {
   ! f. O' s% i" k3 K: l
7.     // 简写方式设置文本及背景颜色
   
8.     el.innerHTML = binding.value.text
   
9.     el.style.backgroundColor = binding.value.color
   5 v7 |+ f4 f: Q# N
10. })
    + t' G# B: h; @' }; G+ K; n  b, n
11. new Vue({
    
12.   el: '#app'
    8 S9 p6 ^# g5 I: d4 B; G& y
13. })
      Q0 z3 ~' ^7 h' o) W
14. </script>

复制代码

1 d+ v2 `- P2 X9 E, s
% k' \/ l5 l/ r: |7 ~7 w
0 r3 c- L! Y& [