Vue.js 自定义指令

admin

  Q5 G4 o1 m$ V$ Q+ V2 ~

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

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

实例

& f+ J( r% v3 h) s

1. <div id="app">
   
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   8 Y% ^9 N5 f2 H9 B( N
3.     <input v-focus>
   
4. </div>
   
5. 
   5 u3 P: H" N' C% ~9 c7 n
6. <script>
   
7. // 注册一个全局自定义指令 v-focus
   " g- [1 l% @7 w: o6 B* e
8. Vue.directive('focus', {
   
9.   // 当绑定元素插入到 DOM 中。
   
10.   inserted: function (el) {
    
11.     // 聚焦元素
    ) V- O: G. n, z+ r
12.     el.focus()
    
13.   }
    
14. })
    2 ~& x8 y1 Z- ^9 a4 V5 Y
15. // 创建根实例
    
16. new Vue({
    7 |- s9 s# v1 ]8 o# K# ~
17.   el: '#app'
    
18. })
    3 V8 J! B( o2 s  L; D# u& s
19. </script>

复制代码

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

实例
# B" ?7 K6 Y8 R
  D$ E$ C( ^6 {: ?1 w

1. <div id="app">
   0 D0 G' T; d( ~& D
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   . t1 n" @& V  Q! j' d4 Z" L
3.   <input v-focus>
   
4. </div>
   
5. 
   
6. <script>
   4 f. F$ u$ T, _  R2 Y4 C
7. // 创建根实例
   6 y2 o7 I3 e: t4 x! g! X7 A3 l
8. new Vue({
   1 i  {8 Y# v3 J5 i8 L/ M7 f
9.   el: '#app',
   " h3 f9 V2 T2 z$ `
10.   directives: {
    : ]0 A. ^' w. p) c
11.     // 注册一个局部的自定义指令 v-focus
    
12.     focus: {
    2 d& l' D1 z% ^; }. l+ K6 O) X+ P
13.       // 指令的定义
    6 e6 k, A) m) s
14.       inserted: function (el) {
    
15.         // 聚焦元素
    
16.         el.focus()
    * m0 v6 _0 _# A& l
17.       }
    5 |1 |6 S% P4 L- d; L# ~/ Z' X
18.     }
    
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 }。
    0 V! Z' d# P; p7 g9 h
• vnode: Vue 编译生成的虚拟节点。
• oldVnode: 上一个虚拟节点，仅在 update 和 componentUpdated 钩子中可用。
  

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

实例
/ Q& F3 U1 e# x- Q! q  u
/ c1 a( Y- k% d: z1 E  L: f

1. <div id="app"  v-runoob:hello.a.b="message">
   2 r) [+ Q" c$ t) l; i- ?
2. </div>
   
3. 
   ! }4 L, d) a7 a3 f7 a
4. <script>
   
5. Vue.directive('runoob', {
   4 [5 G+ n  D* h: x& ^1 h
6.   bind: function (el, binding, vnode) {
   ' @' G* J# O0 U2 k
7.     var s = JSON.stringify
   
8.     el.innerHTML =
   & @( N3 i; ?* @4 ~. i+ z9 D
9.       'name: '       + s(binding.name) + '<br>' +
   
10.       'value: '      + s(binding.value) + '<br>' +
    3 p7 w  p# x2 C3 \3 Z; @
11.       'expression: ' + s(binding.expression) + '<br>' +
    5 n: d5 @; X* B- X9 L
12.       'argument: '   + s(binding.arg) + '<br>' +
    % t: n; F; n  V4 G- V
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    
15.   }
    
16. })
    
17. new Vue({
    
18.   el: '#app',
    $ ~5 V0 ^, H0 g8 J
19.   data: {
    
20.     message: '菜鸟教程!'
    0 M& X: n# P) ~1 C- w3 X. T& a
21.   }
    : |3 P! P. C% y( F1 a& o
22. })
    
23. </script>

复制代码

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

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

复制代码

/ A: T6 V5 L" h5 ^) L3 {

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

实例
, }; {7 r5 @+ L3 D# p5 }
7 S4 R  x6 p( s' j- D

1. <div id="app">
   9 b3 K, x, G( ~
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   9 ]: B& ^$ q2 A' I
3. </div>
   
4. 
   
5. <script>
   
6. Vue.directive('runoob', function (el, binding) {
   
7.     // 简写方式设置文本及背景颜色
   " y! o5 x! z% `! O) ~
8.     el.innerHTML = binding.value.text
   ' G/ ~1 ]; b  L+ s8 b8 o; Y
9.     el.style.backgroundColor = binding.value.color
   
10. })
    
11. new Vue({
    . Y+ K# B7 d. Q/ Q: K8 x
12.   el: '#app'
    
13. })
    
14. </script>

复制代码

2 `+ m% `9 a1 T& X8 n2 ~