开始

通过视频学习 VueUse

VueUse 是基于 组合式 API 的实用函数集合。我们假设在继续之前，您已经熟悉 组合式 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 的自动导入。

使用 @nuxt/cli 将 vueuse 模块安装到您的应用程序中

npx nuxt@latest module add vueuse

或使用 npm

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

Nuxt 3

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

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

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

<template>
  <div>pos: {{ x }}, {{ y }}</div>
</template>

使用示例

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

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

// tracks mouse position
const { x, y } = useMouse()

// is user prefers dark theme
const isDark = usePreferredDark()

// persist state in localStorage
const store = useLocalStorage(
  'my-storage',
  {
    name: 'Apple',
    color: 'red',
  },
)
</script>

更多详情请参阅 函数列表。