Vue.js 自定义指令

admin

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

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

实例
& o: ?/ F2 t: P' {

1. <div id="app">
   ( p9 R) y5 e9 P. K
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   
3.     <input v-focus>
   
4. </div>
   
5. 
   
6. <script>
   , L' c: ]6 x' O4 c3 f0 T% _: q/ Y
7. // 注册一个全局自定义指令 v-focus
   
8. Vue.directive('focus', {
   5 G. O) R6 n" U! [9 s; R: `
9.   // 当绑定元素插入到 DOM 中。
   1 b/ U5 n8 E# J1 r, O$ h) s
10.   inserted: function (el) {
    % J7 ]7 ~) @, b/ r% v+ T, A' n
11.     // 聚焦元素
    
12.     el.focus()
    / m- f3 u4 u2 c( H: g% M) t. y7 y
13.   }
    
14. })
    4 o& t0 k1 n+ Y- p5 y2 U% {
15. // 创建根实例
    / X7 F  ?6 K0 }! Y' c1 }- i* F" h
16. new Vue({
    
17.   el: '#app'
    1 g1 N+ v2 h; Q, h4 ]: J, s, s
18. })
    
19. </script>

复制代码

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

实例
! G- P4 c3 Z9 b5 H# W

1. <div id="app">
   " O5 z& P! ~8 z: Q6 v0 Z
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   
3.   <input v-focus>
   
4. </div>
   
5. 
   
6. <script>
   $ g) k: D& o$ n
7. // 创建根实例
   
8. new Vue({
   + ^" _4 M, ]1 W3 M$ H6 ]/ {
9.   el: '#app',
   9 }- x% E# n- p& H0 b
10.   directives: {
    
11.     // 注册一个局部的自定义指令 v-focus
    
12.     focus: {
    . C. I# U/ @% h- r
13.       // 指令的定义
    
14.       inserted: function (el) {
    
15.         // 聚焦元素
    
16.         el.focus()
    - q* a1 g% u6 u# g0 o# j
17.       }
    
18.     }
    
19.   }
    # q; `% R& L! k- U3 e; S2 V
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 }。
    * L+ H" S9 z" [0 i' ^
• vnode: Vue 编译生成的虚拟节点。
• oldVnode: 上一个虚拟节点，仅在 update 和 componentUpdated 钩子中可用。
  " r. ^9 l3 N6 G# R" [  U0 Z

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

实例
# }" ^) i4 n5 b' ~( j6 S0 x) w6 ^0 z

1. <div id="app"  v-runoob:hello.a.b="message">
   
2. </div>
   
3. 
   
4. <script>
   + t4 c$ |' ~: V' T/ s7 s# D7 w
5. Vue.directive('runoob', {
   
6.   bind: function (el, binding, vnode) {
   
7.     var s = JSON.stringify
   & e. W: N" S& E+ ?, k
8.     el.innerHTML =
     }/ ^& p4 L2 x4 Q1 o  I
9.       'name: '       + s(binding.name) + '<br>' +
   
10.       'value: '      + s(binding.value) + '<br>' +
    + {' ?4 `/ q* F" F9 I9 a. M" A
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. })
    
17. new Vue({
    - c. z8 ?+ H, n# S. h3 [8 e- E1 |
18.   el: '#app',
    - K8 N/ g3 G% T- i6 C6 c6 p
19.   data: {
    6 W7 x* c5 B5 C& ?0 ?" |1 C1 p
20.     message: '菜鸟教程!'
    
21.   }
    
22. })
    
23. </script>

复制代码

有时候我们不需要其他钩子函数，我们可以简写函数，如下格式：
- v+ k9 b! X( Z: t

1. Vue.directive('runoob', function (el, binding) {
   7 k2 ?1 _) i% a5 U8 S7 G9 p
2.   // 设置指令的背景颜色
   , [6 n% Z5 X: M: f$ Z! }
3.   el.style.backgroundColor = binding.value.color
   
4. })

复制代码

* B0 N  l! w) \- o3 U+ ?

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

实例

* [2 ~/ [9 `7 Q- j0 t: n. a6 L

1. <div id="app">
   # H4 h' f* }' X* a3 A/ f( f
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   
3. </div>
   . W( F# s0 O4 C2 F/ j; ]
4. 
   
5. <script>
   
6. Vue.directive('runoob', function (el, binding) {
   8 d  H% v3 P: @6 c
7.     // 简写方式设置文本及背景颜色
   
8.     el.innerHTML = binding.value.text
   
9.     el.style.backgroundColor = binding.value.color
   
10. })
    ! o6 p( J% L1 B- P* J
11. new Vue({
    9 i5 k# I- z! O, ^4 e% B8 Y
12.   el: '#app'
    
13. })
    5 @: p5 e% q7 O" a
14. </script>

复制代码

5 Z1 J7 u, v7 \0 o" N  ]