Vue.js 自定义指令

admin

1 E4 W% v3 q9 r9 n. b& P, C

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

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

实例

7 T, W3 A) [" d

1. <div id="app">
   
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   
3.     <input v-focus>
   1 O; b' G, B1 l) ~/ U+ K
4. </div>
   1 n( K# K1 {+ ]% B/ |2 V4 b/ `
5. 
   4 N& b' B- ?* _
6. <script>
   ( H: G  r& w7 ?9 ]) c
7. // 注册一个全局自定义指令 v-focus
   
8. Vue.directive('focus', {
   " `& k( U( N; h5 M1 Z  o+ E
9.   // 当绑定元素插入到 DOM 中。
   ' ^" t3 Z" l2 g% r1 Y
10.   inserted: function (el) {
    2 g8 k4 I7 t5 {+ z1 C* G8 F8 _" ?+ x; i
11.     // 聚焦元素
      F- C5 I. ]( L- D2 V6 L. k/ D# O# ^
12.     el.focus()
    
13.   }
    
14. })
    3 t) }3 x  q: W4 X# z: Z  R
15. // 创建根实例
    ( x9 R% t, Y8 u* h8 Y+ s
16. new Vue({
    
17.   el: '#app'
    
18. })
    
19. </script>

复制代码

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

实例

+ U+ m9 b2 p, r8 T2 h

1. <div id="app">
   
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   
3.   <input v-focus>
   
4. </div>
   
5. 
   
6. <script>
   
7. // 创建根实例
   
8. new Vue({
   , I2 @% }2 K2 z$ @: @( M4 z
9.   el: '#app',
   
10.   directives: {
    
11.     // 注册一个局部的自定义指令 v-focus
    ; c6 W* R1 f$ k- n! |
12.     focus: {
    
13.       // 指令的定义
    
14.       inserted: function (el) {
    
15.         // 聚焦元素
    : {: `- [- h& G6 T# ~) w
16.         el.focus()
    
17.       }
    . v% w" S  J8 N5 g$ D+ P
18.     }
    
19.   }
    # P1 o) a& c& G& u5 t( f% }; V% X
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 }。
    " x/ K. b4 c, W0 P% E$ E5 t
• vnode: Vue 编译生成的虚拟节点。
• oldVnode: 上一个虚拟节点，仅在 update 和 componentUpdated 钩子中可用。
  ' N% c0 e* {# B4 T# P" A! B- p

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

实例

/ K, E6 B8 h$ \$ j; Q

1. <div id="app"  v-runoob:hello.a.b="message">
   
2. </div>
     ]+ I) L: d8 g) \$ Q
3. 
   
4. <script>
   / Q( N- W8 B: m% l' \& |
5. Vue.directive('runoob', {
   ' i; D& A6 V" {9 C) M. f
6.   bind: function (el, binding, vnode) {
   
7.     var s = JSON.stringify
   ) S3 m" X# q: v
8.     el.innerHTML =
   
9.       'name: '       + s(binding.name) + '<br>' +
   
10.       'value: '      + s(binding.value) + '<br>' +
    ( u3 d; e) P7 k9 J) j! Q3 F9 _6 L6 ]
11.       'expression: ' + s(binding.expression) + '<br>' +
    
12.       'argument: '   + s(binding.arg) + '<br>' +
    
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    2 A7 ~( f- m" S. Z/ ]. {; `
15.   }
    
16. })
    
17. new Vue({
    
18.   el: '#app',
    0 n9 _" u. k" X' _, K6 T$ p
19.   data: {
    
20.     message: '菜鸟教程!'
    
21.   }
    , t  {, f: N" D" @2 c2 \
22. })
    
23. </script>

复制代码

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

1. Vue.directive('runoob', function (el, binding) {
   
2.   // 设置指令的背景颜色
   
3.   el.style.backgroundColor = binding.value.color
   
4. })

复制代码

' c# N& K- v7 U
- J! B9 q% V$ q9 a5 S$ p

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

实例

1. <div id="app">
   6 G! P+ Y% A' m
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   / B3 E8 u: E- U( g( Q- \
3. </div>
   5 R3 A) F+ D! m2 g
4. 
   
5. <script>
   $ F0 [4 H- E2 U+ p
6. Vue.directive('runoob', function (el, binding) {
   
7.     // 简写方式设置文本及背景颜色
   8 f1 y1 z0 u; R8 r6 T$ Z- r
8.     el.innerHTML = binding.value.text
   
9.     el.style.backgroundColor = binding.value.color
   & u" U5 o0 q" v0 `9 v$ ~1 n  i" z+ w. T9 v/ T
10. })
    ; D( ?3 o: d5 ]$ G) Z& [
11. new Vue({
    - V! A2 x3 V$ v  f: h1 R  G: T
12.   el: '#app'
    / o) r; L) V( ?& d. m$ {
13. })
    & a! w$ d" B4 I/ @- x$ A8 x
14. </script>

复制代码

! I2 V  d" w2 |  F5 C: p+ @
; i! p. d% v# j' F3 @" D