Vue.js 自定义指令

admin

) Z0 T/ H) m* f# D) }) Y- u

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

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

实例

' i1 _1 A6 L; H  |

1. <div id="app">
   
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   ; ]9 a) n0 ?# t6 b* B4 g5 `. A
3.     <input v-focus>
   
4. </div>
   
5. 
   2 g* e, x  ?2 P! z  s
6. <script>
   $ O5 U9 A2 i) B$ i: [
7. // 注册一个全局自定义指令 v-focus
   
8. Vue.directive('focus', {
   1 N& t4 H( I0 D7 v. @- s
9.   // 当绑定元素插入到 DOM 中。
   
10.   inserted: function (el) {
    3 L% a) P* }7 `5 U  e
11.     // 聚焦元素
    
12.     el.focus()
    ! u% b$ E' ]  X6 A
13.   }
    4 ~4 J& ]& o6 c+ L
14. })
    
15. // 创建根实例
    
16. new Vue({
    3 Q; Y! N. j( u% g) f0 m
17.   el: '#app'
    
18. })
    
19. </script>

复制代码

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

实例

# q# [3 m7 E! X+ T1 Z

1. <div id="app">
   7 j' A9 L& i# _
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   6 q9 D# |9 ^$ b) m
3.   <input v-focus>
   : P' P- E1 e; n  c1 a( c. _- s
4. </div>
   
5. 
   ' c0 I, P0 ?  |7 I" ~; g/ Q
6. <script>
   6 e/ ?' f/ S. Y1 \- X2 V) t
7. // 创建根实例
   * D5 g5 h, l8 }! z6 _1 e. K# G
8. new Vue({
   , g1 y& [6 k- F8 ]& C5 g- g
9.   el: '#app',
   0 V2 n3 Z4 c5 w
10.   directives: {
    
11.     // 注册一个局部的自定义指令 v-focus
    
12.     focus: {
    7 r8 z' n9 x6 Q8 Q9 n% t
13.       // 指令的定义
    
14.       inserted: function (el) {
    - m, d1 X7 i9 A$ R: v# C
15.         // 聚焦元素
    ! k) A4 s: _6 K
16.         el.focus()
    
17.       }
    
18.     }
    : r9 ^( c$ y2 A, I* a  K
19.   }
    
20. })
    4 i* Z# \' J. x5 V) p9 Y. U. a
21. </script>

复制代码

钩子钩子函数

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

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

钩子函数参数

钩子函数的参数有：

• 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 钩子中可用。
  

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

实例
& F/ |3 p0 }: N3 \
5 K) N* r  s- ?3 J" C

1. <div id="app"  v-runoob:hello.a.b="message">
   " ?# F* l+ R9 B
2. </div>
   
3. 
   4 y: k2 P+ |! T- k; a
4. <script>
   7 j! _4 F& f9 _) p$ }% T
5. Vue.directive('runoob', {
     p9 S' X* L! n' [% I. A% C8 h
6.   bind: function (el, binding, vnode) {
   
7.     var s = JSON.stringify
   # w# j9 A$ }$ K* q% z7 b
8.     el.innerHTML =
   3 C% ~. v  F7 R' S
9.       'name: '       + s(binding.name) + '<br>' +
   
10.       'value: '      + s(binding.value) + '<br>' +
    / J% t- Q& X4 ~: |4 M5 B: n
11.       'expression: ' + s(binding.expression) + '<br>' +
    & O) `6 y% ?6 Z% i/ B
12.       'argument: '   + s(binding.arg) + '<br>' +
    
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    / t0 t9 _2 k) s
15.   }
    
16. })
    
17. new Vue({
    7 D5 [" t' u4 G( V7 o# m' C
18.   el: '#app',
    1 W" ]4 X  _5 f
19.   data: {
    . I, _4 f$ s% [
20.     message: '菜鸟教程!'
    ! ~/ A) d% @6 o9 v
21.   }
    
22. })
    
23. </script>

复制代码

有时候我们不需要其他钩子函数，我们可以简写函数，如下格式：
6 R5 t2 {+ ?& B* o9 b* Y

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

复制代码

! Y( x8 S( `7 H' K. C1 N7 ]9 R

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

实例

/ @0 v6 n. H5 a8 J, C( _6 w7 L5 u

1. <div id="app">
   - G2 d3 ^" r0 f( R! n% p' k
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   
3. </div>
   % L" [9 S; k# o0 f1 T
4. 
   ! {/ u5 e9 k# P& U# g+ `6 `
5. <script>
   + I/ I+ S) j& k& F/ h. d
6. Vue.directive('runoob', function (el, binding) {
   
7.     // 简写方式设置文本及背景颜色
   
8.     el.innerHTML = binding.value.text
   , |/ c! S! w  F$ s; [7 }
9.     el.style.backgroundColor = binding.value.color
   
10. })
    
11. new Vue({
    , M5 y, J3 [$ b# N
12.   el: '#app'
    
13. })
    
14. </script>

复制代码