VueUse:Vue 3 开发中的强大 Hooks 库

2024-06-19 11:52

本文主要是介绍VueUse:Vue 3 开发中的强大 Hooks 库,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

         一、什么是 VueUse?

二、安装和使用 VueUse

三、常用 Hooks 介绍

1. useDebounce 和 useThrottle

useDebounce

useThrottle

2. useRequest

3. useTitle

4. useCounter

5. useToggle

6. useFullscreen

7. useInterval 和 useTimeout

useInterval

useTimeout

8. useMounted 和 useUnmounted

useMounted

useUnmounted

9. useAsync

10. useLocalStorage 和 useSessionStorage

useLocalStorage

useSessionStorage

四、高级功能和最佳实践

11. useClipboard

12. useRoute 和 useRouter

13. useStorage

14. useElementByPoint

15. useEventListener

16. useCssVars

五、VueUse 的类型安全

六、自定义 Hooks

七、最佳实践和建议

八、结论


随着 Vue 3 的推出,Composition API 成为了一个备受关注的新特性,它使得组件的逻辑复用和组织变得更加灵活和高效。VueUse 是一个基于 Vue 3 Composition API 的高质量 Hooks 库,它为开发者提供了一系列简单好用的 Hooks,可以帮助我们快速实现各种功能,提高开发效率。

本文将介绍 VueUse 的一些常用 Hooks,以及如何在 Vue 3 项目中使用它们。

一、什么是 VueUse?

VueUse 是一个基于 Vue 3 Composition API 的高质量 Hooks 库,它提供了许多简单好用的 Hooks,可以帮助开发者快速实现各种功能。VueUse 的 Hooks 覆盖了数据请求、状态管理、视图操作、性能优化等多个方面,使得开发者可以更加专注于业务逻辑的实现。

二、安装和使用 VueUse

要使用 VueUse,首先需要安装它。可以通过 npm 或 yarn 安装:

npm install vueuse# 或yarn add vueuse

在 Vue 3 项目中,可以在 main.jsmain.ts 文件中全局引入 VueUse:

import { createApp } from 'vue'
import App from './App.vue'
import { createVueUse } from 'vueuse'const app = createApp(App)const vueUse = createVueUse(app)
app.use(vueUse)app.mount('#app')

或者,在需要使用特定 Hook 的时候,可以单独导入:

import { useRequest } from 'vueuse'

三、常用 Hooks 介绍

VueUse 提供了许多实用的 Hooks,下面我们来介绍一些常用的 Hooks。

1. useDebounce 和 useThrottle

useDebounceuseThrottle 用于实现防抖和节流功能。在输入框输入、窗口大小变化等场景中,我们需要对频繁触发的事件进行处理,此时可以使用防抖或节流来减少事件的处理次数,提高性能。

useDebounce
import { useDebounce } from 'vueuse'const input = ref('')
const debouncedValue = useDebounce(input, 500)

在上面的示例中,debouncedValue 将是一个防抖处理后的值,这意味着在用户停止输入 500 毫秒后,才会触发事件。

useThrottle
import { useThrottle } from 'vueuse'const handleResize = useThrottle(() => {// 处理窗口大小变化事件
}, 1000)
在上面的示例中,handleResize 将是一个节流处理后的函数,这意味着在指定的时间间隔内,事件将只触发一次。

2. useRequest

useRequest 用于实现数据请求和缓存。在项目中,我们经常需要调用 API 获取数据,使用 useRequest 可以简化这个过程,同时支持数据缓存和错误处理。

import { useRequest } from 'vueuse'const { data, loading, error } = useRequest(() => fetchData())

在上面的示例中,useRequest 创建了一个响应式对象,包括数据、加载状态和错误信息。当数据请求完成时,data 将包含结果,loading 将设置为 false,如果发生错误,error 将包含错误信息。

3. useTitle

useTitle 用于操作浏览器标题。在需要根据页面内容动态更新标题的场景中,可以使用这个 Hook。

import { useTitle } from 'vueuse'useTitle('新标题')

在上面的示例中,页面标题将被更新为“新标题”。

4. useCounter

useCounter 用于实现一个简单的计数器功能。在需要递增或递减数值的场景中,可以使用这个 Hook。

