首页 > 建站教程 > 前端框架 >  Vue自定义指令正文

Vue自定义指令

本文转载自CSDN博主「仰.」的原创文章,原文出处:https://blog.csdn.net/QWERTYQ16/article/details/122912485


一、 什么是自定义指令

除了核心功能默认内置的指令 (v-model 和 v-show),Vue 也允许注册自定义指令,对普通 DOM元素进行底层操作。


二、 如何自定义指令

自定义指令分为全局自定义指令和局部自定义指令


1.首先我们来看全局自定义指令:用Vue.directive来注册。


比如一个input自动聚焦的例子:在main.js中写入以下内容:

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


2.然后我们来看局部自定义指令:通过在组件内设置directives属性

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


3.使用的时候要在自定义的指令前面加上 v- ,然后你可以在模板中任何元素上使用新的 v-focus 

<input v-focus></input>


三、自定义指令的钩子函数

    bind:只调用一次,指令第一次绑定到元素时调用。在这里可以进行一次性的初始化设置。

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

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

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

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


这是V3的自定义指令的钩子函数:

// 指令是具有一组生命周期的钩子:
created  // 在绑定元素的 attribute 或事件监听器被应用之前调用
beforeMount  // 在绑定元素的父组件挂载之前调用
mounted  // 绑定元素的父组件被挂载时调用
beforeUpdate  // 在包含组件的 VNode 更新之前调用
updated  // 在包含组件的 VNode 及其子组件的 VNode 更新之后调用
beforeUnmount  // 在绑定元素的父组件卸载之前调用
unmounted  // 卸载绑定元素的父组件时调用


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


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 来进行。如以下例子:

<div v-demo="{ color: 'white', text: 'hello!' }"></div>
<script>
    Vue.directive('demo', function (el, binding) {
    console.log(binding.value.color) // "white"
    console.log(binding.value.text)  // "hello!"
    })
</script>