Vue.js 自定义指令

admin

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

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

实例
3 r! }1 u* {0 d2 @: T1 P

1. <div id="app">
   ( |$ o5 d! S' }
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   
3.     <input v-focus>
   
4. </div>
   6 T4 V( P# |& J
5. 
   6 M; R( ^8 N7 o2 g
6. <script>
   
7. // 注册一个全局自定义指令 v-focus
   
8. Vue.directive('focus', {
   
9.   // 当绑定元素插入到 DOM 中。
   
10.   inserted: function (el) {
    
11.     // 聚焦元素
    
12.     el.focus()
    
13.   }
    : D. Z) y  L' \+ B
14. })
    
15. // 创建根实例
    
16. new Vue({
    2 ^2 Y0 T# U, W# Z3 x9 k
17.   el: '#app'
    * N- O) N5 c. b/ K+ ]* B
18. })
    
19. </script>

复制代码

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

实例

0 x8 p: }& d6 s# H! _( Z8 T" c" K

1. <div id="app">
   
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   0 M8 i" Z( ?  ^- B! q. d  S8 }
3.   <input v-focus>
   
4. </div>
   
5. 
   
6. <script>
   
7. // 创建根实例
   
8. new Vue({
   - w$ Q- `& [8 P$ H* s' {- L
9.   el: '#app',
   
10.   directives: {
    
11.     // 注册一个局部的自定义指令 v-focus
    
12.     focus: {
    / Z: A- M7 k2 _4 G# c3 q. b8 H* b$ j* R' K
13.       // 指令的定义
    
14.       inserted: function (el) {
    ; b8 E# Q! V. T' E4 @
15.         // 聚焦元素
      l6 C. d" n; O  ]' \, s
16.         el.focus()
    ! M$ t8 X# j% `1 p" y! K* V: j
17.       }
    
18.     }
    % X0 L% d+ S. k' Y, J7 y6 [
19.   }
    ; i% [) W% U/ G! I, P( p
20. })
    9 T! O% d/ ~# G; v
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 钩子中可用。
  

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

实例
" f$ W( q$ D: M* o( f+ D  q
/ f9 o) c8 \3 l9 _- R8 u

1. <div id="app"  v-runoob:hello.a.b="message">
   
2. </div>
   / i# F  Y4 z1 q4 S
3. 
   5 g% I( E( V) K
4. <script>
   * k' k) I* |9 N* s- V
5. Vue.directive('runoob', {
   
6.   bind: function (el, binding, vnode) {
   . b2 H/ k' K; f6 A
7.     var s = JSON.stringify
   
8.     el.innerHTML =
   
9.       'name: '       + s(binding.name) + '<br>' +
   4 {+ ^/ `  C* @4 P5 m: F4 M
10.       'value: '      + s(binding.value) + '<br>' +
    7 ^( m# t9 M* h1 G) T2 l+ C7 L
11.       'expression: ' + s(binding.expression) + '<br>' +
    * H" `! `- d% U% h  E& W
12.       'argument: '   + s(binding.arg) + '<br>' +
    
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    
15.   }
    
16. })
    ( r. m5 m# h7 W2 m
17. new Vue({
    , F) S& o. r3 I3 s7 d/ h
18.   el: '#app',
    
19.   data: {
    6 ~& G, u5 g2 L
20.     message: '菜鸟教程!'
    ; _  q* r2 x5 k* {% W1 d; v
21.   }
    2 c0 N$ B+ I- [" O7 P
22. })
    % `/ q5 g7 Y; f% a, |9 s
23. </script>

复制代码

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

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

复制代码

7 A% \7 s& _& {5 q
" j0 Z5 x( i9 I+ N; g( I7 R

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

实例
: D/ D) R5 ^. \. S# s" Q  W- A$ g+ Z

1. <div id="app">
   
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   
3. </div>
     E/ _3 k, J: _2 P
4. 
   $ r, V2 i+ X& V9 J" G# X& l
5. <script>
   
6. Vue.directive('runoob', function (el, binding) {
   
7.     // 简写方式设置文本及背景颜色
   
8.     el.innerHTML = binding.value.text
   ( Y, `% ^% ?! n. Y0 `
9.     el.style.backgroundColor = binding.value.color
   % h+ e' c; p6 M$ E
10. })
    
11. new Vue({
    
12.   el: '#app'
    
13. })
    
14. </script>

复制代码

) \4 w1 w, X# Y6 H# M( g
* E& F8 b5 {0 E) X3 X5 h