vue自定义指令

vue2自定义指令

钩子函数

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

• bing：只调用一次，指令第一次绑定到元素时调用。在这里可以进行一次性的初始化设置。
• inserted：被绑定元素插入父节点时调用 (仅保证父节点存在，但不一定已被插入文档中)。
• update：所在组件的 VNode 更新时调用，但是可能发生在其子 VNode 更新之前。指令的值可能发生了改变，也可能没有。但是你可以通过比较更新前后的值来忽略不必要的模板更新 (详细的钩子函数参数见下)。
• componentUpdated：指令所在组件的 VNode 及其子 VNode 全部更新后调用。
• unbind：只调用一次，指令与元素解绑时调用。

自己封装自定义指令常用的一般只有bind和unbind两个钩子函数

钩子函数参数

指令钩子函数会被传入以下参数：

• el：指令所绑定的元素，可以用来直接操作 DOM。
• binding：一个对象，包含以下 property：
  • name：指令名，不包括 v- 前缀。
  • value：指令的绑定值，
  • oldValue：指令绑定的前一个值，仅在 update 和 componentUpdated 钩子中可用。无论值是否改变都可用。
  • expression：字符串形式的指令表达式。
  • arg：传给指令的参数，可选。例如 v-my-directive:foo 中，参数为 "foo"。
  • modifiers：一个包含修饰符的对象。例如：v-my-directive.foo.bar 中，修饰符对象为 { foo: true, bar: true }。
• vnode：Vue 编译生成的虚拟节点，vnode.context就是当前的vm实例。
• oldVnode：上一个虚拟节点，仅在 update 和 componentUpdated 钩子中可用。

常用参数为el和binding，其中el用来获取绑定的node节点，binding用来调用传参或方法

页面注册使用

当页面加载时，该元素将获得焦点，只要你在打开这个页面后还没点击过任何内容，这个输入框就应当还是处于聚焦状态，通过v-focus使用

全局注册

// 注册一个全局自定义指令 `v-focus`
Vue.directive('focus', {
  // 当被绑定的元素插入到 DOM 中时……
  inserted: function (el) {
    // 聚焦元素
    el.focus()
  }
})

局部注册

directives: {
  focus: {
    // 指令的定义
    inserted: function (el) {
      el.focus()
    }
  }
}

抽离封装 

点击弹窗外部其他区域关闭弹窗

export default{
    //  bind只调用一次，指今第一次绑定到元素时调用。在这里可以进行一次性的初始化设置.
    bind(el,binding){
        // 因为异步问题,需要使用timeout延时绑定事件,否则直接就触发,绑定全局点击事件，触发使用组件传递过来的函参
        setTimeout(() => {
            document.addEventListener("click",binding.value);
        },20);
    }，

    // unbind: 只调用一次，指令与元素解绑时调用，每次组件销毁时需要解绑全局事件
    unbind(el,binding){
        document.removeEventListener("click"，binding.value);
    }
}

vue3自定义指令

使用方法大致相同，只是钩子函数与页面生命周期相仿

钩子函数 

• created：在绑定元素前或事件监听应用前调用
• beforeMount：在元素被插入到 DOM 前调用
• mounted：在绑定元素的父组件及他自己的所有子节点都挂载完成后调用
• beforeUpdate：绑定元素的父组件更新前调用
• updated在绑定元素的父组件，及他自己的所有子节点都更新后调用
• beforeUnmount：绑定元素的父组件卸载前调用
• unmounted：绑定元素的父组件卸载后调用

常用为mounted和beforeUnmount

钩子函数参数

指令的钩子都会传递以下几种参数

• el：指令绑定到的元素。这可以用于直接操作 DOM。
• binding：一个对象，包含以下属性。
  • value：传递给指令的值。
  • oldValue：之前的值，仅在 beforeUpdate 和 updated 中可用。无论值是否更改，它都可用。
  • arg：传递给指令的参数 (如果有的话)。例如在 v-my-directive:foo 中，参数是 "foo"。
  • modifiers：一个包含修饰符的对象 (如果有的话)。例如在 v-my-directive.foo.bar 中，修饰符对象是 { foo: true, bar: true }。
  • instance：使用该指令的组件实例。
  • dir：指令的定义对象。
• vnode：代表绑定元素的底层 VNode。
• prevNode：之前的渲染中代表指令所绑定元素的 VNode。仅在 beforeUpdate 和 updated 钩子中可用。等同于v2的oldVnode

页面注册使用

全局注册

const app = createApp({})

// 使 v-focus 在所有组件中都可用
app.directive('focus', {
  mounted: (el) => el.focus()
})

局部注册

const focus = {
  mounted: (el) => el.focus()
}

export default {
  directives: {
    // 在模板中启用 v-focus
    focus
  }
}

抽离封装

​
export default{
    //  在这里可以进行一次性的初始化设置.
    mounted(el,binding){
        // 因为异步问题,需要使用timeout延时绑定事件,否则直接就触发,绑定全局点击事件，触发使用组件传递过来的函参
        setTimeout(() => {
            document.addEventListener("click",binding.value);
        },20);
    }，

    // 只调用一次，指令与元素解绑时调用，每次组件销毁时需要解绑全局事件
    beforeUnmount(el,binding){
        document.removeEventListener("click"，binding.value);
    }
}

​