Управление состоянием

Nuxt предоставляет мощные библиотеки для управления состоянием и композабл useState для реактивного SSR-совместимого общего состояния.

Nuxt предоставляет композабл useState для создания реактивного и SSR-совместимого общего состояния между компонентами.

useState — SSR-совместимая замена ref. Значение сохраняется после серверного рендеринга (при гидратации на клиенте) и доступно всем компонентам с одним и тем же уникальным ключом.

Из-за того, что данные внутри useState будут сериализованы в JSON, важно, чтобы эти данные не содержали ничего, что не может быть сериализовано, например классы, функции или символы.
Подробнее о композабле useState.

Лучшие практики

Никогда не объявляйте const state = ref() вне <script setup> и setup() функции.
Например, при export const myState = ref({}) состояние будет общим между запросами на сервере, что может привести к утечке данных и памяти.
Вместо этого используйте const useX = () => useState('x')

Примеры

Базовое использование

В этом примере мы используем внутрикомпонентное состояние счетчика. Любые другие компоненты, использующие useState('counter'), разделяют то же реактивное состояние.

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

<template>
  <div>
    Счётчик: {{ counter }}
    <button @click="counter++">
      +
    </button>
    <button @click="counter--">
      -
    </button>
  </div>
</template>
Прочитайте и отредактируйте живой пример в Docs > 3 X > Examples > Features > State Management.
Для глобального сброса кэшированного состояния см. clearNuxtState.

Инициализация состояния

Часто состояние нужно инициализировать данными, которые подгружаются асинхронно. Вы можете использовать компонент app.vue с утилитой callOnce, чтобы сделать это.

app.vue
<script setup lang="ts">
const websiteConfig = useState('config')

await callOnce(async () => {
  websiteConfig.value = await $fetch('https://my-cms.com/api/website-config')
})
</script>
Это схоже с экшеном nuxtServerInit в Nuxt 2, который позволяет наполнить первичное состояние вашего хранилища на стороне сервера перед рендерингом страницы.
Узнать больше Docs > 3 X > API > Utils > Call Once.

Использование с 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)))
}
Прочитайте и отредактируйте живой пример в Docs > 3 X > Examples > Advanced > Locale.

Общее состояние

С автоимпортируемыми композаблами удобно задавать глобальные типобезопасные состояния и использовать их по всему приложению.

composables/states.ts
export const useColor = () => useState<string>('color', () => 'pink')
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 — конечные автоматы, визуализация и тесты логики состояний