Vue.js 自定义指令

admin

, p. E& P9 v, _3 s/ T4 C$ ~

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

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

实例

1. <div id="app">
   7 i0 D8 ]7 M) J$ P4 t
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   2 N* {; U: k; h4 v
3.     <input v-focus>
   1 |# z& Z2 W! ?
4. </div>
   3 [6 T8 Z. n' K! C5 M- N
5. 
   9 y; |6 ]! I5 s  Z
6. <script>
   4 p# a# O7 p! \$ {" e
7. // 注册一个全局自定义指令 v-focus
   
8. Vue.directive('focus', {
   ) `$ e+ B9 E" F0 F  |- `/ D
9.   // 当绑定元素插入到 DOM 中。
   
10.   inserted: function (el) {
    % q5 Q5 d# k: g4 \; Q& G/ i4 ]
11.     // 聚焦元素
    
12.     el.focus()
    
13.   }
    : J: L$ U$ e# C2 s, @$ w
14. })
    
15. // 创建根实例
    
16. new Vue({
    1 S. s  u. D5 ^8 Q) ^8 |; D
17.   el: '#app'
    
18. })
    
19. </script>

复制代码

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

实例

) Z, Q! E% P* C- R- t

1. <div id="app">
   ' _/ b2 L" W  A) ?
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   8 [- |- b6 S( F4 d, O
3.   <input v-focus>
   
4. </div>
   * u4 K% \6 J& c2 R. |
5. 
   
6. <script>
   
7. // 创建根实例
   5 e5 {+ E) K4 Y2 P
8. new Vue({
   
9.   el: '#app',
   
10.   directives: {
    , T! M/ W4 i4 t1 A' H! b7 X
11.     // 注册一个局部的自定义指令 v-focus
    & x1 y) e$ n+ W3 R4 o+ _8 q
12.     focus: {
    # {+ I4 E* ^; L/ u5 ~
13.       // 指令的定义
    
14.       inserted: function (el) {
    " T+ s3 g; g/ Q6 O7 {! _
15.         // 聚焦元素
      r; u, R' T. O3 K6 M
16.         el.focus()
    2 L9 t' F% Y) p. \# W# x
17.       }
    + Z. l% F. x; L& G
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 }。
    1 b( \/ w5 t! S6 o- m
• vnode: Vue 编译生成的虚拟节点。
• oldVnode: 上一个虚拟节点，仅在 update 和 componentUpdated 钩子中可用。
  

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

实例

1. <div id="app"  v-runoob:hello.a.b="message">
   
2. </div>
   , r# ?$ \2 n. y' m, }! a
3. 
   
4. <script>
   
5. Vue.directive('runoob', {
   
6.   bind: function (el, binding, vnode) {
   - f+ p. x$ m, S6 P
7.     var s = JSON.stringify
   9 M/ f) j! P; N9 p
8.     el.innerHTML =
   
9.       'name: '       + s(binding.name) + '<br>' +
     c, i3 R' z* ?! X! m1 q
10.       'value: '      + s(binding.value) + '<br>' +
    * [7 f* `) b$ D  _: H
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({
      v- \# _8 f3 p# |
18.   el: '#app',
    
19.   data: {
    6 ~! Y" n$ d. @* u
20.     message: '菜鸟教程!'
    
21.   }
    
22. })
    8 m5 V( `9 N: z  P
23. </script>

复制代码

有时候我们不需要其他钩子函数，我们可以简写函数，如下格式：
2 F0 W- P. f* {( D

1. Vue.directive('runoob', function (el, binding) {
   
2.   // 设置指令的背景颜色
   + r3 I5 U! u6 J- n! c2 G& T5 t
3.   el.style.backgroundColor = binding.value.color
   
4. })

复制代码

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

实例

% e" F! b: r( C! F

1. <div id="app">
   6 G+ E- A' t, T. }2 Z  [. w  h5 D
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   
3. </div>
   
4. 
   5 Q4 F; E8 ?$ _
5. <script>
   $ U7 i' Y  ~% ]  d; {# b7 R5 d! g+ `
6. Vue.directive('runoob', function (el, binding) {
   $ A" g# {, Z, R' u( E# X
7.     // 简写方式设置文本及背景颜色
   
8.     el.innerHTML = binding.value.text
   
9.     el.style.backgroundColor = binding.value.color
   5 c/ Q( @% S3 I# j8 f
10. })
    
11. new Vue({
    ' t- {: t6 t6 ^" t
12.   el: '#app'
    
13. })
    
14. </script>

复制代码

' f3 J( Y2 W& ]6 X5 d( q