Vue.js 自定义指令

admin

3 j1 ^7 _# G8 L- Y0 R

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

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

实例

1. <div id="app">
   0 ]$ @7 A$ d( h+ x/ \
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   . g' O( ]# T! _! A' l, ?8 Y
3.     <input v-focus>
   
4. </div>
   ' O3 @( ?  }6 w$ C% \
5. 
     a  Y3 S! S& y
6. <script>
   , |8 p8 m! B  C& l9 N
7. // 注册一个全局自定义指令 v-focus
   
8. Vue.directive('focus', {
   
9.   // 当绑定元素插入到 DOM 中。
   
10.   inserted: function (el) {
    + J# ^/ Q9 g+ p. G
11.     // 聚焦元素
    
12.     el.focus()
    ! n) E2 b  k6 M# j0 V- s6 l
13.   }
    . L, m7 t  _/ ]$ J% B% E
14. })
    
15. // 创建根实例
    
16. new Vue({
    
17.   el: '#app'
      p* H2 v/ }; W$ p$ H
18. })
    9 A2 w6 }& g! O1 Q2 w( G9 Z* l
19. </script>

复制代码

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

实例
7 B% K4 {: i# Q8 L- G
* J1 ^0 D. g6 h

1. <div id="app">
   ! Z6 o- O  C, r) `
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   
3.   <input v-focus>
   
4. </div>
   
5. 
   " q% c& M6 c+ n8 l* T4 g
6. <script>
   
7. // 创建根实例
   
8. new Vue({
   
9.   el: '#app',
   
10.   directives: {
      E- P) s) v/ x! l8 h# H9 E
11.     // 注册一个局部的自定义指令 v-focus
    
12.     focus: {
    
13.       // 指令的定义
    6 C( L# a, o+ x% U; ?& r" l
14.       inserted: function (el) {
    ! D( ~; e) `0 M2 h8 |' L1 S, K9 b
15.         // 聚焦元素
    ) @6 o( F+ h' B  D6 d5 ]
16.         el.focus()
    , T: f, c+ ~; Z: H
17.       }
    
18.     }
    
19.   }
    
20. })
    
21. </script>

复制代码

钩子钩子函数

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

• bind: 只调用一次，指令第一次绑定到元素时调用，用这个钩子函数可以定义一个在绑定时执行一次的初始化动作。
• inserted: 被绑定元素插入父节点时调用（父节点存在即可调用，不必存在于 document 中）。
• update: 被绑定元素所在的模板更新时调用，而不论绑定值是否变化。通过比较更新前后的绑定值，可以忽略不必要的模板更新（详细的钩子函数参数见下）。
• componentUpdated: 被绑定元素所在模板完成一次更新周期时调用。
• unbind: 只调用一次， 指令与元素解绑时调用。
  
  / e$ d# W0 ?8 N7 S9 K) E9 d; L

钩子函数参数

钩子函数的参数有：

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

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

实例

( j, Y( K1 p( |4 o4 b- B

1. <div id="app"  v-runoob:hello.a.b="message">
   1 M, _, p/ O4 c/ M  b
2. </div>
   
3. 
   
4. <script>
   2 b# g' `. [9 q6 d3 [" J) u& ^
5. Vue.directive('runoob', {
   & c7 `' D: {  Y( }
6.   bind: function (el, binding, vnode) {
   9 F5 W: t9 q' A8 I, P( ~
7.     var s = JSON.stringify
   / c# R' [! v% r2 c7 w
8.     el.innerHTML =
   ( d8 ^+ i. n4 R9 k
9.       'name: '       + s(binding.name) + '<br>' +
   
10.       'value: '      + s(binding.value) + '<br>' +
    5 k7 Q7 F# y7 s0 W4 }
11.       'expression: ' + s(binding.expression) + '<br>' +
    
12.       'argument: '   + s(binding.arg) + '<br>' +
    2 B/ V9 |/ K1 ~9 ]4 X' g& C  M* L
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    2 [8 g$ S. c& m% P, H9 a1 [2 U& N
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    
15.   }
    ' |; g  ~: o* k' o' ~7 w* h
16. })
    " t8 I6 X7 K# c2 ?9 O
17. new Vue({
    
18.   el: '#app',
    
19.   data: {
    5 X  P$ M! W! f4 V+ c9 t
20.     message: '菜鸟教程!'
    ( Z1 ^- a' D8 O$ Z
21.   }
    
22. })
    7 D1 r* R  i# r. V
23. </script>

复制代码

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

1. Vue.directive('runoob', function (el, binding) {
   " f* c* |$ V. b( m7 d2 R9 K* A5 [
2.   // 设置指令的背景颜色
   
3.   el.style.backgroundColor = binding.value.color
   ! C' i& T5 v( T& Y3 B. r$ b: _
4. })

复制代码

/ Q* Q* l# J+ q7 U
2 ?2 u4 R3 t# k3 L

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

实例
$ `' B/ l" o/ e6 M# b( ^% W

1. <div id="app">
   
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   
3. </div>
   
4. 
   0 h, v& V7 Z! M6 \1 p% O
5. <script>
   
6. Vue.directive('runoob', function (el, binding) {
   
7.     // 简写方式设置文本及背景颜色
   
8.     el.innerHTML = binding.value.text
   
9.     el.style.backgroundColor = binding.value.color
   . M: t# K) |5 p
10. })
    ! ?; Q' E( H* s  P
11. new Vue({
    
12.   el: '#app'
    , y" a/ a  N1 C' Q
13. })
    5 H: T  A* ~( |* {, z# D
14. </script>

复制代码