Vue自定义全局指令

Vue自定义全局指令教程

Vue 除了默认设置的核心指令( v-modelv-textv-html 以及 v-show 等),Vue 也允许注册自定义指令。

在 Vue 2.0 里面,代码复用的主要形式和抽象是组件。然而,有的情况下,我们仍然需要对纯 DOM 元素进行底层操作,这时候就会用到自定义指令。

Vue自定义全局指令详解

语法

Vue.directive('cmdname', {hook:function(el, binding){}})

说明

其中,参数 1,是指令的名称,指令的名称在定义的时候,前面不能加 v- 前缀。但是在调用的时候,必须在指令名称前加 v- 前缀进行调用。

参数 2,是一个对象,在这个对象身上,有一些指令相关的函数,这些函数可以在特定的阶段,执行相关的操作。

Vue自定义全局指令钩子函数

Vue 指令定义函数提供了以下几个钩子函数:

钩子函数 描述
bind 只调用一次,指令第一次绑定到元素时调用,用这个钩子函数可以定义一个在绑定时执行一次的初始化动作。
inserted 被绑定元素插入父节点时调用(父节点存在即可调用,不必存在于 document 中)。
update 被绑定元素所在的模板更新时调用,而不论绑定值是否变化。通过比较更新前后的绑定值,可以忽略不必要的模板更新。
componentUpdated 被绑定元素所在模板完成一次更新周期时调用。
unbind 只调用一次, 指令与元素解绑时调用。

Vue自定义全局指令钩子函数参数

el

  • 指令所绑定的元素,可以用来直接操作 DOM 。

binding

bingding是一个对象,包含以下属性:

  • 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 }。

v-node

  • Vue 编译生成的虚拟节点。

oldVnode

  • 上一个虚拟节点,仅在 update 和 componentUpdated 钩子中可用。

除了 el 之外,其它参数都应该是只读的,尽量不要修改他们。如果需要在钩子之间共享数据,建议通过元素的 dataset 来进行。

案例

Vue自定义全局指令

<!DOCTYPE html> <html> <head> <title>Vue 自定义全局指令</title> <script type="text/javascript" src="./lib/vue-2.6.10.min.js"></script> </head> <style type="text/css"> </style> <body> <div id="app"> <input type="text" value="" v-focus> <p>嗨客网(www.haicoder.net)</p> </div> </body> <script type="text/javascript"> Vue.directive('focus', { inserted: function(el){ el.focus(); } }) var vm = new Vue({ el :'#app', data:{ } }) </script> </html>

浏览器运行效果如下图所示:

01 vue directive.png

当我们程序一运行后,input 输入框自动获取了焦点。

Vue自定义全局指令总结

在使用 Vue 有的情况下,我们仍然需要对纯 DOM 元素进行底层操作,这时候就会用到自定义指令。Vue 自定义全局指令的语法是:

Vue.directive('cmdname', {hook:function(param){}})