Vue.js 自定义指令

admin

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

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

实例

4 @% f3 z$ N+ |( w

1. <div id="app">
   
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   
3.     <input v-focus>
   
4. </div>
   
5. 
   
6. <script>
   # v0 y$ S' k* V7 j: l  w8 S
7. // 注册一个全局自定义指令 v-focus
   
8. Vue.directive('focus', {
   
9.   // 当绑定元素插入到 DOM 中。
   4 E" t3 c4 l, g- A& ^% [  I0 H* y
10.   inserted: function (el) {
    , w" ?* e) [& ], k  b& }9 R8 D( ~
11.     // 聚焦元素
    : D2 H- C( r, }5 U4 [) o
12.     el.focus()
    ' \( G, q! R  Q4 N
13.   }
    " S8 V6 D. }6 {
14. })
    
15. // 创建根实例
    
16. new Vue({
    
17.   el: '#app'
    & a7 z  F' j1 \9 ]3 r" b
18. })
    # n) n4 D) k9 I9 n- K
19. </script>

复制代码

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

实例
$ x( N1 ^- u! v) c0 f

1. <div id="app">
   
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   
3.   <input v-focus>
   ; K7 m9 _; _3 M- N. r  T. F2 \
4. </div>
   
5. 
   # ~9 t" E% u" P# [
6. <script>
   " a( N. d& W% E* r# h
7. // 创建根实例
     g! q" U% J; ^3 Q$ ?; O1 X
8. new Vue({
     t9 v- {6 l  l8 Z7 Y; ?
9.   el: '#app',
   
10.   directives: {
    / ?" Q0 O( f( A! a. m$ G
11.     // 注册一个局部的自定义指令 v-focus
    % H; Y1 G1 A4 o# Z4 ~6 D* \
12.     focus: {
    4 ^/ q2 U1 P( ^. @
13.       // 指令的定义
    * h' q4 Z( i0 R& M, \
14.       inserted: function (el) {
    
15.         // 聚焦元素
    * L4 a) K0 W0 _% x
16.         el.focus()
    
17.       }
      `: q6 q; q* @$ P- ~6 t- @
18.     }
    
19.   }
    5 d/ F' _- y8 p
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 }。
    , @/ R9 n/ {9 ?! b1 t5 R
• vnode: Vue 编译生成的虚拟节点。
• oldVnode: 上一个虚拟节点，仅在 update 和 componentUpdated 钩子中可用。
  

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

实例
# `" c: F% t% o2 o; k

1. <div id="app"  v-runoob:hello.a.b="message">
   
2. </div>
   7 X% J( O# \' z
3. 
   
4. <script>
   & C& f8 {5 g; ^5 w0 W
5. Vue.directive('runoob', {
   ( x" D. n2 W1 R1 s; [) O
6.   bind: function (el, binding, vnode) {
   - J; u; D2 f1 p, _2 r
7.     var s = JSON.stringify
   
8.     el.innerHTML =
   4 o, `$ D+ {( A8 d
9.       'name: '       + s(binding.name) + '<br>' +
   & I& {$ M! y' j2 a  z7 ?. k7 p1 Z
10.       'value: '      + s(binding.value) + '<br>' +
    
11.       'expression: ' + s(binding.expression) + '<br>' +
    ( e4 }3 o9 I4 U. g" R, T0 r
12.       'argument: '   + s(binding.arg) + '<br>' +
    
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
      {. ^& j" Q5 `9 w7 f* v" D: G
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    
15.   }
    9 {: k3 V. [2 y
16. })
    
17. new Vue({
    
18.   el: '#app',
    
19.   data: {
    
20.     message: '菜鸟教程!'
    / o8 d# m. ^* v" ^' X% G
21.   }
    
22. })
    + M7 n9 B# N! J+ t9 ~
23. </script>

复制代码

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

1. Vue.directive('runoob', function (el, binding) {
   
2.   // 设置指令的背景颜色
     c! a  N# Q; w$ w/ x
3.   el.style.backgroundColor = binding.value.color
   / D  U2 s# f# D- s
4. })

复制代码

) _1 I( r' K0 n* k5 n

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

实例

1. <div id="app">
   
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   
3. </div>
   ! Q6 q2 T( D% \, i  W
4. 
   . j* P6 [( t& a' a2 J
5. <script>
   # Z6 }- R( l; Y5 {
6. Vue.directive('runoob', function (el, binding) {
   
7.     // 简写方式设置文本及背景颜色
   
8.     el.innerHTML = binding.value.text
   * v% P( W% o1 F7 v) d- v
9.     el.style.backgroundColor = binding.value.color
   
10. })
    
11. new Vue({
    1 J% n7 A9 Z0 K( O" D/ s
12.   el: '#app'
    ' M1 N7 ?. I: k; A3 |1 Z4 y
13. })
    ; Y& L. U+ l) z+ M) L: b/ G
14. </script>

复制代码

3 ?$ o% w6 C( R" v