Vue.js 自定义指令

admin

6 h3 T- O: d% p( ~8 c1 Y& j

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

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

实例

" @( |: c. y7 s( {

1. <div id="app">
   / D' ?3 Q& j' c$ X8 y9 l- n
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   
3.     <input v-focus>
   ! r6 F! z7 A: p# q1 G* k3 Q
4. </div>
   ( R$ g+ E; ?" v6 [2 L; A
5. 
   3 }' g. z5 E6 j1 L% r
6. <script>
   
7. // 注册一个全局自定义指令 v-focus
   : O/ ]) b; j) a3 z: J; S8 e7 U
8. Vue.directive('focus', {
   4 l) @$ p" ^9 V- U& V( z- i( X$ U: ]
9.   // 当绑定元素插入到 DOM 中。
   * `* e3 [( t4 Q2 J* Y, [7 v
10.   inserted: function (el) {
    6 i. [+ k" `4 ^% N7 E, m; {
11.     // 聚焦元素
    
12.     el.focus()
    
13.   }
    / Y2 @/ p' I2 }% y
14. })
    . R* _  D  d9 b& W9 X
15. // 创建根实例
    
16. new Vue({
    % \( A1 Z) ]2 S) R6 A
17.   el: '#app'
    
18. })
    
19. </script>

复制代码

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

实例

8 }  @" b" ~" v% z4 c5 o. n

1. <div id="app">
   
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   
3.   <input v-focus>
   
4. </div>
   
5. 
   2 v0 {0 k* K, M! @3 L3 u
6. <script>
   
7. // 创建根实例
   
8. new Vue({
   
9.   el: '#app',
   
10.   directives: {
    . \8 R9 U% |6 X; {7 W/ [
11.     // 注册一个局部的自定义指令 v-focus
    , r$ M; a4 j, x( n
12.     focus: {
    
13.       // 指令的定义
    
14.       inserted: function (el) {
    
15.         // 聚焦元素
    
16.         el.focus()
    
17.       }
    
18.     }
    
19.   }
    
20. })
    . `. s& s+ @& V
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 }。
    + Y, C! @. l- z
• vnode: Vue 编译生成的虚拟节点。
• oldVnode: 上一个虚拟节点，仅在 update 和 componentUpdated 钩子中可用。
  

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

实例
5 d7 n. F$ W9 w. \
& k0 G$ d8 O' \  u  t7 `5 Q

1. <div id="app"  v-runoob:hello.a.b="message">
   
2. </div>
   " {. j  p3 y) {# ~, B0 j$ d  }- o
3. 
   
4. <script>
   
5. Vue.directive('runoob', {
   
6.   bind: function (el, binding, vnode) {
   
7.     var s = JSON.stringify
   
8.     el.innerHTML =
   6 s8 {8 H+ C4 @, E
9.       'name: '       + s(binding.name) + '<br>' +
   
10.       'value: '      + s(binding.value) + '<br>' +
    + A) j8 U* |. m9 `$ o( D( B
11.       'expression: ' + s(binding.expression) + '<br>' +
    # m- S' q: K$ S5 W% b9 l8 J$ x( P; E
12.       'argument: '   + s(binding.arg) + '<br>' +
    9 v+ p+ i# L2 }4 K, G4 A
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    / T4 u2 S5 `' \& q# t' ]- G+ g7 T6 P7 X5 D# }
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    
15.   }
    
16. })
    
17. new Vue({
    
18.   el: '#app',
    4 e0 J, _9 c' Y6 r8 |6 s. _* A
19.   data: {
    / X) S# v" E4 D3 ]7 ~' {
20.     message: '菜鸟教程!'
    
21.   }
    ; a: X1 P9 W0 L9 F- c  H( p# g  d
22. })
    ! x' @+ l2 {3 ~; j* @5 b# h$ x7 b9 a
23. </script>

复制代码

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

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

复制代码

% ~. ^$ ]! ^8 ?+ f& o

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

实例

1. <div id="app">
   
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   
3. </div>
   ; Y3 c' c" D& b0 b
4. 
   
5. <script>
   9 R$ v8 M/ u9 ?/ p+ f: v3 w/ p
6. Vue.directive('runoob', function (el, binding) {
   & v* |3 P# v4 `4 w
7.     // 简写方式设置文本及背景颜色
   6 @! J" M( A' K
8.     el.innerHTML = binding.value.text
   
9.     el.style.backgroundColor = binding.value.color
   ! |& s# C" R  c" r" X& _3 E6 L! [( Q
10. })
    
11. new Vue({
    & G3 ~' ~! U6 A0 W* l
12.   el: '#app'
    : X6 a* O, K! ?: W9 Z* H0 T# k
13. })
    " b! T" R; k6 J& K
14. </script>

复制代码

" l  J% ^$ K" t; h, K