Vue.js 自定义指令

admin

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

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

实例

3 N0 ?2 ?+ I: s. B- _- _: [

1. <div id="app">
   
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   7 K2 c( o) `6 b7 p9 w
3.     <input v-focus>
   " I" m, H1 d2 F& H
4. </div>
   
5. 
   
6. <script>
   
7. // 注册一个全局自定义指令 v-focus
   1 B. f$ z1 a6 S, a9 |1 n2 |* b
8. Vue.directive('focus', {
   
9.   // 当绑定元素插入到 DOM 中。
   0 {: A$ E2 B5 |- b+ t
10.   inserted: function (el) {
    4 h3 a$ i1 c' q; j. s: P( l
11.     // 聚焦元素
    ! ]/ r* \9 w; w  d2 f& T
12.     el.focus()
    
13.   }
    
14. })
      Y. N; I! V# f6 V" W% H
15. // 创建根实例
    
16. new Vue({
    
17.   el: '#app'
    
18. })
    ( k5 @3 ~5 ^: t) z2 V
19. </script>

复制代码

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

实例
3 _( X9 L" w( w- t" A' w* ^

1. <div id="app">
   ) f& a% u: w8 Q9 P/ x- z' t
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   
3.   <input v-focus>
   
4. </div>
   
5. 
   
6. <script>
   
7. // 创建根实例
   + M! l" q' q! E* R
8. new Vue({
   " {  U  G( }$ x0 ^
9.   el: '#app',
   9 w" W3 G8 n, a; I3 c) k2 u
10.   directives: {
    
11.     // 注册一个局部的自定义指令 v-focus
    
12.     focus: {
      `- G  R1 C9 Y! I4 z
13.       // 指令的定义
    4 s# v& E4 ?5 C2 m. a& R# n. {
14.       inserted: function (el) {
    
15.         // 聚焦元素
    
16.         el.focus()
    $ Z& y5 v9 W; T: r4 m
17.       }
    1 H5 V  N/ n5 t+ f* `
18.     }
    
19.   }
    
20. })
    * y- n7 s) g/ U. U: S/ [. k2 `2 {
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 钩子中可用。
  

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

实例
( t( V, j9 |$ P/ J4 N0 o( U9 a
$ H2 ]1 m' w. R$ ~& D/ B" [! C4 J

1. <div id="app"  v-runoob:hello.a.b="message">
     _% q/ l* o6 Y
2. </div>
   
3. 
   ! q9 s& f8 S9 f4 V9 M& Q
4. <script>
   # f, X0 W. z& K: P
5. Vue.directive('runoob', {
   : I' m/ b5 ?! t1 j+ w# F9 U( R
6.   bind: function (el, binding, vnode) {
   0 c3 z+ k0 A/ N! s
7.     var s = JSON.stringify
   % R9 W: A1 c" {1 F
8.     el.innerHTML =
   " O* Y" d) Y5 {: |
9.       'name: '       + s(binding.name) + '<br>' +
   5 J1 O' P; q3 p% D
10.       'value: '      + s(binding.value) + '<br>' +
    # t, W5 z  `3 X
11.       'expression: ' + s(binding.expression) + '<br>' +
    5 O" m- o: P; z& D
12.       'argument: '   + s(binding.arg) + '<br>' +
    8 L1 o  c2 B+ M0 W: F, |
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    6 Y4 a9 R# C" ~+ D! \- i
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    9 y- T- {: P8 l& r; Y& D
15.   }
    5 y4 D' J: {7 [( w2 L
16. })
    
17. new Vue({
      t1 T1 [9 ?/ a( x$ j
18.   el: '#app',
    + o6 I2 X0 ]9 [3 }8 m
19.   data: {
    3 r# ?" l/ m* k4 z8 n
20.     message: '菜鸟教程!'
    ' U2 {, F7 S# {' W" E
21.   }
    
22. })
      I) j! }. o, Q& |) N( }
23. </script>

复制代码

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

1. Vue.directive('runoob', function (el, binding) {
   
2.   // 设置指令的背景颜色
   , A% k% Y) o* a5 }6 w/ ]5 V
3.   el.style.backgroundColor = binding.value.color
   
4. })

复制代码

8 a$ ^# }+ c. T) d; l4 ^& Y

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

实例
7 j! L; \% f6 h0 f+ h
  c4 T) I4 l1 T1 S7 q

1. <div id="app">
   
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   $ I6 A- l* D: B9 Q4 w4 \1 L
3. </div>
   * u* w; A. y" V% Q8 }: h
4. 
     m+ \4 p9 s/ U9 B" t3 l+ N* J
5. <script>
   1 q: B) u( D/ }% n
6. Vue.directive('runoob', function (el, binding) {
   
7.     // 简写方式设置文本及背景颜色
   
8.     el.innerHTML = binding.value.text
   , ^4 i7 V$ y% J- V) I' j
9.     el.style.backgroundColor = binding.value.color
   7 x. q3 M* Q. ?" U8 C( B' L! V0 T/ \
10. })
    % s8 ~2 M- {( x: J# p1 E; J
11. new Vue({
    
12.   el: '#app'
    
13. })
    
14. </script>

复制代码

0 G5 k: v8 w+ X) b- j
- Z, m( V3 ]7 F; _% P
# T0 R( m/ j4 f) Y' H