Vue.js 自定义指令

admin

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

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

实例
( n# t* y$ \% S& P6 u

1. <div id="app">
   
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   
3.     <input v-focus>
   
4. </div>
   
5. 
   
6. <script>
   6 X* [  j3 k- s# E, K0 _
7. // 注册一个全局自定义指令 v-focus
   . @& c* u% ]" d1 Q) n! J
8. Vue.directive('focus', {
   
9.   // 当绑定元素插入到 DOM 中。
   
10.   inserted: function (el) {
    
11.     // 聚焦元素
    $ ~' L/ z2 e, ~% j
12.     el.focus()
    - E' u; t' _) m" C1 v
13.   }
    % |- ]* U& O  s
14. })
    6 q5 Z1 g1 V$ s5 g# s0 R
15. // 创建根实例
    
16. new Vue({
    ' O" q. W3 e: U+ D! k3 I' B3 @2 k
17.   el: '#app'
    
18. })
    ' D' }! C7 y% i2 _+ y0 ]) ^  Q
19. </script>

复制代码

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

实例

2 p: z3 a$ ]* D. H5 E$ u+ A

1. <div id="app">
   ; P- g! L3 f, G3 m7 E+ e8 Z9 Z$ [
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   ( W, I( C7 W- h0 t9 p) t
3.   <input v-focus>
   0 G9 `' ^0 C5 O+ |4 k# o- ~! N
4. </div>
   & n& V. |/ t& M+ ?. q5 M& A
5. 
   
6. <script>
   7 n+ v5 ~; N: H; j# ?/ I. T1 o5 w8 N
7. // 创建根实例
   ! m: F8 [$ I+ _9 l+ q3 U! F! ~( B
8. new Vue({
   
9.   el: '#app',
   
10.   directives: {
    
11.     // 注册一个局部的自定义指令 v-focus
    
12.     focus: {
    
13.       // 指令的定义
    * Z( R+ ]! ~( r( w$ s7 c5 \
14.       inserted: function (el) {
    . T( H8 K4 d0 ~. l" }9 z
15.         // 聚焦元素
    
16.         el.focus()
    
17.       }
    
18.     }
    
19.   }
    
20. })
    # F4 `6 r9 _& Y9 N
21. </script>

复制代码

钩子钩子函数

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

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

钩子函数参数

钩子函数的参数有：

• 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 }。
    6 r' I) v6 p# P
• vnode: Vue 编译生成的虚拟节点。
• oldVnode: 上一个虚拟节点，仅在 update 和 componentUpdated 钩子中可用。
  

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

实例
4 w! ?, @/ T3 _

1. <div id="app"  v-runoob:hello.a.b="message">
   7 M; f( V, f! \8 l6 g
2. </div>
   
3. 
   
4. <script>
   1 m0 S8 _# H' k2 n
5. Vue.directive('runoob', {
   
6.   bind: function (el, binding, vnode) {
   ( k! E  P! C2 N' s7 {! @, [
7.     var s = JSON.stringify
   
8.     el.innerHTML =
   " i8 i2 z# M- `8 A$ d  u8 B
9.       'name: '       + s(binding.name) + '<br>' +
   
10.       'value: '      + s(binding.value) + '<br>' +
    
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. })
    ) i+ m9 \6 {% I# B- e0 d
17. new Vue({
    8 C* {7 M. W+ l: `+ J
18.   el: '#app',
    & J: r9 S: F& [' K9 s: O5 y
19.   data: {
    
20.     message: '菜鸟教程!'
    ' v/ V" w/ _- }) c1 X8 E
21.   }
    - \" U" X7 d8 y; Z# v2 S6 {3 t
22. })
    
23. </script>

复制代码

有时候我们不需要其他钩子函数，我们可以简写函数，如下格式：
7 ~: O( H" m$ l8 m# [3 f. p

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

复制代码

& ~1 k- R* k( Q5 U" a8 g

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

实例

1. <div id="app">
   6 c2 k; u; d4 c9 o
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   " `1 i- s* P. x
3. </div>
   
4. 
   , v5 A) o  o) r8 q
5. <script>
   
6. Vue.directive('runoob', function (el, binding) {
   ' ]6 Z3 s) B  y9 B5 c
7.     // 简写方式设置文本及背景颜色
   
8.     el.innerHTML = binding.value.text
   
9.     el.style.backgroundColor = binding.value.color
   
10. })
    : w, \- M+ s; V3 Y  [0 i  K
11. new Vue({
    # x) B! Q  c8 q3 e  q+ j
12.   el: '#app'
    
13. })
    * O8 Q3 B, _0 l- C4 F
14. </script>

复制代码

" D5 C0 g& a6 X5 h- Y7 V
2 e, ?6 l8 I( p/ e" N& a' Z
* @( p  ~6 ?. `6 E, N# W