Vue.directive()的用法和实例

173 阅读3分钟

一个指令定义对象可以提供如下几个钩子函数 (均为可选):

bind:只调用一次,指令第一次绑定到元素时调用,用这个钩子函数可以定义一个在绑定时执行一次的初始化动作。

inserted:被绑定元素插入父节点时调用 (仅保证父节点存在,但不一定已被插入文档中)。

update:所在组件的 VNode 更新时调用,但是可能发生在其子 VNode 更新之前。指令的值可能发生了改变,也可能没有。但是你可以通过比较更新前后的值来忽略不必要的模板更新 (详细的钩子函数参数见下)。

componentUpdated:指令所在组件的 VNode 及其子 VNode 全部更新后调用。

unbind:只调用一次,指令与元素解绑时调用。

created:在绑定元素的 attribute 或事件监听器被应用之前调用;

beforeMount:当指令第一次绑定到元素并且在挂载父组件之前调用;

mounted:在绑定元素的父组件被挂载后调用;

beforeUpdate:在更新包含组件的 VNode 之前调用;

updated:在包含组件的 VNode 及其子组件的 VNode 更新后调用;

beforeUnmount:在卸载绑定元素的父组件之前调用;

unmounted:当指令与元素解除绑定且父组件已卸载时,只调用一次;

钩子函数参数

接下来我们来看一下钩子函数的参数 (即 el、binding、vnode 和 oldVnode)。

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

binding:一个对象,包含以下 property:

name:指令名,不包括 v- 前缀。

value:指令的绑定值,例如:v-my-directive=“1 + 1” 中,绑定值为 2。

oldValue:指令绑定的前一个值,仅在 update 和 componentUpdated 钩子中可用。无论值是否改变都可用。

expression:字符串形式的指令表达式。例如 v-my-directive=“1 + 1” 中,表达式为 “1 + 1”。

arg:传给指令的参数,可选。例如 v-my-directive:foo 中,参数为 “foo”。

modifiers:一个包含修饰符的对象。例如:v-my-directive.foo.bar 中,修饰符对象为 { foo: true, bar: true }。

vnode:Vue 编译生成的虚拟节点。移步 VNode API 来了解更多详情。

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

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

// 注册
Vue.directive('my-directive', {
  bind: function () {},
  inserted: function () {},
  update: function () {},
  componentUpdated: function () {},
  unbind: function () {}
})

// 注册 (指令函数)
Vue.directive('my-directive', function () {
  // 这里将会被 `bind` 和 `update` 调用
})

// getter,返回已注册的指令
var myDirective = Vue.directive('my-directive')

Dome

html
<div id="app">
    <div class="box1" v-drag>拖拽1</div>
    <div class="box2" v-drag>拖拽2</div>
  </div>
 
css
 .box1,.box2{
    height:100px;
    width:100px;
    border:1px solid #000;
    position: absolute;
    -webkit-user-select: none;
    -ms-user-select: none;
    -moz-user-select: -moz-none;
    cursor: pointer;
  }
.box2{
    left:200px;
}

main.js
import directive from "./utils/index.js";
app.use(directive)


index.js
import directive from './directive';
export default function directives(app) {
    directive.vdrag(app);
}

directive.js
function vdrag(app){
    app.directive('drag', {
        created:function(el){
            el.onmousedown=function(e){
                let l=e.clientX-el.offsetLeft;
                let t=e.clientY-el.offsetTop;
                document.onmousemove=function(e){
                    el.style.left=e.clientX-l+'px';
                    el.style.top=e.clientY-t+'px';
                };
                el.onmouseup=function(){
                    document.onmousemove=null;
                    el.onmouseup=null;
                }
            }
        }
    })
}

export default {
    vdrag
}