import { useCounter } from 'vueuse'const { count, increment, decrement } = useCounter(1)

在上面的示例中,count 将是一个响应式的计数器值,incrementdecrement 分别是递增和递减计数器的函数。

5. useToggle

useToggle 用于实现一个切换功能。在需要在两个值之间切换的场景中,可以使用这个 Hook。

import { useToggle } from 'vueuse'const [isActive, toggle] = useToggle(false)

在上面的示例中,isActive 将是一个响应式的布尔值,表示当前的状态,toggle 是一个函数,用于切换状态。

6. useFullscreen

useFullscreen 用于控制全屏状态。在需要切换元素的全屏和非全屏状态的场景中,可以使用这个 Hook。

import { useFullscreen } from 'vueuse'const { fullscreen, toggle } = useFullscreen()

在上面的示例中,fullscreen 将是一个响应式的布尔值,表示当前是否处于全屏状态,toggle 是一个函数,用于切换全屏状态。

7. useInterval 和 useTimeout

useIntervaluseTimeout 用于实现定时器和倒计时功能。在需要定时执行某些操作或实现倒计时效果的场景中,可以使用这两个 Hook。

useInterval
	import { useInterval } from 'vueuse'useInterval(() => {// 定时执行的操作
}, 1000)

在上面的示例中,useInterval 将定期执行提供的函数,每隔 1000 毫秒执行一次。

useTimeout
import { useTimeout } from 'vueuse'const timer = useTimeout(() => {// 执行操作
}, 5000)

在上面的示例中,useTimeout 将创建一个定时器,如果在 5000 毫秒内没有取消,将执行提供的函数。

8. useMounted 和 useUnmounted

useMounteduseUnmounted 用于判断组件是否已经挂载和卸载。在需要根据组件生命周期优化性能和清理资源的场景中,可以使用这两个 Hook。

useMounted
import { useMounted } from 'vueuse'const isMounted = useMounted()

在上面的示例中,isMounted 将是一个响应式的布尔值,表示组件是否已经挂载。

useUnmounted
	import { useUnmounted } from 'vueuse'const isUnmounted = useUnmounted()

在上面的示例中,isUnmounted 将是一个响应式的布尔值,表示组件是否已经卸载。

9. useAsync

useAsync 用于处理异步操作,可以简化异步逻辑,使其更加清晰易读。

import { useAsync } from 'vueuse'const { data, loading, error } = useAsync(() => fetchData())

在上面的示例中,useAsync 创建了一个响应式对象,包括数据、加载状态和错误信息。当异步操作完成时,data 将包含结果,loading 将设置为 false,如果发生错误,error 将包含错误信息。

10. useLocalStorage 和 useSessionStorage

useLocalStorageuseSessionStorage 用于操作浏览器的本地存储,可以方便地存取数据。

useLocalStorage
import { useLocalStorage } from 'vueuse'const localStorageValue = useLocalStorage('key', 'default')

在上面的示例中,useLocalStorage 将获取或设置本地存储中对应 key 的值,如果没有找到 key,则返回 default 值。

useSessionStorage
import { useSessionStorage } from 'vueuse'const sessionStorageValue = useSessionStorage('key', 'default')

在上面的示例中,useSessionStorage 将获取或设置会话存储中对应 key 的值,如果没有找到 key,则返回 default 值。

四、高级功能和最佳实践

VueUse 还提供了一些高级功能和最佳实践,可以帮助开发者更好地组织和复用代码。

11. useClipboard

useClipboard 用于实现复制文本到剪贴板的功能。

import { useClipboard } from 'vueuse'const { copy, isCopy } = useClipboard('复制的内容')

在上面的示例中,copy 是一个函数,用于将文本复制到剪贴板,isCopy 是一个响应式的布尔值,表示文本是否已经被复制。

12. useRoute 和 useRouter

useRouteuseRouter 用于访问 Vue Router 的路由信息和路由器实例。

import { useRoute, useRouter } from 'vueuse'const route = useRoute()
const router = useRouter()

在上面的示例中,route 提供了对当前路由的访问,包括路径、查询参数等,router 提供了路由器的实例,可以用来导航、解析路由等。

