开始使用

观看视频学习 VueUse

VueUse 是一个基于 组合式 API 的实用函数集合。在继续之前，我们假设你已经熟悉 组合式 API 的基本概念。

安装

从 v12.0 开始，VueUse 不再支持 Vue 2。如需 Vue 2 支持请使用 v11.x 版本。

npm i @vueuse/core

附加组件 | Nuxt 模块

示例项目

• Vite + Vue 3
• Nuxt 3 + Vue 3
• Webpack + Vue 3

CDN

<script src="https://unpkg.com/@vueuse/shared"></script>

<script src="https://unpkg.com/@vueuse/core"></script>

这将会在全局暴露为 window.VueUse

Nuxt

从 v7.2.0 开始，我们发布了一个 Nuxt 模块，为 Nuxt 3 和 Nuxt Bridge 提供自动导入功能。

使用 nuxi 在你的应用中安装 vueuse 模块：

npx nuxi@latest module add vueuse

或使用 npm：

npm i -D @vueuse/nuxt @vueuse/core

Nuxt 3 配置：

// nuxt.config.ts
export default defineNuxtConfig({
  modules: [
    '@vueuse/nuxt',
  ],
})

Nuxt 2 配置：

// nuxt.config.js
export default {
  buildModules: [
    '@vueuse/nuxt',
  ],
}

然后你就可以在 Nuxt 应用的任何地方使用 VueUse 函数。例如：

<script setup lang="ts">
const { x, y } = useMouse()
</script>

<template>
  <div>位置：{{ x }}, {{ y }}</div>
</template>

使用示例

只需从 @vueuse/core 中导入你需要的函数

<script setup>
import { useLocalStorage, useMouse, usePreferredDark } from '@vueuse/core'

// 跟踪鼠标位置
const { x, y } = useMouse()

// 用户是否偏好深色主题
const isDark = usePreferredDark()

// 在 localStorage 中持久化状态
const store = useLocalStorage(
  'my-storage',
  {
    name: 'Apple',
    color: 'red',
  },
)
</script>

更多详细信息请参考函数列表。