はじめに

ビデオでVueUseを学ぶ

VueUseは、Composition APIに基づいたユーティリティ関数のコレクションです。先に進む前に、Composition 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 3およびNuxt Bridgeで自動インポートを有効にするNuxtモジュールを同梱しました。

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>

詳細については関数リストを参照してください。