nuxt logo

ドキュメント翻訳(非公式)

状態管理

Nuxtは強力な状態管理ライブラリと、リアクティブでSSRに適した共有状態を作成するためのuseStateコンポーザブルを提供します。

Nuxtは、コンポーネント間でリアクティブでSSRに適した共有状態を作成するためのuseStateコンポーザブルを提供します。

useStateは、SSRに適したrefの代替です。その値はサーバーサイドレンダリング後(クライアントサイドのハイドレーション中)に保持され、ユニークなキーを使用してすべてのコンポーネント間で共有されます。

useState内のデータはJSONにシリアライズされるため、クラス、関数、シンボルなどシリアライズできないものを含まないことが重要です。

こちらも参照 api > composables > use-state

ベストプラクティス

const state = ref()<script setup>setup()関数の外で定義しないでください。
例えば、export myState = ref({})を行うと、サーバー上でリクエスト間で状態が共有され、メモリリークを引き起こす可能性があります。

代わりにconst useX = () => useState('x')を使用してください。

基本的な使用法

この例では、コンポーネントローカルのカウンター状態を使用します。useState('counter')を使用する他のコンポーネントは、同じリアクティブな状態を共有します。

app/app.vue
<script setup lang="ts">
const counter = useState('counter', () => Math.round(Math.random() * 1000))
</script>

<template>
  <div>
    Counter: {{ counter }}
    <button @click="counter++">
      +
    </button>
    <button @click="counter--">
      -
    </button>
  </div>
</template>
サンプルコードの編集とプレビューexamples > features > state-management

キャッシュされた状態をグローバルに無効化するには、clearNuxtStateユーティルを参照してください。

状態の初期化

ほとんどの場合、非同期に解決されるデータで状態を初期化したいでしょう。そのためには、app.vueコンポーネントとcallOnceユーティルを使用できます。

app/app.vue
const websiteConfig = useState('config')

await callOnce(async () => {
  websiteConfig.value = await $fetch('https://my-cms.com/api/website-config')
})

これはNuxt 2のnuxtServerInitアクションに似ており、ページをレンダリングする前にサーバーサイドでストアの初期状態を埋めることができます。

こちらも参照 api > utils > call-once

Piniaとの使用

この例では、Piniaモジュールを活用してグローバルストアを作成し、アプリ全体で使用します。

npx nuxt module add piniaを使用してPiniaモジュールをインストールするか、モジュールのインストール手順に従ってください。

export const useWebsiteStore = defineStore('websiteStore', {
  state: () => ({
    name: '',
    description: ''
  }),
  actions: {
    async fetch() {
      const infos = await $fetch('https://api.nuxt.com/modules/pinia')

      this.name = infos.name
      this.description = infos.description
    }
  }
})

高度な使用法

import type { Ref } from 'vue'

export const useLocale = () => {
  return useState<string>('locale', () => useDefaultLocale().value)
}

export const useDefaultLocale = (fallback = 'en-US') => {
  const locale = ref(fallback)
  if (import.meta.server) {
    const reqLocale = useRequestHeaders()['accept-language']?.split(',')[0]
    if (reqLocale) {
      locale.value = reqLocale
    }
  } else if (import.meta.client) {
    const navLang = navigator.language
    if (navLang) {
      locale.value = navLang
    }
  }
  return locale
}

export const useLocales = () => {
  const locale = useLocale()
  const locales = ref([
    'en-US',
    'en-GB',
    ...
    'ja-JP-u-ca-japanese'
  ])
  if (!locales.value.includes(locale.value)) {
    locales.value.unshift(locale.value)
  }
  return locales
}

export const useLocaleDate = (date: Ref<Date> | Date, locale = useLocale()) => {
  return computed(() => new Intl.DateTimeFormat(locale.value, { dateStyle: 'full' }).format(unref(date)))
}
サンプルコードの編集とプレビューexamples > advanced > locale

共有状態

自動インポートされたコンポーザブルを使用することで、グローバルな型安全な状態を定義し、アプリ全体でインポートできます。

composables/states.ts
export const useColor = () => useState<string>('color', () => 'pink')
app/app.vue
<script setup lang="ts">
// ---cut-start---
const useColor = () => useState<string>('color', () => 'pink')
// ---cut-end---
const color = useColor() // useState('color')と同じ
</script>

<template>
  <p>現在の色: {{ color }}</p>
</template>

サードパーティライブラリの使用

Nuxtは以前、グローバル状態管理を提供するためにVuexライブラリに依存していました。Nuxt 2から移行する場合は、移行ガイドを参照してください。

Nuxtは状態管理について特に意見を持っていないため、ニーズに合ったソリューションを自由に選択してください。最も人気のある状態管理ライブラリとの統合が複数あります。例えば:

  • Pinia - 公式のVue推奨
  • Harlem - 不変のグローバル状態管理
  • XState - 状態マシンアプローチで、状態ロジックの視覚化とテストのためのツールを提供