Vue.js 自定义指令

admin

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

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

实例
/ V4 ?8 x: s) p& f& w# R

1. <div id="app">
   
2.     <p>页面载入时，input 元素自动获取焦点：</p>
   
3.     <input v-focus>
   
4. </div>
     W' X4 D& u/ \1 t
5. 
   
6. <script>
   
7. // 注册一个全局自定义指令 v-focus
   
8. Vue.directive('focus', {
   
9.   // 当绑定元素插入到 DOM 中。
   
10.   inserted: function (el) {
    , N2 L7 x# I& G
11.     // 聚焦元素
    ; `: O  `# t/ q7 g' k8 z# |
12.     el.focus()
    
13.   }
    
14. })
    
15. // 创建根实例
    7 P/ I1 `7 H- L- t: o* {8 W4 ^- R
16. new Vue({
    
17.   el: '#app'
    ) V" q  [: D# v+ H! L& z
18. })
    
19. </script>

复制代码

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

实例

1. <div id="app">
   
2.   <p>页面载入时，input 元素自动获取焦点：</p>
   
3.   <input v-focus>
   , v' P# I: U0 [
4. </div>
   
5. 
   " w) u% ?% s( `; V3 Q1 Y/ D
6. <script>
   
7. // 创建根实例
   
8. new Vue({
   
9.   el: '#app',
   8 d5 w' v3 x5 p: |# F
10.   directives: {
    
11.     // 注册一个局部的自定义指令 v-focus
    
12.     focus: {
    
13.       // 指令的定义
    
14.       inserted: function (el) {
    
15.         // 聚焦元素
    
16.         el.focus()
    / @9 u9 X4 m$ X4 R/ v
17.       }
    
18.     }
    
19.   }
    
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 }。
    
• vnode: Vue 编译生成的虚拟节点。
• oldVnode: 上一个虚拟节点，仅在 update 和 componentUpdated 钩子中可用。
  ; Z6 R6 M# x  A* B& @, w

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

实例
% ~  Z# a$ l9 t7 a
6 e9 c9 U, f8 W0 D6 f! q

1. <div id="app"  v-runoob:hello.a.b="message">
   
2. </div>
   - i1 `6 k, ~4 G1 v. Y$ Z9 Q8 Z: Z
3. 
     P6 A4 \1 B: w' t3 b3 L# V/ E3 Z
4. <script>
   % _4 O9 V/ l8 c0 e/ z
5. Vue.directive('runoob', {
   . k$ F. K3 e- ?. W  F6 Z
6.   bind: function (el, binding, vnode) {
   
7.     var s = JSON.stringify
   
8.     el.innerHTML =
   . a, i4 u( u0 c
9.       'name: '       + s(binding.name) + '<br>' +
   % b, c. \# v9 L* g- {8 g
10.       'value: '      + s(binding.value) + '<br>' +
    
11.       'expression: ' + s(binding.expression) + '<br>' +
    ! @4 E# Q! E) m
12.       'argument: '   + s(binding.arg) + '<br>' +
    
13.       'modifiers: '  + s(binding.modifiers) + '<br>' +
    * E  n1 U5 L$ J% E
14.       'vnode keys: ' + Object.keys(vnode).join(', ')
    
15.   }
    % o9 c7 }( K5 v0 _
16. })
    
17. new Vue({
    
18.   el: '#app',
    : t% |! Y8 O/ w" |
19.   data: {
    0 k% B5 o4 I! `7 {6 I% a
20.     message: '菜鸟教程!'
    
21.   }
    
22. })
    
23. </script>

复制代码

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

1. Vue.directive('runoob', function (el, binding) {
   5 w' ]% F5 M6 S1 O9 J
2.   // 设置指令的背景颜色
   
3.   el.style.backgroundColor = binding.value.color
   
4. })

复制代码

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

实例

8 b0 k  u0 H4 t) `; A/ u) C

1. <div id="app">
   2 ~" C+ i6 _% }1 R
2.     <div v-runoob="{ color: 'green', text: '菜鸟教程!' }"></div>
   4 G2 P' ^& [1 S; x" T3 }
3. </div>
   
4. 
   
5. <script>
   
6. Vue.directive('runoob', function (el, binding) {
   
7.     // 简写方式设置文本及背景颜色
   
8.     el.innerHTML = binding.value.text
   % |8 J2 ~- G8 `9 @
9.     el.style.backgroundColor = binding.value.color
   + _, H. q0 B( o, E
10. })
    
11. new Vue({
      X5 H5 D& \9 K2 ^7 Q# a
12.   el: '#app'
      U0 S6 l4 m3 V- n+ P+ ^* H6 D
13. })
    . p" B2 G$ ~* P2 S" h
14. </script>

复制代码

. ~! h3 C- |3 c/ e& G' T2 p# U, |