Vue.js 自定义指令

admin

5 E$ X: D( K# ~/ Q0 }! x, I6 g

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

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

实例

9 w1 I3 V2 Z' j8 c* k( h8 m

1. <div id="app">
   & x2 N- I, l3 u
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   
3.     <input v-focus>
   . p' ]& g5 Y1 |; \# P; A- b
4. </div>
   / H6 P# x- v/ y. L9 E* S5 d! b& v7 h
5. 
   
6. <script>
   
7. // 注册一个全局自定义指令 v-focus
   4 P) ]* S$ h. ~8 q% ]
8. Vue.directive('focus', {
   
9.   // 当绑定元素插入到 DOM 中。
   
10.   inserted: function (el) {
    
11.     // 聚焦元素
    
12.     el.focus()
    . ?) b/ g+ n& c2 L7 X
13.   }
    
14. })
    
15. // 创建根实例
    
16. new Vue({
    , K' H: ?) d' v% E  i1 N
17.   el: '#app'
    
18. })
    
19. </script>

复制代码

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

实例
6 E; ~6 ]9 s4 O/ N( r9 S5 U, Z

1. <div id="app">
   5 [0 x4 F4 c9 |9 K& {- {
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   * T; y8 [/ f+ ]( |( _4 L
3.   <input v-focus>
   : G7 j& E2 b% [4 Q# v
4. </div>
   
5. 
   , v  F7 r0 K' }. {- K4 [' Z; Y& i
6. <script>
   % J9 X9 u5 v- Q( Z. a
7. // 创建根实例
   & `# c! T$ A$ Y; u  |( Y
8. new Vue({
   
9.   el: '#app',
   
10.   directives: {
    ( Q. F0 o0 \: f6 s2 V$ ]( ?
11.     // 注册一个局部的自定义指令 v-focus
    
12.     focus: {
    
13.       // 指令的定义
    
14.       inserted: function (el) {
    
15.         // 聚焦元素
    9 A& n6 X% q; N& ]' M
16.         el.focus()
    5 C; u; S5 B+ k* u5 m, Y% Y& d
17.       }
    , b' j& u& v, ]' U1 H" ^) K
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 }。
    
• vnode: Vue 编译生成的虚拟节点。
• oldVnode: 上一个虚拟节点，仅在 update 和 componentUpdated 钩子中可用。
  3 R: S# V2 z9 V( Z9 H+ W5 X% Y

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

实例
4 v' F6 r, P( J! |

1. <div id="app"  v-runoob:hello.a.b="message">
   
2. </div>
   : x, w; _3 P1 E" m  `' W
3. 
   ( H1 c6 Y: Z2 N3 p
4. <script>
   * m% r- e7 W$ F2 `: _6 Z
5. Vue.directive('runoob', {
   
6.   bind: function (el, binding, vnode) {
   & ^4 G0 u* y9 a& y7 f
7.     var s = JSON.stringify
   
8.     el.innerHTML =
   2 v/ M  j! T0 b
9.       'name: '       + s(binding.name) + '<br>' +
   % z/ T: a& p5 C: G3 P( ~
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.   }
    6 \3 |4 H& p7 t' U7 A: g$ x
16. })
    
17. new Vue({
    
18.   el: '#app',
      q! x9 z8 s2 a' k
19.   data: {
    ! g  ]+ v% [) R' ]  B6 X% _) J! ^
20.     message: '菜鸟教程!'
    
21.   }
    
22. })
    3 ]/ |# u+ k  e* j2 R0 m4 N
23. </script>

复制代码

有时候我们不需要其他钩子函数，我们可以简写函数，如下格式：
( }3 Q* t& u% i2 ~% K. ?+ a. n

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

复制代码

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

实例

1. <div id="app">
   
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   
3. </div>
   
4. 
   5 ~+ A; l$ ~% G4 s% ?( w" E
5. <script>
   9 o$ P+ J  B7 l
6. Vue.directive('runoob', function (el, binding) {
   
7.     // 简写方式设置文本及背景颜色
   4 C: M5 ^3 h; K% r1 T
8.     el.innerHTML = binding.value.text
   ! r/ C, A6 b+ V- j
9.     el.style.backgroundColor = binding.value.color
   
10. })
    
11. new Vue({
    / q$ N/ P6 L+ G6 H6 g
12.   el: '#app'
    
13. })
    
14. </script>

复制代码

/ a# Y, V6 J6 ?" B8 r