Vue.js 自定义指令

admin

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

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

实例

1. <div id="app">
   
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   
3.     <input v-focus>
   
4. </div>
   
5. 
   
6. <script>
   
7. // 注册一个全局自定义指令 v-focus
   
8. Vue.directive('focus', {
   
9.   // 当绑定元素插入到 DOM 中。
   8 }3 f8 ?+ \# `- L  Q0 i
10.   inserted: function (el) {
    % Z1 r8 c9 M5 J( H7 V( N
11.     // 聚焦元素
    / u, \1 H/ W7 |0 h4 i0 @
12.     el.focus()
    2 C: ?5 k) I# K
13.   }
    
14. })
    + \  ~2 L! Q9 ?5 X; v/ U7 x
15. // 创建根实例
      t9 v9 X' b5 j
16. new Vue({
    . n8 o) S( X" Y9 f* p* a( g6 t& i
17.   el: '#app'
    
18. })
    
19. </script>

复制代码

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

实例

1. <div id="app">
   
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   / ~( E& b0 B4 b% U2 m& _0 ]0 ^/ o
3.   <input v-focus>
   7 M+ X, r) x  N4 c, H
4. </div>
   
5. 
   
6. <script>
   7 p7 \5 @. f% c) k7 m0 c
7. // 创建根实例
   8 s( `, q4 Q) B; H* t6 n- @. p
8. new Vue({
   # q# s. Z) G$ o) _5 E7 b3 ?5 u4 z
9.   el: '#app',
   % S3 N: m4 g8 J7 {; a2 w& h
10.   directives: {
    + o- X' Z4 V; @( A
11.     // 注册一个局部的自定义指令 v-focus
    2 C: z2 k4 V3 m
12.     focus: {
    
13.       // 指令的定义
    
14.       inserted: function (el) {
    
15.         // 聚焦元素
    # W7 R* L  y- R, m& ^# B& T5 D4 ]
16.         el.focus()
    , \- f" Q, O- }  W; D; |2 O
17.       }
    ' Z: S. X5 i$ U7 ?3 w
18.     }
    9 T/ y. o3 q% m7 D! A
19.   }
    
20. })
    " c: ^1 F9 e2 R+ b4 f
21. </script>

复制代码

钩子钩子函数

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

• bind: 只调用一次，指令第一次绑定到元素时调用，用这个钩子函数可以定义一个在绑定时执行一次的初始化动作。
• inserted: 被绑定元素插入父节点时调用（父节点存在即可调用，不必存在于 document 中）。
• update: 被绑定元素所在的模板更新时调用，而不论绑定值是否变化。通过比较更新前后的绑定值，可以忽略不必要的模板更新（详细的钩子函数参数见下）。
• componentUpdated: 被绑定元素所在模板完成一次更新周期时调用。
• unbind: 只调用一次， 指令与元素解绑时调用。
  
  5 g1 f2 o  u9 m* [9 `4 f  S

钩子函数参数

钩子函数的参数有：

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

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

实例

7 A4 H6 M" F( c0 i* [

1. <div id="app"  v-runoob:hello.a.b="message">
   2 O7 y$ p  l. }' B" Y
2. </div>
   
3. 
   9 p6 A4 e# I5 ]* \
4. <script>
   : B- }& W4 Z2 n: W" U
5. Vue.directive('runoob', {
   , o0 x$ Z; `. _5 G3 v
6.   bind: function (el, binding, vnode) {
   
7.     var s = JSON.stringify
   
8.     el.innerHTML =
   , u/ z) B6 |, E/ @$ w& T
9.       'name: '       + s(binding.name) + '<br>' +
   
10.       'value: '      + s(binding.value) + '<br>' +
    % g  V0 j" K! b; V+ Y% x$ Y6 a
11.       'expression: ' + s(binding.expression) + '<br>' +
    
12.       'argument: '   + s(binding.arg) + '<br>' +
    
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    # i2 ~; n# ^4 {* a6 A4 `
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    - M' X! L8 B  D4 E
15.   }
    9 Y8 G9 i% g1 ?  K6 ~
16. })
    
17. new Vue({
    
18.   el: '#app',
    ) V3 _& W/ k! o* |
19.   data: {
    
20.     message: '菜鸟教程!'
    " @1 l$ h( B, B6 k& i3 c
21.   }
      t) d1 H' N( ^2 _7 E$ r% A
22. })
    ) s' {$ U% U, L( k0 n3 k: O8 W
23. </script>

复制代码

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

1. Vue.directive('runoob', function (el, binding) {
   
2.   // 设置指令的背景颜色
   8 B" P( e, t3 ~, t5 B" u0 C5 t
3.   el.style.backgroundColor = binding.value.color
   , }5 j# v2 L: ?* f# V! e1 W
4. })

复制代码

2 N7 w! r& z! b0 z0 }! E$ {

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

实例
3 H3 j' {* F8 [0 {6 s6 b

1. <div id="app">
   
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   
3. </div>
   : J+ ?3 z! d! q; H8 O* e
4. 
   
5. <script>
   # h- p6 h' r6 N! U
6. Vue.directive('runoob', function (el, binding) {
   9 j( F' O9 }. `6 c8 Y
7.     // 简写方式设置文本及背景颜色
   
8.     el.innerHTML = binding.value.text
   
9.     el.style.backgroundColor = binding.value.color
   6 X6 C, e7 o8 s6 D. q3 T' j' R3 q
10. })
    1 p, c' p" b* E
11. new Vue({
    
12.   el: '#app'
    ; q) d  J7 Y; z0 e  [! ~
13. })
    
14. </script>

复制代码

- ?: @" G' I( o' V. N

$ o; ~# C/ i' @# w