Vue.js 自定义指令

admin

# [; e5 w8 e; G5 r' {8 A

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

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

实例

7 @8 i2 P7 G- Z5 b  D+ I

1. <div id="app">
   + _& C+ d, t+ `, i  m! N$ x
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   
3.     <input v-focus>
   
4. </div>
   
5. 
   
6. <script>
   # ]' q* B" J3 H; M: U7 q
7. // 注册一个全局自定义指令 v-focus
   & \, B4 R, H& u
8. Vue.directive('focus', {
   : N6 S- j, N9 P3 M6 w
9.   // 当绑定元素插入到 DOM 中。
   * d+ ?* I, X8 M7 J5 z' {" J& v( m* y
10.   inserted: function (el) {
    
11.     // 聚焦元素
    
12.     el.focus()
    ( s! x& f5 X4 w' P% d* e
13.   }
    
14. })
    , q# s" |# e7 o3 z  Z
15. // 创建根实例
    
16. new Vue({
    , M7 ^" i( O5 ^7 ^' \% C9 q! p
17.   el: '#app'
    $ ?2 W, g3 M+ ^3 r! V/ _
18. })
    
19. </script>

复制代码

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

实例
/ ^! x0 F' G- O+ _# D8 {) `- X* }

1. <div id="app">
   
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   % M  L4 |' C' |1 U
3.   <input v-focus>
   % N4 ?7 Y2 ~) h! Z. F( d
4. </div>
   
5. 
   
6. <script>
   6 o+ N/ [( |% E, V
7. // 创建根实例
   
8. new Vue({
   % V5 v' G: ?" L" ~6 n+ t
9.   el: '#app',
   
10.   directives: {
    & H3 R! f" n3 }/ ]4 S( d) r( e3 `4 S
11.     // 注册一个局部的自定义指令 v-focus
    ! V" V  b$ L: N  X8 b9 W
12.     focus: {
    ' p9 _7 Y2 g. A( C: C3 _& L
13.       // 指令的定义
    
14.       inserted: function (el) {
    ! Y% A+ c8 P& j+ A( X5 `  f
15.         // 聚焦元素
    8 h& @$ A7 x* l! f3 e, D
16.         el.focus()
    5 t9 `5 B9 E/ E$ _. H# R. u
17.       }
    9 R: A; f3 }. `0 o# h/ A. o9 m
18.     }
    
19.   }
    
20. })
    ( O% v- l' j0 @) k' ]
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 }。
    1 Y+ E+ @! Y8 a- M+ k4 N, i/ E' J
• vnode: Vue 编译生成的虚拟节点。
• oldVnode: 上一个虚拟节点，仅在 update 和 componentUpdated 钩子中可用。
  

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

实例
6 y0 w) ~. A( ]0 O1 E$ N7 M3 ~9 T
) W: j# ]$ t; A- a

1. <div id="app"  v-runoob:hello.a.b="message">
   
2. </div>
   
3. 
   
4. <script>
   
5. Vue.directive('runoob', {
   
6.   bind: function (el, binding, vnode) {
   ( Q2 u7 a( I1 ^* J9 i% y# k2 J
7.     var s = JSON.stringify
   % h! Z6 a' u$ m! l* {
8.     el.innerHTML =
   / Q0 x  s4 K; C- d
9.       'name: '       + s(binding.name) + '<br>' +
   
10.       'value: '      + s(binding.value) + '<br>' +
    
11.       'expression: ' + s(binding.expression) + '<br>' +
    
12.       'argument: '   + s(binding.arg) + '<br>' +
      \- ]9 X2 r: j7 B: c% J
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    0 @; F* j0 N* S
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    - z% Q1 y0 E+ W. G6 I
15.   }
    
16. })
    
17. new Vue({
    # x& i' Y0 p9 S7 G: B: z
18.   el: '#app',
    6 ~! Z  ?. Y0 R- s: z5 m
19.   data: {
    
20.     message: '菜鸟教程!'
    
21.   }
    " G# q9 u! m& F2 N8 l0 q% C& J
22. })
    ' u+ y2 I+ B9 \5 N$ N) P' Q
23. </script>

复制代码

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

1. Vue.directive('runoob', function (el, binding) {
   3 P7 J$ B( i0 w  m  n- w- U1 Y* @
2.   // 设置指令的背景颜色
   
3.   el.style.backgroundColor = binding.value.color
   
4. })

复制代码

! @5 Q5 r/ l' E5 e* v) T2 d

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

实例

1. <div id="app">
   
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   2 N# m6 W' \# I  n: R; e! I
3. </div>
   
4. 
   & e, u! r% B4 Q' ?2 q4 B
5. <script>
   
6. Vue.directive('runoob', function (el, binding) {
   3 ?+ {8 B" B1 G$ w7 l7 {$ K6 v$ m
7.     // 简写方式设置文本及背景颜色
   % ~9 u2 J7 K4 h4 K# l5 _% D
8.     el.innerHTML = binding.value.text
   5 a6 z2 O8 V2 l9 q2 X
9.     el.style.backgroundColor = binding.value.color
   
10. })
    
11. new Vue({
    # c9 Y# c& y+ Y6 y
12.   el: '#app'
    0 ~0 ?& j9 \. _
13. })
    
14. </script>

复制代码

. F3 l( f% D% D' m, ]! w5 W