Vue.js 自定义指令

admin

1 {: l7 i7 M# {% K2 `2 c: {

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

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

实例

1. <div id="app">
   
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   . L* `# a0 r, `3 n* \6 O' K& X: H4 T1 s
3.     <input v-focus>
   
4. </div>
   $ a8 T. [3 J2 I* O; u
5. 
     W  p- p( q* F+ n3 y: C" K$ N
6. <script>
   0 a. D. e$ f: q  I; Y6 o
7. // 注册一个全局自定义指令 v-focus
   
8. Vue.directive('focus', {
   . `7 ?1 Y- b: s) }# x9 Z) F" v
9.   // 当绑定元素插入到 DOM 中。
   & `! x8 o8 A) D/ W$ s7 W$ O
10.   inserted: function (el) {
    - Y' g# H/ U* T. d4 R8 i( q
11.     // 聚焦元素
    / J4 Q: x; M: T& z
12.     el.focus()
    
13.   }
    5 ], |% A- V3 v, m2 f' V1 A
14. })
    # N( [5 U3 K8 K9 r5 K2 b
15. // 创建根实例
    
16. new Vue({
    ; |0 K# Z) x' C6 b3 `
17.   el: '#app'
    
18. })
    . O( b8 J3 ~( v. g
19. </script>

复制代码

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

实例

8 q) L  l9 N) I9 V  A1 |0 f

1. <div id="app">
   - \$ D9 K: l5 W& i
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   2 f  F2 ?: l2 v7 l  c
3.   <input v-focus>
   
4. </div>
   
5. 
   - R# M0 z4 l  c6 W; i
6. <script>
   
7. // 创建根实例
   " q$ C- E: [6 q  t- w5 X
8. new Vue({
   
9.   el: '#app',
   
10.   directives: {
    6 ~3 c# v$ |; ^2 S( J
11.     // 注册一个局部的自定义指令 v-focus
    / w* p' Z; L+ i" g
12.     focus: {
    
13.       // 指令的定义
    . E6 E4 _1 }- m9 J* C
14.       inserted: function (el) {
    1 c3 p5 ]. t) h; P* f" f
15.         // 聚焦元素
    ! O2 J7 Q. l  t( u# J; m
16.         el.focus()
      }, O/ V; |, ?, t" \
17.       }
    , K1 ]4 X9 u/ G
18.     }
    
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 钩子中可用。
  + M5 p0 z9 F3 F- S

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

实例

1. <div id="app"  v-runoob:hello.a.b="message">
   " o5 b& t; O" Y) Q
2. </div>
   ( ^6 Y9 ^8 s7 z9 ]
3. 
   
4. <script>
   
5. Vue.directive('runoob', {
   
6.   bind: function (el, binding, vnode) {
   & K( v/ H$ F  C8 m4 z
7.     var s = JSON.stringify
   8 E& L+ r% x6 ^. ~% u
8.     el.innerHTML =
   
9.       'name: '       + s(binding.name) + '<br>' +
   $ S: L( B5 h$ m, \; R  e3 L  l9 Z
10.       'value: '      + s(binding.value) + '<br>' +
    
11.       'expression: ' + s(binding.expression) + '<br>' +
    
12.       'argument: '   + s(binding.arg) + '<br>' +
    
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    % z: ?+ E7 X9 ~8 g1 d
15.   }
    
16. })
    
17. new Vue({
    
18.   el: '#app',
    6 f5 p, r# T1 h7 c6 b
19.   data: {
    
20.     message: '菜鸟教程!'
    
21.   }
    
22. })
    0 t% Q; Y0 v8 a5 K& }* B( _5 j# b
23. </script>

复制代码

有时候我们不需要其他钩子函数，我们可以简写函数，如下格式：
* p0 _( @: M) g) Q3 H" B

1. Vue.directive('runoob', function (el, binding) {
   
2.   // 设置指令的背景颜色
   
3.   el.style.backgroundColor = binding.value.color
   + U. p, }! W& p- j$ v7 E# `/ g  S
4. })

复制代码

& H' f6 h. i# }4 X7 |' x
" L1 V# C. @' _$ M6 d. U9 Z

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

实例
; r3 q4 \* U. W; c6 l+ {& S  y
% s5 p" {: T) P* B

1. <div id="app">
   ; V+ x$ a2 g! Q( w
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   ! Q* X+ }1 k& Z" K( {  ?9 X8 ?
3. </div>
   0 l: I; U1 P; t, x
4. 
   ( q+ D  A: Y4 n! W- Y
5. <script>
   
6. Vue.directive('runoob', function (el, binding) {
     _9 }" T( g9 h  r
7.     // 简写方式设置文本及背景颜色
   
8.     el.innerHTML = binding.value.text
   
9.     el.style.backgroundColor = binding.value.color
   
10. })
    
11. new Vue({
    ' L: d1 l4 P, v& G: V0 J
12.   el: '#app'
    . K  W( }. Y! j" r9 q5 `
13. })
    
14. </script>

复制代码

+ ]0 j  I8 _# t" S4 k4 `$ D$ G