Vue.js 自定义指令

admin

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

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

实例

1. <div id="app">
   
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   
3.     <input v-focus>
   
4. </div>
   
5. 
   
6. <script>
   
7. // 注册一个全局自定义指令 v-focus
   ' c$ b5 }! ~4 R4 f/ I
8. Vue.directive('focus', {
   
9.   // 当绑定元素插入到 DOM 中。
   5 C0 n5 z7 D0 F1 r9 X, D* I
10.   inserted: function (el) {
    
11.     // 聚焦元素
    
12.     el.focus()
    # C% q, M( k2 C
13.   }
    5 O# z9 s' u  A4 |# E, W9 o/ f) \
14. })
    
15. // 创建根实例
    
16. new Vue({
    & \+ P0 o3 ~; n/ z3 E5 Q* ~
17.   el: '#app'
    
18. })
    6 m/ U, C& [: h9 |/ u6 Y
19. </script>

复制代码

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

实例
# E$ h( m$ z: S, ?) S2 Y0 P, @
0 g: s( N& _) t/ |' n% C

1. <div id="app">
   
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   
3.   <input v-focus>
   ( M5 E; I1 B9 L5 W
4. </div>
   
5. 
   3 y9 U% v8 {+ u7 g8 f
6. <script>
   . }! h# A$ ~$ f# U, q( c. u$ y
7. // 创建根实例
   ; l, |, ^+ g( K  _% r4 \1 m
8. new Vue({
   9 v& v* K7 c: l3 T2 R: T! q7 p
9.   el: '#app',
     H3 X9 {5 p: H3 L# F5 E* i# E
10.   directives: {
    
11.     // 注册一个局部的自定义指令 v-focus
    & P5 I1 j8 E  G/ O8 f
12.     focus: {
    # U' h* R# }" U3 q: w9 k
13.       // 指令的定义
    & @! X3 n, d) h" r( r" k, h
14.       inserted: function (el) {
    
15.         // 聚焦元素
    , M$ u) f% E* I2 }% c6 E7 A$ H0 A
16.         el.focus()
    ! z6 R1 U: L. u( t. F5 {+ C  Z+ a
17.       }
    
18.     }
    7 d: M0 s+ |8 z
19.   }
    
20. })
    3 S+ E: R1 Y3 J3 V! E/ Q+ M6 m, E9 l! t
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 钩子中可用。
  

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

实例

$ }* |2 v" F2 D; R+ `

1. <div id="app"  v-runoob:hello.a.b="message">
   
2. </div>
   
3. 
   , v$ @( y/ y0 c6 H- Z& E
4. <script>
   4 F( ^! Q% k' g; B8 Z7 D
5. Vue.directive('runoob', {
   
6.   bind: function (el, binding, vnode) {
   1 T9 o' _7 P6 _+ q# F& X
7.     var s = JSON.stringify
   
8.     el.innerHTML =
   
9.       'name: '       + s(binding.name) + '<br>' +
   , S0 z3 S4 ?+ \: P$ k0 ]) P) k
10.       'value: '      + s(binding.value) + '<br>' +
    
11.       'expression: ' + s(binding.expression) + '<br>' +
    ! P: J8 \( {0 H8 U5 M# y  J; M
12.       'argument: '   + s(binding.arg) + '<br>' +
    % }& M; r/ D: \
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
      {* Z) s1 i+ U/ R0 m8 ?" I
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    ! R1 l) P8 r( N" a
15.   }
    
16. })
    
17. new Vue({
    
18.   el: '#app',
    ( t9 J3 c( Q5 Q9 R
19.   data: {
    
20.     message: '菜鸟教程!'
    + w: ?- H' q8 o  o! f
21.   }
    
22. })
      D+ h3 F; {  o" `. I, m( Q! d
23. </script>

复制代码

有时候我们不需要其他钩子函数，我们可以简写函数，如下格式：
& s  M! o2 j: v9 }% h* w

1. Vue.directive('runoob', function (el, binding) {
   / M. z+ T! C5 X1 o, p# ~
2.   // 设置指令的背景颜色
   
3.   el.style.backgroundColor = binding.value.color
   1 G) k2 s! U! C4 [
4. })

复制代码

) ]/ N0 o: `. }' k

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

实例

1. <div id="app">
   
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   
3. </div>
   
4. 
   
5. <script>
   2 {' H8 F# g. C, q- T
6. Vue.directive('runoob', function (el, binding) {
   
7.     // 简写方式设置文本及背景颜色
   
8.     el.innerHTML = binding.value.text
   . G0 t& g7 v5 v& s( s
9.     el.style.backgroundColor = binding.value.color
   3 y6 L% M3 t- I% K0 |
10. })
    9 m  [6 t6 B" W  x, _
11. new Vue({
    1 n3 J5 c% `) H# ]6 C$ v) F% R
12.   el: '#app'
      W' ^. N3 y0 z3 [8 X* }
13. })
    9 O; L8 M$ W+ H3 C: V
14. </script>

复制代码

3 W+ i3 V8 Q* F) r

& a2 K. {5 f. H