Vue.js 自定义指令

admin

8 q5 r0 @3 N$ j

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

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

实例
" ?4 V; F) }# v* y
3 a) s  c2 K9 x3 {7 m1 }: ~

1. <div id="app">
   
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   
3.     <input v-focus>
   
4. </div>
   6 u  Q* t- L3 H8 b: u0 r
5. 
   6 s" D/ k9 O9 _) }& Q- b3 a
6. <script>
   
7. // 注册一个全局自定义指令 v-focus
   
8. Vue.directive('focus', {
   - U% g2 K: g+ W$ a7 I
9.   // 当绑定元素插入到 DOM 中。
   
10.   inserted: function (el) {
    / v9 Y7 m% b0 @8 d- H, Z
11.     // 聚焦元素
    
12.     el.focus()
      o; M, d, C9 F2 p3 G1 Q
13.   }
    
14. })
    1 a& @5 ?. H0 R7 u  F
15. // 创建根实例
    
16. new Vue({
    
17.   el: '#app'
    ' |# X+ ]1 ~) S+ V- B/ i# M
18. })
    8 {& I2 G& e/ I0 S8 M' @7 F
19. </script>

复制代码

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

实例
! ^7 n; g8 V9 @8 M' i/ |

1. <div id="app">
   % h( D/ n' i) m3 C- z  X. T; o
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   
3.   <input v-focus>
   : W$ Q1 n: i3 F# i* u: X3 Q$ M
4. </div>
     i: u, u4 Q1 w: n2 O
5. 
   % P$ m3 O0 u$ p$ y% b
6. <script>
   
7. // 创建根实例
   - e3 x7 ?7 }# R& `2 q0 F( X# M
8. new Vue({
   
9.   el: '#app',
   . T2 n4 Z! N% {
10.   directives: {
    8 a; i4 \0 ~( l7 C
11.     // 注册一个局部的自定义指令 v-focus
    0 f+ _6 p( ~0 v7 f& v/ l
12.     focus: {
    
13.       // 指令的定义
    
14.       inserted: function (el) {
    
15.         // 聚焦元素
    4 f. R. ]: v. L; T/ [  Y
16.         el.focus()
    0 {) _  p! Y6 ~$ D4 f
17.       }
    " H* s( _1 m  k7 `' ^1 e
18.     }
      v9 v" q+ h1 Q4 k" O4 r
19.   }
    + y$ Y  C0 j: @9 C
20. })
    , i) ?0 Y- i4 h9 k
21. </script>

复制代码

钩子钩子函数

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

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

钩子函数参数

钩子函数的参数有：

• 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 钩子中可用。
  2 \) X8 z6 ?- ?" R! H7 z7 _

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

实例

& B8 p8 Q# }$ ]7 K$ D

1. <div id="app"  v-runoob:hello.a.b="message">
   ( T/ P% o- w* @& W& X: k6 A
2. </div>
   9 W& d; W: ^* [
3. 
   
4. <script>
   7 v# b, K' g. V' R+ Q
5. Vue.directive('runoob', {
   ) x2 p* U+ v" q: g, _
6.   bind: function (el, binding, vnode) {
   , ~. _& Q/ S1 O
7.     var s = JSON.stringify
   / c0 P( M, }4 L, I5 x
8.     el.innerHTML =
   ( J* q1 k# w7 T% C: ?% f( D
9.       'name: '       + s(binding.name) + '<br>' +
   : v0 z- _# t7 B7 F+ ~" }
10.       'value: '      + s(binding.value) + '<br>' +
    
11.       'expression: ' + s(binding.expression) + '<br>' +
    7 C3 `) P' T6 j% X" Y1 h
12.       'argument: '   + s(binding.arg) + '<br>' +
    6 ~  _. _$ s# J9 n( |1 q& q0 H2 p7 u
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    6 N( V8 u) y% g" Z7 _
15.   }
    3 ^+ y. V# P, G% s' Y
16. })
    
17. new Vue({
    $ z8 t' W7 l! J
18.   el: '#app',
      i9 r) T; k+ X6 [
19.   data: {
    9 }" t% P" O, {% }) {5 @# t
20.     message: '菜鸟教程!'
    
21.   }
    ! g% l" ?" g3 m8 Y
22. })
    ) D' H- a+ q7 a. u; o. e- L
23. </script>

复制代码

有时候我们不需要其他钩子函数，我们可以简写函数，如下格式：
; _6 I7 J+ a0 L2 I: U

1. Vue.directive('runoob', function (el, binding) {
   
2.   // 设置指令的背景颜色
   ( `5 i: m7 G: X3 V( P) ?! m4 {
3.   el.style.backgroundColor = binding.value.color
   
4. })

复制代码

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

实例

1. <div id="app">
   6 P9 ~6 [/ B$ W* d* Z: s
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   
3. </div>
   / |* ^) W) O* E. Q+ G1 G
4. 
   ( F9 H* u5 B  `* q8 M
5. <script>
   5 D9 M! p+ e0 d5 m- ]
6. Vue.directive('runoob', function (el, binding) {
   
7.     // 简写方式设置文本及背景颜色
   
8.     el.innerHTML = binding.value.text
   8 ?  j+ W# J& N- B/ z* t
9.     el.style.backgroundColor = binding.value.color
   & Q: J, s; H$ t; M- A6 X- p
10. })
    ' F" k8 U, p$ T* V  |% ]1 D
11. new Vue({
    : |" N1 Z  S+ ?( l7 e) ~
12.   el: '#app'
    5 o3 v- O5 R% e" i  ~
13. })
    
14. </script>

复制代码

4 W+ D. Q1 @. d% f) j" _  E