Vue.js 自定义指令

admin

3 A9 O% m7 W- H" }. X1 q

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

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

实例
" `+ |: y8 f& C! Q) ], e. l' `2 Y1 g

1. <div id="app">
   
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   
3.     <input v-focus>
   
4. </div>
   
5. 
   
6. <script>
     Z: g# h3 s# y* x' p
7. // 注册一个全局自定义指令 v-focus
   
8. Vue.directive('focus', {
   
9.   // 当绑定元素插入到 DOM 中。
   
10.   inserted: function (el) {
      u& k0 ^+ _' i
11.     // 聚焦元素
    
12.     el.focus()
    ; ^/ y8 G! U! Y3 t. z* ^
13.   }
    : F; p$ J  {# D) |
14. })
    / q8 C0 A  t8 y/ l
15. // 创建根实例
    # `% _/ C/ i+ ?- W
16. new Vue({
    & c. I9 |' h1 N9 }; X
17.   el: '#app'
    0 ^; @2 ^) S& Q* ^
18. })
    
19. </script>

复制代码

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

实例
5 Q6 P8 y7 z4 {. ]# g* ~5 c
* T7 y, o+ r7 p& ]) @6 a' M7 o. H( w6 @

1. <div id="app">
   
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   - p, k& V5 @4 e% ~6 j- e* X- m3 m
3.   <input v-focus>
   & j1 J; a* |& Q5 |; M$ O: D8 x
4. </div>
   3 q0 _, x' R1 f, ^
5. 
   
6. <script>
   . b' h) G: H& a9 V% S* N
7. // 创建根实例
   
8. new Vue({
   0 X; E6 l, ^( s8 g8 t
9.   el: '#app',
   8 Q: Z2 s4 x8 u9 B: u
10.   directives: {
    
11.     // 注册一个局部的自定义指令 v-focus
    
12.     focus: {
    ( e5 h% d1 J7 c( @( `2 F" ]
13.       // 指令的定义
    " d6 `$ {* r6 ^9 n  C7 ]
14.       inserted: function (el) {
    
15.         // 聚焦元素
    - `( |; j! g0 \! F" y
16.         el.focus()
    
17.       }
    
18.     }
    
19.   }
    
20. })
    . Q+ d$ g2 f( |) ~- y' Z! A" ~
21. </script>

复制代码

钩子钩子函数

指令定义函数提供了几个钩子函数（可选）：

• bind: 只调用一次，指令第一次绑定到元素时调用，用这个钩子函数可以定义一个在绑定时执行一次的初始化动作。
• inserted: 被绑定元素插入父节点时调用（父节点存在即可调用，不必存在于 document 中）。
• update: 被绑定元素所在的模板更新时调用，而不论绑定值是否变化。通过比较更新前后的绑定值，可以忽略不必要的模板更新（详细的钩子函数参数见下）。
• componentUpdated: 被绑定元素所在模板完成一次更新周期时调用。
• unbind: 只调用一次， 指令与元素解绑时调用。
  
  : D" h+ h+ o. `- B, C/ O1 Q7 o

钩子函数参数

钩子函数的参数有：

• 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 `# p. H$ F9 P. i. A
• vnode: Vue 编译生成的虚拟节点。
• oldVnode: 上一个虚拟节点，仅在 update 和 componentUpdated 钩子中可用。
  ' ~, w8 Z! l, i4 o5 ]

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

实例
9 r- P+ d  s  I, H" }

1. <div id="app"  v-runoob:hello.a.b="message">
   
2. </div>
   . a: o3 J* _0 o2 L2 x0 D
3. 
   5 Q8 V2 [8 {" |# i
4. <script>
   
5. Vue.directive('runoob', {
   
6.   bind: function (el, binding, vnode) {
   . m+ s5 `* Z* T4 U5 v* j6 t3 g
7.     var s = JSON.stringify
   3 J6 L# I  X' d& }. l
8.     el.innerHTML =
   0 P" |: [( g$ |+ t5 N& P$ b
9.       'name: '       + s(binding.name) + '<br>' +
   ) R  x1 d& }) O' L  c/ q+ U
10.       'value: '      + s(binding.value) + '<br>' +
    
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(', ')
    
15.   }
    
16. })
    
17. new Vue({
    . Z1 i# t+ W" x3 o
18.   el: '#app',
    
19.   data: {
    / j* ?! A5 r& H9 z% o* M
20.     message: '菜鸟教程!'
    
21.   }
    
22. })
    
23. </script>

复制代码

有时候我们不需要其他钩子函数，我们可以简写函数，如下格式：
2 ]0 y" n6 [: E1 I4 ^" E! F

1. Vue.directive('runoob', function (el, binding) {
   
2.   // 设置指令的背景颜色
   ( p4 V& H% V* p2 ^9 i2 [$ E
3.   el.style.backgroundColor = binding.value.color
   ) z2 G8 N4 e5 ]
4. })

复制代码

. f3 z/ e  T, c

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

实例
! X: V9 O: k4 i6 z2 ], j; _/ j
' I) R' U% }0 ?' d7 U9 y

1. <div id="app">
   9 |$ o+ x# X- R+ e
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   3 W4 J2 B( J4 ]0 R% {7 M" _* z
3. </div>
   1 Q9 T/ l& V! Q
4. 
   " F, t' g6 p3 [+ K
5. <script>
   ! A5 x3 N% b. Y
6. Vue.directive('runoob', function (el, binding) {
   , Y6 ]4 O$ u% A% I( W
7.     // 简写方式设置文本及背景颜色
   7 p! j. J( j& v$ r5 ?& R% Z% P. I
8.     el.innerHTML = binding.value.text
   
9.     el.style.backgroundColor = binding.value.color
   , C2 f6 E* g" |3 m' V8 _
10. })
    . o! }, C. y& I. E, S4 U
11. new Vue({
    8 m3 t5 [3 n! t# \/ @3 n8 Q
12.   el: '#app'
    , |. h; {; h- i/ l* ^
13. })
    # X7 ]* ?3 p( i' F' w
14. </script>

复制代码