13. useStorage

useStorage 用于操作浏览器的本地存储,可以方便地存取数据。

import { useStorage } from 'vueuse'const storageValue = useStorage('key', 'default')

在上面的示例中,useStorage 将获取或设置本地存储中对应 key 的值,如果没有找到 key,则返回 default 值。

14. useElementByPoint

useElementByPoint 用于根据鼠标位置获取页面上的元素。

import { useElementByPoint } from 'vueuse'const element = useElementByPoint(x, y)

在上面的示例中,element 将返回鼠标位置 (x, y) 对应的元素。

15. useEventListener

useEventListener 用于添加和移除事件监听器。

import { useEventListener } from 'vueuse'useEventListener('resize', handleResize)

在上面的示例中,useEventListener 将添加一个名为 resize 的事件监听器,当事件触发时,将执行 handleResize 函数。

16. useCssVars

useCssVars 用于获取和设置 CSS 变量的值。

import { useCssVars } from 'vueuse'const color = useCssVars('--color')

在上面的示例中,color 将返回 CSS 变量 --color 的值。

五、VueUse 的类型安全

VueUse 是一个类型安全的 Hooks 库,这意味着它提供了明确的类型定义,可以帮助开发者在使用 Hooks 时避免潜在的类型错误。在使用 VueUse 的 Hooks 时,你可以享受到 TypeScript 提供的类型检查和自动补全功能,这可以大大提高开发效率和代码质量。

例如,当你使用 useRequest Hook 时,你可以指定请求的类型和返回值的类型,这样 TypeScript 就可以在编译时检查这些类型,确保你提供的数据是正确的。

import { useRequest } from 'vueuse'const { data, loading, error } = useRequest<typeof fetchData>(() => fetchData())

在上面的示例中,我们使用了泛型 typeof fetchData 来指定 useRequest 的参数类型,这样 TypeScript 就会检查 fetchData 函数的返回值是否与指定的类型匹配。

六、自定义 Hooks

VueUse 也鼓励开发者创建自己的自定义 Hooks。自定义 Hooks 可以帮助你将复杂的逻辑封装到独立的函数中,使其更容易重用和维护。你可以通过组合 VueUse 提供的 Hooks 和其他 Composition API 功能来创建自定义 Hooks。

例如,你可能想要创建一个自定义 Hook,它结合了 useRequestuseInterval 来定期更新数据。

import { useRequest, useInterval } from 'vueuse'function useAutoUpdate<T>(fetch: () => Promise<T>, interval = 60000) {const { data, loading, error } = useRequest(fetch)useInterval(() => {fetch().then((newData) => {data.value = newData})}, interval)return { data, loading, error }
}// 使用自定义 Hook
const { data, loading, error } = useAutoUpdate(fetchData, 60000)

在上面的示例中,我们创建了一个名为 useAutoUpdate 的自定义 Hook,它接受一个 fetch 函数和一个可选的 interval 参数。这个 Hook 会返回一个包含数据、加载状态和错误信息的对象。

七、最佳实践和建议

在使用 VueUse 时,以下是一些最佳实践和建议:

  1. 类型安全:尽可能使用类型安全的方式使用 Hooks,这可以帮助你在早期发现潜在的错误。

  2. 模块化:将代码分成小的、可重用的模块,这有助于提高代码的可读性和可维护性。

  3. 避免过度使用:虽然 Hooks 很强大,但过度使用可能会导致代码变得复杂。只有在确实需要的情况下才使用 Hooks。

  4. 阅读文档:VueUse 的文档提供了详细的说明和示例,花时间阅读可以帮助你更好地理解和使用 Hooks。

  5. 贡献开源:如果你在使用 VueUse 的过程中遇到了问题或者有好的想法,考虑贡献回社区,帮助其他开发者。

  6. 保持更新:VueUse 库会不断更新和添加新的 Hooks,保持关注和更新你的项目,以利用最新的功能和修复。

八、结论

VueUse 提供了一个丰富且强大的 Hooks 库,可以帮助开发者快速实现各种功能,提高开发效率。在实际开发中,可以根据具体需求选择合适的 Hooks,并结合 Composition API 的其他特性,实现组件的逻辑复用和组织。同时,也要注意遵循编程规范和最佳实践,以确保代码的可维护性和性能。

