ステート管理
Nuxtは強力なステート管理ライブラリとuseStateコンポーザブルを提供し、リアクティブでSSRに対応した共有ステートを作成できます。
NuxtはuseState
コンポーザブルを提供して、コンポーネント間でリアクティブでSSRに対応した共有ステートを作成します。
useState
はSSRに対応したref
の代替品です。その値はサーバー側のレンダリング後(クライアント側の水分補給中)に保持され、ユニークなキーを使用してすべてのコンポーネント間で共有されます。
useState
内のデータはJSONにシリアライズされるため、クラス、関数、シンボルなどのシリアライズできないものを含んでいないことが重要です。
ベストプラクティス
const state = ref()
を<script setup>
またはsetup()
関数の外で定義しないでください。
例えば、export myState = ref({})
を行うと、サーバー上のリクエスト間でステートが共有され、メモリリークを引き起こす可能性があります。
代わりにconst useX = () => useState('x')
を使用してください。
実装例
基本的な使い方
この例では、コンポーネントローカルのカウンターステートを使用します。useState('counter')
を使用する他の任意のコンポーネントは同じリアクティブなステートを共有します。
<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>
グローバルにキャッシュされたステートを無効にするには、clearNuxtState
ユーティリティを参照してください。
ステートの初期化
ほとんどの場合、非同期に解決するデータでステートを初期化したいと思うでしょう。app.vue
コンポーネントとcallOnce
ユーティリティを使用することができます。
const websiteConfig = useState('config')
await callOnce(async () => {
websiteConfig.value = await $fetch('https://my-cms.com/api/website-config')
})
これは、Nuxt 2のnuxtServerInitアクションに似ており、ページをレンダリングする前にサーバーサイドでストアの初期ステートを埋めることができます。
Piniaを使用した例
この例では、Piniaモジュールを利用してグローバルストアを作成し、アプリ全体で使用します。
Piniaモジュールをnpx nuxt module add 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)))
}
共有ステート
自動インポートされたコンポーザブルを使用することにより、グローバルで型安全なステートを定義し、アプリ全体でそれらをインポートすることができます。
export const useColor = () => useState<string>('color', () => 'pink')
<script setup lang="ts">
// ---cut-start---
const useColor = () => useState<string>('color', () => 'pink')
// ---cut-end---
const color = useColor() // Same as useState('color')
</script>
<template>
<p>Current color: {{ color }}</p>
</template>
サードパーティライブラリの使用
Nuxtは以前はVuexライブラリに依存してグローバルなステート管理を提供していました。Nuxt 2から移行する場合は、移行ガイドを確認してください。
Nuxtはステート管理に関しては非常に柔軟であり、必要に応じて適切なソリューションを自由に選択できます。多くの人気ステート管理ライブラリとの統合があります:
※このページは Nuxt.js 公式ドキュメントの翻訳ページ(非公式)です。
公式ドキュメントの該当ページはこちら:
https://nuxt.com/docs/3.x/getting-started/state-management