Vue.js 自定义指令

admin

! q2 h( A' r  @+ {0 {

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

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

实例
1 }, x$ e$ l  k/ j

1. <div id="app">
   
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   
3.     <input v-focus>
   " R7 ]+ ~$ k  {4 a+ m8 D$ k$ V
4. </div>
   3 }1 x4 r$ [, |6 F
5. 
   
6. <script>
   
7. // 注册一个全局自定义指令 v-focus
   9 I4 O' v) c1 C1 w+ A6 u
8. Vue.directive('focus', {
   
9.   // 当绑定元素插入到 DOM 中。
   / q. P, N* L7 W
10.   inserted: function (el) {
    
11.     // 聚焦元素
    
12.     el.focus()
    8 {9 i+ B( u( D2 f
13.   }
    
14. })
    
15. // 创建根实例
    * e! Z3 l) t, t2 l! {, K
16. new Vue({
    / x+ |9 G9 c8 Z! b
17.   el: '#app'
    
18. })
    
19. </script>

复制代码

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

实例
7 H! y$ g9 o' l7 n" D+ I$ N

1. <div id="app">
   
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   
3.   <input v-focus>
   
4. </div>
   
5. 
   , }! p0 u2 S7 J. k+ B
6. <script>
   0 c0 ^9 @2 G8 ?8 I/ \7 |% v9 @  ]
7. // 创建根实例
   
8. new Vue({
   
9.   el: '#app',
   
10.   directives: {
    
11.     // 注册一个局部的自定义指令 v-focus
    
12.     focus: {
    $ n/ W6 [) O: H. j6 f+ A3 W% P
13.       // 指令的定义
    
14.       inserted: function (el) {
    : F4 x) J" O9 ?6 J
15.         // 聚焦元素
    
16.         el.focus()
    # d& j% w  C7 ^- ]5 L
17.       }
    
18.     }
    
19.   }
    
20. })
    + u+ @3 G8 {7 L7 \
21. </script>

复制代码

钩子钩子函数

指令定义函数提供了几个钩子函数（可选）：

• bind: 只调用一次，指令第一次绑定到元素时调用，用这个钩子函数可以定义一个在绑定时执行一次的初始化动作。
• inserted: 被绑定元素插入父节点时调用（父节点存在即可调用，不必存在于 document 中）。
• update: 被绑定元素所在的模板更新时调用，而不论绑定值是否变化。通过比较更新前后的绑定值，可以忽略不必要的模板更新（详细的钩子函数参数见下）。
• componentUpdated: 被绑定元素所在模板完成一次更新周期时调用。
• unbind: 只调用一次， 指令与元素解绑时调用。
  
  ( i( Z+ K1 Q1 p

钩子函数参数

钩子函数的参数有：

• 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 }。
    2 K2 G; y9 p0 M1 B
• vnode: Vue 编译生成的虚拟节点。
• oldVnode: 上一个虚拟节点，仅在 update 和 componentUpdated 钩子中可用。
  

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

实例

2 B+ Z8 M2 o' Z: i

1. <div id="app"  v-runoob:hello.a.b="message">
   
2. </div>
   ( i3 z$ X3 I. X/ |
3. 
   
4. <script>
   6 Y; c9 J& X* e+ P7 \/ U- B, O
5. Vue.directive('runoob', {
   
6.   bind: function (el, binding, vnode) {
   
7.     var s = JSON.stringify
   
8.     el.innerHTML =
   
9.       'name: '       + s(binding.name) + '<br>' +
   
10.       'value: '      + s(binding.value) + '<br>' +
    0 H, j  |" p& @  F& [# ?
11.       'expression: ' + s(binding.expression) + '<br>' +
    1 b9 q% H/ y( T" A
12.       'argument: '   + s(binding.arg) + '<br>' +
    
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    % f; J3 Y: J2 o2 i# K) s' z6 y
15.   }
    0 g" e, X2 `; f, e% g% q; s
16. })
    
17. new Vue({
    
18.   el: '#app',
    0 \8 _4 H/ t1 ]  z- R
19.   data: {
    5 [# ]- O: h  X5 W& m2 f
20.     message: '菜鸟教程!'
    
21.   }
    
22. })
    
23. </script>

复制代码

有时候我们不需要其他钩子函数，我们可以简写函数，如下格式：
) R& h( W% V# q+ W+ D# [0 v1 O

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

复制代码

1 [% F* T( S. J
) ^' H+ [; t* G6 N

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

实例
9 e4 V+ d9 V% V; _6 |

1. <div id="app">
   
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   
3. </div>
   7 y4 j5 q  X1 N, w, n; J( f$ k
4. 
   ( d' o2 @  O* z" D4 O
5. <script>
   % v  @" B: F( W
6. Vue.directive('runoob', function (el, binding) {
   
7.     // 简写方式设置文本及背景颜色
   1 F; B0 w0 b9 c' R+ {. U
8.     el.innerHTML = binding.value.text
   # n/ ]/ k) q4 W
9.     el.style.backgroundColor = binding.value.color
   
10. })
    + j, _: B6 U3 i) @. F2 N
11. new Vue({
    
12.   el: '#app'
    % H0 g) s: v* ~8 a8 g( M; F3 q
13. })
    
14. </script>

复制代码