开始

通过视频学习 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 的自动导入。

使用 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>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>

有关更多详细信息，请参阅函数列表。