Vue.js 自定义指令

admin

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

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

实例
* S9 j" r6 F+ n
& o$ G: B, a& E1 m& d9 h

1. <div id="app">
   + D" M* [8 E4 g% i7 P7 S
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   4 G3 k; p+ {* \/ [
3.     <input v-focus>
   1 V! d; h# ^* D: F- l
4. </div>
   ' x! J7 d7 H, o5 s" M& B. ?2 P  B9 i2 p
5. 
   
6. <script>
   $ G* z( w, ~7 a8 C" t/ k
7. // 注册一个全局自定义指令 v-focus
   9 N# f, u6 [9 t- i0 ?. d
8. Vue.directive('focus', {
   # Z4 v2 f) \4 V5 G) c
9.   // 当绑定元素插入到 DOM 中。
   
10.   inserted: function (el) {
    % w# g6 v: D+ v4 a) g$ Q1 X  L  Y, U9 c
11.     // 聚焦元素
    : T9 M  Z% a5 n4 G, _
12.     el.focus()
    ) ~8 J' U7 [& a) {5 C
13.   }
    
14. })
    2 E: j8 h4 @" D: i. C1 L
15. // 创建根实例
    - m3 b4 e& U8 i3 M8 ?
16. new Vue({
    $ u: J9 d; e, I1 e
17.   el: '#app'
    # {8 Q2 |0 C9 L1 h
18. })
    
19. </script>

复制代码

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

实例

1. <div id="app">
   
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   - x8 k1 a- m+ [2 @% D$ ^1 W
3.   <input v-focus>
   
4. </div>
   % S; J" r  W5 w- m- a
5. 
   ) {. N" A/ [! Q$ m4 h1 c
6. <script>
   
7. // 创建根实例
   
8. new Vue({
   2 @# g# r5 M2 S9 V; C1 L
9.   el: '#app',
   
10.   directives: {
    , [0 L1 Z3 y9 N# ^  J
11.     // 注册一个局部的自定义指令 v-focus
    
12.     focus: {
    . M2 T- a" R, O1 j9 y: G
13.       // 指令的定义
    
14.       inserted: function (el) {
    
15.         // 聚焦元素
    0 V% k! z( I) c$ M
16.         el.focus()
    1 E" b* Y3 K( A9 \4 `4 S) Z5 F$ U
17.       }
    
18.     }
    4 i$ \- L) n( m- P  j7 Q8 b
19.   }
    ; J2 g! a$ P' }9 x/ s8 ?4 C
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 钩子中可用。
  

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

实例

9 P  C' G! ^' Z3 r+ W. z* |

1. <div id="app"  v-runoob:hello.a.b="message">
   
2. </div>
   : Q" `: s& Z2 Z0 t- s/ L5 a+ o2 Y
3. 
   
4. <script>
   9 R0 @  F9 @/ N' B# \
5. Vue.directive('runoob', {
   
6.   bind: function (el, binding, vnode) {
   
7.     var s = JSON.stringify
   + [( ]" @9 i1 @: Y, T# T3 p
8.     el.innerHTML =
   ( h$ J; b( B4 f* H- F9 A
9.       'name: '       + s(binding.name) + '<br>' +
   
10.       'value: '      + s(binding.value) + '<br>' +
    . m* b9 `; U) D- l: L% U3 y, _
11.       'expression: ' + s(binding.expression) + '<br>' +
    
12.       'argument: '   + s(binding.arg) + '<br>' +
    4 N0 E0 d, U/ [& d3 N: v
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    9 `- ^& m8 J/ O4 A2 G) R
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    5 i9 f4 D, I' N. n. s% n: s. z
15.   }
    8 r6 P# w3 x8 j# j6 a
16. })
    
17. new Vue({
    & W, J4 o" s2 K6 i/ V
18.   el: '#app',
    $ A' m9 {# h: _* a3 P" B
19.   data: {
    
20.     message: '菜鸟教程!'
    & {( t5 Q# }9 ]6 S" P1 s
21.   }
    
22. })
    3 m  a8 r6 H& I0 S
23. </script>

复制代码

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

1. Vue.directive('runoob', function (el, binding) {
   , [) N, |0 P. |* \5 k9 Z$ F
2.   // 设置指令的背景颜色
   # c0 x* }0 _8 u) h5 S
3.   el.style.backgroundColor = binding.value.color
   : C6 L% D9 A0 o- E6 ]
4. })

复制代码

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

实例
5 o' I# p2 P9 O+ N- O
* @( _* T4 @& \0 l

1. <div id="app">
   
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   
3. </div>
   
4. 
   
5. <script>
   
6. Vue.directive('runoob', function (el, binding) {
   , F( |# z' D4 W3 h& p. f* {
7.     // 简写方式设置文本及背景颜色
   
8.     el.innerHTML = binding.value.text
   
9.     el.style.backgroundColor = binding.value.color
   
10. })
    ) k! g2 Z/ J# l6 w! L4 ]% p' G: D* V
11. new Vue({
    4 q" V) R' A; q6 w) o" C; L7 l
12.   el: '#app'
    ; ]' X+ ^$ ^! c# x7 F1 W
13. })
    % }1 _. E; @" t
14. </script>

复制代码

- G, E5 X4 l1 W! m3 g% K) v
( I* Q# w% I/ C7 _1 C2 W0 X