开始使用

通过视频学习 VueUse

VueUse 是一个基于 Composition API 的工具函数集合。在继续之前，我们假设您已经熟悉 Composition API 的基本概念。

安装

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

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>

查看函数列表获取更多详情。