Vue.js 自定义指令

admin

# U" p9 D: W/ d- S8 I8 [: Z

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

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

实例

1. <div id="app">
   
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   
3.     <input v-focus>
   
4. </div>
   
5. 
   - I) y$ e& k( o8 }+ ^# u" N
6. <script>
   8 T1 g! ~- R' L  c5 u% h# H
7. // 注册一个全局自定义指令 v-focus
   
8. Vue.directive('focus', {
   
9.   // 当绑定元素插入到 DOM 中。
   
10.   inserted: function (el) {
    
11.     // 聚焦元素
    
12.     el.focus()
    4 k8 M# l! c* K5 }/ V/ Q0 ^# }
13.   }
    6 s; y4 F* a% z" q( p& e4 r
14. })
    % L, L; J% b5 E
15. // 创建根实例
    
16. new Vue({
    ' _4 @2 f/ O# V) k# ~* D/ \: y- U
17.   el: '#app'
    
18. })
    
19. </script>

复制代码

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

实例

1. <div id="app">
   
2.   <p>页面载入时，input 元素自动获取焦点：</p>
     X! \+ x* @4 H+ V/ l
3.   <input v-focus>
   . ^0 W# e, u0 [
4. </div>
   7 J% W# k& I  B. t8 o! S) y$ u2 \
5. 
   
6. <script>
   - j# S, `/ q1 I) q
7. // 创建根实例
   
8. new Vue({
   3 |6 T) M2 q# R  a  U& ?& v9 ?9 p
9.   el: '#app',
   0 L. Q1 N0 k9 v. F3 {% t
10.   directives: {
    # i/ K6 h$ u& T3 {7 P
11.     // 注册一个局部的自定义指令 v-focus
    6 J4 n8 K  `  T7 V+ O& Q
12.     focus: {
    1 G7 Z7 @4 e  a. ]' j  N- N
13.       // 指令的定义
    
14.       inserted: function (el) {
    
15.         // 聚焦元素
    
16.         el.focus()
    - s: p7 U8 n' s* I: t3 [% @
17.       }
    
18.     }
    
19.   }
    
20. })
    ) d9 A3 f% ]' M9 `! t) Z$ Q; F
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 }。
    8 L- }; h% b5 u  _: r/ D
• vnode: Vue 编译生成的虚拟节点。
• oldVnode: 上一个虚拟节点，仅在 update 和 componentUpdated 钩子中可用。
  

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

实例

1. <div id="app"  v-runoob:hello.a.b="message">
   " H  c3 S. [5 p+ N
2. </div>
   ! K5 e! i$ \" g" N
3. 
   + V. J; n" @9 C; m+ q
4. <script>
   & `7 c( A- J  f
5. Vue.directive('runoob', {
   / H$ W& v4 f; X2 b. Y4 n7 ]) n- e
6.   bind: function (el, binding, vnode) {
   
7.     var s = JSON.stringify
   
8.     el.innerHTML =
   
9.       'name: '       + s(binding.name) + '<br>' +
   : Q; j* R. G5 V; l7 d5 r6 {; J
10.       'value: '      + s(binding.value) + '<br>' +
    % o! V) \% S3 J9 O- o2 {; U
11.       'expression: ' + s(binding.expression) + '<br>' +
    
12.       'argument: '   + s(binding.arg) + '<br>' +
    
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    ! L" x* k, ]+ ?. D
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    7 ?" B* F( w  k. j
15.   }
    / z" ^  J3 G0 y0 y! |: A
16. })
    
17. new Vue({
    
18.   el: '#app',
      X7 I: p% ~# B
19.   data: {
    + X7 E; \1 t' T! Y
20.     message: '菜鸟教程!'
    
21.   }
    
22. })
    
23. </script>

复制代码

有时候我们不需要其他钩子函数，我们可以简写函数，如下格式：
' k7 L& u& M: E/ X" |

1. Vue.directive('runoob', function (el, binding) {
   . J5 ?* N* D/ U9 ^# ]  N* b
2.   // 设置指令的背景颜色
   
3.   el.style.backgroundColor = binding.value.color
   
4. })

复制代码

5 q/ ?9 H: u; Y' y2 z( t

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

实例

$ o" V) Q1 \1 |; q1 H, E

1. <div id="app">
   
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   * g+ D" t+ V+ o: z
3. </div>
   8 e- A3 q0 g( h: u  W
4. 
   
5. <script>
   
6. Vue.directive('runoob', function (el, binding) {
   
7.     // 简写方式设置文本及背景颜色
   
8.     el.innerHTML = binding.value.text
   / U8 G+ d( m5 L5 }
9.     el.style.backgroundColor = binding.value.color
   9 J: @, F) |% [. k& x: Q; y( ?
10. })
    
11. new Vue({
    
12.   el: '#app'
    0 X' ?# Q/ p/ Q- I6 L5 ^" m
13. })
    
14. </script>

复制代码

6 q' c- V. Y; y  `

$ T- _+ |& \7 Q