Vue.js 自定义指令

admin

3 W/ i% @7 Y5 E! y3 K; k& x

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

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

实例

1 C% d+ M+ \6 i5 P: p

1. <div id="app">
   
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   4 c  j+ {# G, f8 i
3.     <input v-focus>
   % u* j. M; ^. i% |
4. </div>
     D6 Z. L6 J1 w
5. 
   ) ?) {" {3 K% Q2 G; S
6. <script>
   
7. // 注册一个全局自定义指令 v-focus
   
8. Vue.directive('focus', {
   
9.   // 当绑定元素插入到 DOM 中。
   2 N- @. l: s* }. O- t) I% z! t
10.   inserted: function (el) {
    
11.     // 聚焦元素
    0 |# m5 B2 e- ]
12.     el.focus()
    4 i% p* T2 z' Y, K) a$ G- @
13.   }
    
14. })
    7 K% H6 {' C4 ^
15. // 创建根实例
    
16. new Vue({
    
17.   el: '#app'
    5 H" u& g- b+ S( m2 r% L( `1 K
18. })
    
19. </script>

复制代码

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

实例
7 k8 z& ~1 N8 b; m: }

1. <div id="app">
   
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   
3.   <input v-focus>
   
4. </div>
   . g: m+ y0 {& B( Z& |
5. 
   
6. <script>
   
7. // 创建根实例
   
8. new Vue({
   
9.   el: '#app',
     D* ^+ Y# a  ?# d- X; l
10.   directives: {
    
11.     // 注册一个局部的自定义指令 v-focus
    . S3 n; d8 |6 \
12.     focus: {
    
13.       // 指令的定义
    : W$ i' N( L0 K9 k5 j
14.       inserted: function (el) {
    
15.         // 聚焦元素
    # Y- ^# X& U  R2 c3 E
16.         el.focus()
    $ l4 ]- k1 g& q6 ^5 K8 i
17.       }
    ; X8 J7 X% ~% b+ w$ h
18.     }
    8 a& R. I4 M+ g# y3 O( @7 X: X$ F
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 }。
    
• vnode: Vue 编译生成的虚拟节点。
• oldVnode: 上一个虚拟节点，仅在 update 和 componentUpdated 钩子中可用。
  

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

实例
, K9 k, X5 k6 L1 ]
5 {+ W# H+ A. Q

1. <div id="app"  v-runoob:hello.a.b="message">
   ) C- y3 ?% V, F/ y7 R! g
2. </div>
   + ?- v- O# K  P" t/ b1 Z# D
3. 
   
4. <script>
   ; M6 [. f/ Q0 X! t0 M) g& r
5. Vue.directive('runoob', {
   
6.   bind: function (el, binding, vnode) {
   
7.     var s = JSON.stringify
   
8.     el.innerHTML =
   
9.       'name: '       + s(binding.name) + '<br>' +
     V& p4 {& s" J% v* I( s) E
10.       'value: '      + s(binding.value) + '<br>' +
    
11.       'expression: ' + s(binding.expression) + '<br>' +
    & J- z9 d" k. |+ c
12.       'argument: '   + s(binding.arg) + '<br>' +
    
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
      _+ i( {4 W; D, ?% h
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    4 H5 I9 Q! i( D5 N# C
15.   }
    ) `# B: S5 c$ c' D  P) `% H
16. })
    * h5 m# N7 x/ r. b3 f' ?
17. new Vue({
    
18.   el: '#app',
    
19.   data: {
    8 X- ^- f) G) j/ E1 [" j
20.     message: '菜鸟教程!'
    ! A5 }! h# L7 z" X. ]
21.   }
    
22. })
    
23. </script>

复制代码

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

1. Vue.directive('runoob', function (el, binding) {
   
2.   // 设置指令的背景颜色
   * E8 ^4 y- y6 B4 M: k# @
3.   el.style.backgroundColor = binding.value.color
     ~" o) n" R/ f2 A, @% n
4. })

复制代码

5 m7 K  w3 l7 @8 B- I7 A* d! @

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

实例
( n$ \$ }* Y# W
! p: u1 L7 k3 r+ s+ l

1. <div id="app">
   
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   
3. </div>
     _/ l/ ?- j, x) S2 q( l% _
4. 
   
5. <script>
   
6. Vue.directive('runoob', function (el, binding) {
   
7.     // 简写方式设置文本及背景颜色
     A8 I; e( o: s; Z! |( f: R
8.     el.innerHTML = binding.value.text
   + W- p; Z& z& e, L
9.     el.style.backgroundColor = binding.value.color
   
10. })
    . `% e2 X/ U- H! w1 ]
11. new Vue({
    
12.   el: '#app'
    
13. })
    
14. </script>

复制代码

+ E* C) s3 o* O' l( @% H" L. C4 `