Vue.js 自定义指令

admin

9 T% {8 Q+ D2 k9 m: N* b% x

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

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

实例

1. <div id="app">
   
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   
3.     <input v-focus>
   
4. </div>
   0 u! t- p$ l$ Z( l* d8 b# D
5. 
   9 w) ~4 u* U% `0 R1 F
6. <script>
   # d* y( y. d, W7 r& E
7. // 注册一个全局自定义指令 v-focus
   
8. Vue.directive('focus', {
   1 |0 O/ f0 H. `6 C8 i6 g9 e
9.   // 当绑定元素插入到 DOM 中。
   ' x/ Y1 @5 O6 |9 L
10.   inserted: function (el) {
    $ K! q- [. n. ]& c8 Q, C! d
11.     // 聚焦元素
    
12.     el.focus()
    
13.   }
    
14. })
    
15. // 创建根实例
    7 Y. H* _4 j% d
16. new Vue({
    
17.   el: '#app'
    
18. })
    
19. </script>

复制代码

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

实例
) r' |! M* j% h- @. \

1. <div id="app">
   
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   # v8 }& J, D4 J$ C
3.   <input v-focus>
   
4. </div>
   , h: m2 e. P3 E$ H
5. 
   
6. <script>
   5 L1 y# C  Y$ h- b! t" h
7. // 创建根实例
   
8. new Vue({
   
9.   el: '#app',
   
10.   directives: {
    8 T) S, l8 }! K# g
11.     // 注册一个局部的自定义指令 v-focus
    " F' E$ v7 k6 |# ~# H
12.     focus: {
    8 {) p- j) Q8 v0 C
13.       // 指令的定义
    3 N8 r# b- O) G- t3 s) U
14.       inserted: function (el) {
    / I9 e/ d3 F% ]  j
15.         // 聚焦元素
    ' z& D7 B) X. B3 D
16.         el.focus()
    
17.       }
    ' ]- r. F3 C4 a6 u! t
18.     }
    * s" n8 f$ O/ q9 Q0 k4 Q
19.   }
    6 ?# ]/ v% g) T' r8 A! S0 R& c
20. })
    
21. </script>

复制代码

钩子钩子函数

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

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

钩子函数参数

钩子函数的参数有：

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

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

实例
. T" J/ A! u- a: B; p/ e

1. <div id="app"  v-runoob:hello.a.b="message">
   & A3 o/ q7 w; A2 b/ p& A# A' g0 c
2. </div>
   3 l: G9 I' g5 o" i
3. 
   
4. <script>
   # I% e1 ?6 m1 x( r5 S
5. Vue.directive('runoob', {
   ' l* Y2 a( f) s
6.   bind: function (el, binding, vnode) {
   . K4 r; k/ X3 D$ [$ c4 ~* s
7.     var s = JSON.stringify
   
8.     el.innerHTML =
   ) ?5 W1 l! p7 ?% U* T. M' I
9.       'name: '       + s(binding.name) + '<br>' +
   
10.       'value: '      + s(binding.value) + '<br>' +
    2 h0 h1 o8 Y1 j! g8 ?/ j+ @% H
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(', ')
    & I5 q7 I4 i$ N" t4 H# u( V6 `
15.   }
    
16. })
    
17. new Vue({
    $ `8 ^; a7 ]: {) P  H! K, |4 a0 i
18.   el: '#app',
    : d5 J( F3 n" j% |6 P
19.   data: {
    
20.     message: '菜鸟教程!'
    " g& U/ L& U1 X5 h$ j  q9 S# u5 o$ V
21.   }
    
22. })
    # r) @# S- F4 B1 Z. L9 t0 G
23. </script>

复制代码

有时候我们不需要其他钩子函数，我们可以简写函数，如下格式：
( P) C% ~) h" i) M1 G

1. Vue.directive('runoob', function (el, binding) {
   
2.   // 设置指令的背景颜色
   0 z2 P$ m$ p7 s9 U9 m) H
3.   el.style.backgroundColor = binding.value.color
   
4. })

复制代码

: B2 o' |9 j. \) p2 ]( l# x& x

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

实例
* ~! L" {/ l0 j* p+ y( Y2 Z; W

1. <div id="app">
   
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   
3. </div>
   
4. 
   % s3 q+ G& l1 F/ f& F; ^/ w
5. <script>
   
6. Vue.directive('runoob', function (el, binding) {
   : s9 V) `# w5 N! ^
7.     // 简写方式设置文本及背景颜色
   9 w5 o& ~7 k6 `9 q* Q3 Z5 s
8.     el.innerHTML = binding.value.text
   8 H& k: l- M4 J9 X- H' u3 I+ M0 S
9.     el.style.backgroundColor = binding.value.color
   
10. })
    
11. new Vue({
    
12.   el: '#app'
    
13. })
    * J; M1 F+ ]+ }: _4 {0 k+ P
14. </script>

复制代码

* d1 a7 j3 r! F+ }0 [( K
% m; O! W3 B# ?" ]
- M0 Y: C% F% Y2 Y$ j6 b