浅析vue3项目中自定义指令的运用

 更新时间:2023年08月13日 10:45:22   作者:小五Five  
自定义指令是一种在Vue应用程序中扩展HTML标签的能力,通过自定义指令,我们可以直接在模板中使用指令名,下面我们就来看看项目中具体如何使用自定义指令的吧

一、什么是自定义指令

1. 定义

自定义指令是一种在Vue应用程序中扩展HTML标签的能力。通过自定义指令,我们可以直接在模板中使用指令名,并为其提供相应的逻辑。自定义指令可以用于添加事件监听、修改DOM元素、操作样式等各种场景。

2. 什么时候使用自定义指定

(来自Vue官网)

只有在某些情况下,当需要的功能无法通过内置指令或组件属性来实现时,才应该使用自定义指令。在其他情况下,我们应该尽可能地使用内置指令(例如 v-bind )来声明式地操作模板,这样做更高效,并且对于服务端渲染也更加友好。

当我们需要直接操作DOM元素、引入第三方库或处理特定的浏览器事件时,自定义指令可以提供一种灵活的解决方案。它允许我们以命令式的方式来修改DOM,但也可能导致代码更难维护、测试和理解。

二、Vue3中的自定义指令

1.全局自定义指令

全局自定义指令可以在整个Vue应用程序中使用。

在main.js里面注册:

<!-- main.js -->
import App from './App.vue'
const app = createApp(App)
const focusDirective = directive('focus', {
  mounted(el) {
    el.focus()
  }
})
app.directive('focus', focusDirective)
app.mount('#app')

上面创建了一个名为 focusDirective 的全局自定义指令,它用于将 focus() 方法应用到DOM元素上,从而在渲染后在输入框上设置焦点。然后,我们通过 app.directive('focus', focusDirective) 将该指令添加到Vue应用程序中。

在组件中,我们可以直接使用v-focus指令:

<!-- App.vue -->
<template>
  <div>
    <input v-focus />
  </div>
</template>
<script setup>
// 略去导入模块等逻辑
</script>

2. 组件自定义指令

组件自定义指令是针对特定组件而言的,它只在该组件的范围内生效。任何以  v  开头的驼峰式命名的变量都可以被用作一个自定义指令。所以直接声明即可,vue会自动识别。

<template>
  <div v-change-color></div>
</template>
<script setup>
  const changeColorDirective = {
    mounted(el) {
      el.addEventListener('mouseenter', () => {
        el.style.backgroundColor = 'blue'
      })
      el.addEventListener('mouseleave', () => {
        el.style.backgroundColor = ''
      })
    }
  }
  // 直接声明
  const vChangeColor = changeColorDirective
</script>
<style scoped>
  div {
    width: 100px;
    height: 100px;
    background-color: red;
    box-sizing: border-box;
  }
</style>

三、指令钩子

1. 钩子

一个指令的定义对象可以提供几种钩子函数 (都是可选的):

2. 钩子参数

(来自vue官网)

四、自定义指令的常见用法

自定义指令在项目中有多种常见用法。这里我们介绍两个常见的用例:添加事件监听和操作DOM元素。

1.添加事件监听

自定义指令可以用于添加事件监听,并在触发事件时执行相应的逻辑。例如,我们可以创建一个自定义指令来实现点击按钮时显示一条提示信息:

<template>
  <div>
    <button v-show-message>Click me!</button>
    <p>{{ message }}</p>
  </div>
</template>
<script setup>
import { ref } from 'vue'
const showMessageDirective = {
  mounted(el) {
    el.addEventListener('click', showMessage)
  },
  unmounted(el) {
    el.removeEventListener('click', showMessage)
  }
}
const message = ref('')
const showMessage = () => {
  message.value = 'Button clicked!'
}
</script>

在上述示例中,我们创建了一个名为  vShowMessage 的自定义指令,它在元素上添加了一个点击事件监听器。当按钮被点击时,将触发  showMessage  函数,并更新  message  的值。

2.操作DOM

自定义指令还可以用于直接操作DOM元素,例如修改样式、添加类名等。

比如做项目时常见的情况,使用自定义指令来处理图片加载错误,并显示默认图:

<template>
  <div>
    <img v-error="setFallbackImage" :src="imageSrc" />
  </div>
</template>
<script setup>
import { directive } from 'vue'
const vError = directive('error', {
  mounted(el, binding) {
    el.addEventListener('error', () => {
      binding.value(el)
    })
  },
})
const imageSrc = 'image.jpg'
const setFallbackImage = (el) => {
  el.src = 'fallback.jpg'
}
</script>
<style scoped>
img {
  width: 200px;
  height: 200px;
}
</style>

到此这篇关于浅析vue3项目中自定义指令的运用的文章就介绍到这了,更多相关vue3自定义指令内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • vue中marker被识别点击的过程场景分析

    vue中marker被识别点击的过程场景分析

    这篇文章主要介绍了vue中marker被识别点击的过程场景分析,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧
    2023-11-11
  • vue cookie和本地存储的使用详解

    vue cookie和本地存储的使用详解

    在Vue中,可以使用多种方式来处理cookie和本地存储,不同的方法还有不同的特点和适用场景,本文主要介绍了这些方法的对比和使用场景,希望对大家有所帮助
    2023-08-08
  • 使用element upload上传组件如何去掉删除按钮

    使用element upload上传组件如何去掉删除按钮

    这篇文章主要介绍了使用element upload上传组件如何去掉删除按钮
    2023-07-07
  • Vue Render函数创建DOM节点代码实例

    Vue Render函数创建DOM节点代码实例

    这篇文章主要介绍了Vue Render函数创建DOM节点代码实例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-07-07
  • 详解Vue基于vue-quill-editor富文本编辑器使用心得

    详解Vue基于vue-quill-editor富文本编辑器使用心得

    这篇文章主要介绍了Vue基于vue-quill-editor富文本编辑器使用心得,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2019-01-01
  • 一篇文章带你吃透Vuex3的状态管理

    一篇文章带你吃透Vuex3的状态管理

    Vuex是一个专为Vue.js应用程序开发的状态管理模式,它采用集中式存储管理应用的所有组件的状态,并以相应的规则保证状态以一种可预测的方式发生变化,下面这篇文章主要给大家介绍了关于如何通过一篇文章带你吃透Vuex3的状态管理,需要的朋友可以参考下
    2022-07-07
  • vux uploader 图片上传组件的安装使用方法

    vux uploader 图片上传组件的安装使用方法

    这篇文章主要介绍了vux-uploader 图片上传组件的安装及使用方法,非常不错,具有一定的参考借鉴价值,需要的朋友可以参考下
    2018-05-05
  • vue中使用echarts实现动态数据绑定以及获取后端接口数据

    vue中使用echarts实现动态数据绑定以及获取后端接口数据

    总结一下自己最近项目中用echarts动态获取接口数据并画图的方法,下面这篇文章主要给大家介绍了关于vue中使用echarts实现动态数据绑定以及获取后端接口数据的相关资料,需要的朋友可以参考下
    2022-07-07
  • 使用vant的地域控件追加全部选项

    使用vant的地域控件追加全部选项

    这篇文章主要介绍了使用vant的地域控件追加全部选项,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-11-11
  • Vue3中的setup执行时机与注意点说明

    Vue3中的setup执行时机与注意点说明

    这篇文章主要介绍了Vue3中的setup执行时机与注意点说明,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-07-07

最新评论