Vue.js 自定义指令

admin

' p! C; h5 x( P# Q4 F

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

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

实例

1. <div id="app">
   4 W& m; q( d- d9 x& X- r
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   1 ]! p: y* p* Y- o( J7 y
3.     <input v-focus>
   
4. </div>
   
5. 
   7 a& D8 H: F& F7 u3 ~2 [
6. <script>
   % h5 W( P7 j& C- @
7. // 注册一个全局自定义指令 v-focus
   " ~! s7 @- d1 ~9 v9 Y& p
8. Vue.directive('focus', {
   
9.   // 当绑定元素插入到 DOM 中。
   
10.   inserted: function (el) {
    7 P+ f* B: k( u/ Y- T
11.     // 聚焦元素
    
12.     el.focus()
    
13.   }
    
14. })
    + s. d8 `+ l" u$ Q7 B5 Q
15. // 创建根实例
    
16. new Vue({
    8 ]# h, k" o4 M( P! v$ f0 @1 P/ ~( P
17.   el: '#app'
    : z0 X- v& o. f$ V* b4 T
18. })
    : m" U, x* X2 l; H5 B
19. </script>

复制代码

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

实例
' j+ N. \' s  Y  w1 m- {: q0 Q9 E

1. <div id="app">
   , N2 M) \6 }) |: H% V2 s- J2 w; b
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   
3.   <input v-focus>
   
4. </div>
   
5. 
   
6. <script>
   
7. // 创建根实例
   
8. new Vue({
   
9.   el: '#app',
   + H2 `/ _, C0 g$ s! j* ]4 U, ^1 S
10.   directives: {
    
11.     // 注册一个局部的自定义指令 v-focus
    
12.     focus: {
    0 \  l( Y) N; \. N
13.       // 指令的定义
    8 ]/ }- {$ z% F1 ?1 g) t; [
14.       inserted: function (el) {
    0 N. ?; t3 Q- y0 }. L3 [1 p# P
15.         // 聚焦元素
    
16.         el.focus()
    ! J4 a# F4 O8 R+ }( z9 ~
17.       }
    
18.     }
    
19.   }
    
20. })
    - w, ]: L5 T$ B0 H" |. j
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 钩子中可用。
  6 g  @% D) s; S) {( a( ~

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

实例

1. <div id="app"  v-runoob:hello.a.b="message">
   - f( X: ~; b8 ?! m) i
2. </div>
   
3. 
   
4. <script>
   
5. Vue.directive('runoob', {
   
6.   bind: function (el, binding, vnode) {
   
7.     var s = JSON.stringify
   
8.     el.innerHTML =
   
9.       'name: '       + s(binding.name) + '<br>' +
   % T; u* ?  C/ e; L
10.       'value: '      + s(binding.value) + '<br>' +
    5 Z# a0 _. `7 {. F6 w0 t
11.       'expression: ' + s(binding.expression) + '<br>' +
    
12.       'argument: '   + s(binding.arg) + '<br>' +
    9 v4 v2 A2 ~0 |& |9 K
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    ) p) D# o  L  X. W3 H( m2 o7 s4 Z
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    
15.   }
    
16. })
    
17. new Vue({
    4 [+ T7 z- ?7 R' b3 B
18.   el: '#app',
    7 N) c/ }; i. A( E, U1 F; J
19.   data: {
    
20.     message: '菜鸟教程!'
    
21.   }
    " k8 k- i  Z- m( ^# N- q# m
22. })
    + a! `! n; I( k3 h  v1 E
23. </script>

复制代码

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

1. Vue.directive('runoob', function (el, binding) {
   
2.   // 设置指令的背景颜色
   : p1 p; z! V+ l% u2 A/ o3 \% V  p4 x
3.   el.style.backgroundColor = binding.value.color
   - n" w$ Z2 L+ j& N
4. })

复制代码

+ ~+ R7 Y/ g! B+ J

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

实例

1 k* ^* j) ?3 k9 q# k" V: e

1. <div id="app">
   0 l/ p! S2 j' {6 H. U
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   6 S: O# t; j4 r, H
3. </div>
   6 S& K" _' L# b  q: {1 W2 {. p
4. 
   
5. <script>
     z6 B: t6 n/ ^
6. Vue.directive('runoob', function (el, binding) {
   2 q* W" l3 A$ C" m
7.     // 简写方式设置文本及背景颜色
   
8.     el.innerHTML = binding.value.text
   
9.     el.style.backgroundColor = binding.value.color
   
10. })
    
11. new Vue({
    + z' L3 S5 r  [5 D3 [+ L* U
12.   el: '#app'
    ! J) [8 b9 W* V/ ?( m. L% Y
13. })
    3 s! q$ g7 O6 ?: V: `" a% }3 W/ \
14. </script>

复制代码

, N. i9 r( B+ X  W. K