通过本文的介绍,希望能帮助更多开发者了解和应用 VueUse,充分发挥其在 Vue 3 开发中的优势。

这篇关于VueUse:Vue 3 开发中的强大 Hooks 库的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1074959

相关文章

vue, 左右布局宽,可拖动改变

1:建立一个draggableMixin.js  混入的方式使用 2:代码如下draggableMixin.js  export default {data() {return {leftWidth: 330,isDragging: false,startX: 0,startWidth: 0,};},methods: {startDragging(e) {this.isDragging = tr

vue项目集成CanvasEditor实现Word在线编辑器

CanvasEditor实现Word在线编辑器 官网文档:https://hufe.club/canvas-editor-docs/guide/schema.html 源码地址:https://github.com/Hufe921/canvas-editor 前提声明: 由于CanvasEditor目前不支持vue、react 等框架开箱即用版,所以需要我们去Git下载源码,拿到其中两个主

React+TS前台项目实战(十七)-- 全局常用组件Dropdown封装

文章目录 前言Dropdown组件1. 功能分析2. 代码+详细注释3. 使用方式4. 效果展示 总结 前言 今天这篇主要讲全局Dropdown组件封装,可根据UI设计师要求自定义修改。 Dropdown组件 1. 功能分析 (1)通过position属性,可以控制下拉选项的位置 (2)通过传入width属性, 可以自定义下拉选项的宽度 (3)通过传入classN

Eclipse+ADT与Android Studio开发的区别

下文的EA指Eclipse+ADT,AS就是指Android Studio。 就编写界面布局来说AS可以边开发边预览(所见即所得,以及多个屏幕预览),这个优势比较大。AS运行时占的内存比EA的要小。AS创建项目时要创建gradle项目框架,so,创建项目时AS比较慢。android studio基于gradle构建项目,你无法同时集中管理和维护多个项目的源码,而eclipse ADT可以同时打开

js+css二级导航

效果 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN""http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Con

基于Springboot + vue 的抗疫物质管理系统的设计与实现

目录 📚 前言 📑摘要 📑系统流程 📚 系统架构设计 📚 数据库设计 📚 系统功能的具体实现    💬 系统登录注册 系统登录 登录界面   用户添加  💬 抗疫列表展示模块     区域信息管理 添加物资详情 抗疫物资列表展示 抗疫物资申请 抗疫物资审核 ✒️ 源码实现 💖 源码获取 😁 联系方式 📚 前言 📑博客主页:

vue+el国际化-东抄西鉴组合拳

vue-i18n 国际化参考 https://blog.csdn.net/zuorishu/article/details/81708585 说得比较详细。 另外做点补充,比如这里cn下的可以以项目模块加公共模块来细分。 import zhLocale from 'element-ui/lib/locale/lang/zh-CN' //引入element语言包const cn = {mess

vue同页面多路由懒加载-及可能存在问题的解决方式

先上图,再解释 图一是多路由页面,图二是路由文件。从图一可以看出每个router-view对应的name都不一样。从图二可以看出层路由对应的组件加载方式要跟图一中的name相对应,并且图二的路由层在跟图一对应的页面中要加上components层,多一个s结尾,里面的的方法名就是图一路由的name值,里面还可以照样用懒加载的方式。 页面上其他的路由在路由文件中也跟图二是一样的写法。 附送可能存在

vue+elementUI下拉框联动显示

<el-row><el-col :span="12"><el-form-item label="主账号:" prop="partyAccountId" :rules="[ { required: true, message: '主账号不能为空'}]"><el-select v-model="detailForm.partyAccountId" filterable placeholder="

vue+elementui分页输入框回车与页面中@keyup.enter事件冲突解决

解决这个问题的思路只要判断事件源是哪个就好。el分页的回车触发事件是在按下时,抬起并不会再触发。而keyup.enter事件是在抬起时触发。 so,找不到分页的回车事件那就拿keyup.enter事件搞事情。只要判断这个抬起事件的$event中的锚点样式判断不等于分页特有的样式就可以了 @keyup.enter="allKeyup($event)" //页面上的//js中allKeyup(e