Vue.js 自定义指令

admin

: u& H, q0 J; [

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

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

实例

6 o; |& b4 E$ @# y8 N; u. e

1. <div id="app">
   
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   ) e/ A# w& e8 `2 B; J6 [3 W* J
3.     <input v-focus>
   
4. </div>
   
5. 
   " i3 h4 C: Q. j" P2 L" _8 w
6. <script>
   
7. // 注册一个全局自定义指令 v-focus
   
8. Vue.directive('focus', {
   
9.   // 当绑定元素插入到 DOM 中。
   3 o# h- g) \# Z6 N0 d5 d; K
10.   inserted: function (el) {
    8 E6 n+ Z+ |/ F6 f; u" X+ b. d
11.     // 聚焦元素
    
12.     el.focus()
    * c, Q- T$ R) ~# b
13.   }
    
14. })
    ; l5 `% L. w9 q; Q
15. // 创建根实例
    . F: z# B9 W/ J! I
16. new Vue({
    ! ~: O( U3 T, D" t
17.   el: '#app'
    + U, R. u- H6 \* s
18. })
    
19. </script>

复制代码

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

实例
# U. {# k  z+ s8 c

1. <div id="app">
   6 p* R: n7 J$ O/ r( p' r, f3 ?: E- Q
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   6 e6 x8 {. a' B8 z
3.   <input v-focus>
   
4. </div>
   
5. 
   
6. <script>
   
7. // 创建根实例
   1 w' v( K6 l7 i6 J
8. new Vue({
   
9.   el: '#app',
   
10.   directives: {
      b& s7 X3 t$ v6 \" g7 u3 F
11.     // 注册一个局部的自定义指令 v-focus
    
12.     focus: {
    
13.       // 指令的定义
    % _9 y) v0 @: j7 q' i
14.       inserted: function (el) {
    
15.         // 聚焦元素
    
16.         el.focus()
    
17.       }
    # B+ k7 w5 Q6 f4 H8 }
18.     }
    
19.   }
    1 W$ x% v- x( Z
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 钩子中可用。
  

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

实例

1. <div id="app"  v-runoob:hello.a.b="message">
   0 B) R! E: k5 Y# G$ i
2. </div>
   ! P2 P. i, {  I6 F
3. 
   
4. <script>
   " Q2 m# j; z) [8 D
5. Vue.directive('runoob', {
   
6.   bind: function (el, binding, vnode) {
   3 C. x. I( T6 I. G+ w
7.     var s = JSON.stringify
   
8.     el.innerHTML =
   
9.       'name: '       + s(binding.name) + '<br>' +
   
10.       'value: '      + s(binding.value) + '<br>' +
    : g9 v" M! N- M) B
11.       'expression: ' + s(binding.expression) + '<br>' +
    
12.       'argument: '   + s(binding.arg) + '<br>' +
    * M7 B3 W1 ]4 S6 a! o
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    " V' d. }: j) X" t& Z
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    ; q& |- E9 O) ^) E
15.   }
    
16. })
    / T# D, X. y% H
17. new Vue({
    
18.   el: '#app',
    
19.   data: {
    
20.     message: '菜鸟教程!'
    0 m- J" A: p: z4 o
21.   }
    
22. })
    1 g5 p+ m% Y' t5 r; a6 S
23. </script>

复制代码

有时候我们不需要其他钩子函数，我们可以简写函数，如下格式：
4 U: x$ a! ^' @) E7 S

1. Vue.directive('runoob', function (el, binding) {
   
2.   // 设置指令的背景颜色
   
3.   el.style.backgroundColor = binding.value.color
   2 `& K+ k$ M& ~) V
4. })

复制代码

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

实例

- K" {- ?5 w$ c9 L2 T

1. <div id="app">
   0 D; J& y9 d3 e: W
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   & g3 b4 X* S& h1 a* C2 h+ N& k7 e2 T4 G
3. </div>
   ; m0 ?/ @( b- B% N3 [$ u& W( i
4. 
   
5. <script>
   
6. Vue.directive('runoob', function (el, binding) {
   
7.     // 简写方式设置文本及背景颜色
   
8.     el.innerHTML = binding.value.text
   
9.     el.style.backgroundColor = binding.value.color
   
10. })
    1 ^/ ~- ?1 {, C/ a/ j1 q# u% _
11. new Vue({
    
12.   el: '#app'
    ' y" o& I( ~- E" E
13. })
    
14. </script>

复制代码

% _% p9 W+ ]2 p5 @