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 中。
   . ~, E& k+ R( o( O2 k$ U! E
10.   inserted: function (el) {
    " g( r) L- T1 l1 ~* x. x
11.     // 聚焦元素
    
12.     el.focus()
    
13.   }
    
14. })
    ' P8 B3 U/ h. p; u' U
15. // 创建根实例
    
16. new Vue({
    
17.   el: '#app'
    
18. })
    
19. </script>

复制代码

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

实例

1. <div id="app">
   3 I+ ^: ^" d% Q2 X  n
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   7 ^6 I* e  r- y4 w4 r+ I
3.   <input v-focus>
   , F$ \8 r7 L/ @7 M8 J
4. </div>
   ! F+ n! L6 U6 d8 c" ~( ]6 W! K
5. 
   0 l6 }' c. U: j
6. <script>
   ; x/ o% k: d$ f  n7 k# C3 ?
7. // 创建根实例
   
8. new Vue({
   
9.   el: '#app',
   - M! t) V! i& _
10.   directives: {
    
11.     // 注册一个局部的自定义指令 v-focus
    3 I: R3 B& B! y1 s  c1 a
12.     focus: {
    
13.       // 指令的定义
    1 M/ P9 \% @9 V+ h
14.       inserted: function (el) {
    
15.         // 聚焦元素
    ! J& ]4 E  F* M
16.         el.focus()
    
17.       }
    + Z) o( n( |6 P. O4 w6 j; ~
18.     }
    
19.   }
    ; l3 Y( [( M8 r) a+ L
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 }。
    : H: W2 a* |; u4 J6 p
• vnode: Vue 编译生成的虚拟节点。
• oldVnode: 上一个虚拟节点，仅在 update 和 componentUpdated 钩子中可用。
  

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

实例

# O2 m! d7 k  {  b! ]3 m" ]" N& ?

1. <div id="app"  v-runoob:hello.a.b="message">
   # N" v" h+ p$ b1 h: a2 p3 y
2. </div>
   ) `1 W: f! R! |' b! J( F! M
3. 
   
4. <script>
   
5. Vue.directive('runoob', {
   9 O0 H, U. J" [0 e: l/ _( Z9 J
6.   bind: function (el, binding, vnode) {
   - ?) m4 G2 f' T
7.     var s = JSON.stringify
   8 j7 N; e$ V/ G9 \7 K9 t' J
8.     el.innerHTML =
   8 O9 s$ r5 k5 }8 E
9.       'name: '       + s(binding.name) + '<br>' +
   
10.       'value: '      + s(binding.value) + '<br>' +
      J4 m1 q5 a4 ?! l6 ?9 X7 L* ?
11.       'expression: ' + s(binding.expression) + '<br>' +
    
12.       'argument: '   + s(binding.arg) + '<br>' +
    9 f. f5 o4 X  W3 i* V
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    % g9 L# M! C& Y- a3 Q% _# e
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    
15.   }
    
16. })
    
17. new Vue({
    
18.   el: '#app',
    
19.   data: {
    
20.     message: '菜鸟教程!'
    3 j8 c2 K- e- D) _' a
21.   }
    & |7 s- W: r$ q% I3 k
22. })
    
23. </script>

复制代码

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

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

复制代码

7 y! w+ l  Q  w; Q
$ m9 ]" Q! S/ P9 E" {- R5 y6 |

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

实例

! U: Z! y/ N* }( C

1. <div id="app">
   
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   
3. </div>
   1 t% N. ~% y0 |( n' l3 \; c0 C) F
4. 
   - h7 x1 g$ n% k* T
5. <script>
   & F, m) e' c% X* v5 Z' C
6. Vue.directive('runoob', function (el, binding) {
   ; |' @5 b5 J+ d# e  O5 d
7.     // 简写方式设置文本及背景颜色
   0 ?6 b* u7 S+ t1 H
8.     el.innerHTML = binding.value.text
   * r8 Y5 R" K- I3 P# n5 m# I
9.     el.style.backgroundColor = binding.value.color
   
10. })
    
11. new Vue({
    : `* A- a, C% k6 e5 x& |
12.   el: '#app'
    
13. })
    " |( o8 u/ n5 _6 \
14. </script>

复制代码

# O/ |+ E, M# L, y3 r
5 I1 x, \' @: t+ T/ ~' Q" U: T9 T, \