Vue.js 自定义指令

admin

7 L% m$ _6 I2 {7 [$ p( f

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

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

实例

1. <div id="app">
   
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   
3.     <input v-focus>
     m8 r; T( u% v0 \: _7 j1 U
4. </div>
   6 P& j# I3 x9 f, H3 G4 i: C
5. 
   + r- _3 c5 _: S' `& ~, Z6 c2 U
6. <script>
   3 n" N4 t3 _+ W7 d7 k5 K5 m
7. // 注册一个全局自定义指令 v-focus
   $ M0 w* h2 V, `6 G4 U
8. Vue.directive('focus', {
   ) F) t" k- C( [9 d2 O
9.   // 当绑定元素插入到 DOM 中。
   
10.   inserted: function (el) {
    8 ~1 x4 P( S, M, z( V
11.     // 聚焦元素
    4 P) Q2 d2 z$ U. ^% q, M
12.     el.focus()
    
13.   }
    
14. })
    
15. // 创建根实例
    
16. new Vue({
    
17.   el: '#app'
    
18. })
    
19. </script>

复制代码

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

实例

1. <div id="app">
   . R1 A5 E% p3 D+ s6 x
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   2 U8 l) S1 o: k( D" v
3.   <input v-focus>
   8 n6 E  s: r+ x8 e
4. </div>
   
5. 
   
6. <script>
   4 O! v  A0 r" G: h/ j$ Q) Y
7. // 创建根实例
   
8. new Vue({
   ; i9 K3 ~  c6 j" x, [# P+ y- f. B" _
9.   el: '#app',
   ) G, h! O  I6 [) z6 Z' w8 @
10.   directives: {
    
11.     // 注册一个局部的自定义指令 v-focus
    
12.     focus: {
    
13.       // 指令的定义
    ' T0 V: r0 i: h) j6 ^" @
14.       inserted: function (el) {
    
15.         // 聚焦元素
    
16.         el.focus()
    
17.       }
    
18.     }
    * O( _8 ^: f( _" Z0 n6 @4 V+ _1 O
19.   }
    
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 }。
    & ]- V( h/ N. l# e+ o% {& [
• vnode: Vue 编译生成的虚拟节点。
• oldVnode: 上一个虚拟节点，仅在 update 和 componentUpdated 钩子中可用。
  

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

实例

6 C; c: n* |1 d/ ~$ j1 O5 s+ B  T

1. <div id="app"  v-runoob:hello.a.b="message">
   0 ]: @6 I  d# n4 F8 C" \8 O# r
2. </div>
   ; U1 j& x, ]" m
3. 
   
4. <script>
   / V& h5 D1 X& ^$ n2 p
5. Vue.directive('runoob', {
   
6.   bind: function (el, binding, vnode) {
   
7.     var s = JSON.stringify
   
8.     el.innerHTML =
   
9.       'name: '       + s(binding.name) + '<br>' +
   
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. })
    : b; `/ [3 \# b$ s5 o3 h8 H6 {
17. new Vue({
    
18.   el: '#app',
    ( k5 R- n7 r/ I" y! H' \
19.   data: {
    
20.     message: '菜鸟教程!'
    , Y9 |" I" m- f3 F) }# Q9 m+ m! j& K
21.   }
    
22. })
    7 f2 u3 c6 X) }( C) s6 G* |' w) M
23. </script>

复制代码

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

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

复制代码

% Z  @9 i" c& ]2 ?% S6 I+ M% \

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

实例

1. <div id="app">
     Q4 F) E4 z: W# b& r
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   
3. </div>
   / U! I3 v9 H) W. U) R6 y( w* G* [
4. 
   ( o* G( C0 T* b: c, Y
5. <script>
   
6. Vue.directive('runoob', function (el, binding) {
   
7.     // 简写方式设置文本及背景颜色
   
8.     el.innerHTML = binding.value.text
   9 O- i' |: F0 E2 a/ U
9.     el.style.backgroundColor = binding.value.color
   
10. })
    . u5 T) l3 |9 X% q
11. new Vue({
    ; Y5 \- w: b. ~
12.   el: '#app'
    
13. })
    
14. </script>

复制代码