State

Nuxt provides useState composable to create a reactive and ssr-friendly shared state across components.

useState is a SSR-friendly ref replacement. Its value will be preserved after server-side rendering (during client-side hydration) and shared across all components using a unique key.

Signature

useState<T>(key: string, init?: () => T): Ref<T>

key: A unique key ensuring that data fetching can be properly de-duplicated across requests
init: A function that provides initial value for the state when it's not initiated
T: (typescript only) Specify type of state

::alert{icon=👉} useState only works during setup or Lifecycle Hooks. ::

Best practices

::alert{type=danger icon=🚨} Never define const state = ref() outside of <script setup> or setup() function.
Such state will be shared across all users visiting your website and can lead to memory leaks! :: ::alert{type=success icon=✅} Instead use const useX = () => useState('x') ::

Examples

Basic usage

In this example, we use a component-local counter state. Any other component that uses useState('counter') shares the same reactive state.

<script setup>
const counter = useState('counter', () => Math.round(Math.random() * 1000))
</script>

<template>
  <div>
    Counter: {{ counter }}
    <button @click="counter++">
      +
    </button>
    <button @click="counter--">
      -
    </button>
  </div>
</template>

:button-link[Open on StackBlitz]{href="https://stackblitz.com/github/nuxt/framework/tree/main/examples/use-state?terminal=dev" blank}

Advanced

In this example, we use a composable that detects the user's default locale from the request HTTP headers and keeps in locale state.

:button-link[Open on StackBlitz]{href="https://stackblitz.com/github/nuxt/framework/tree/main/examples/locale?terminal=dev" blank}

Shared state

By using auto-imported composables we can define global type-safe states and import them across the app.

export const useCounter = () => useState<number>('counter', () => 0)
export const useColor = () => useState<string>('color', () => 'pink')

<script setup>
const color = useColor() // Same as useState('color')
</script>

<template>
  <p>Current color: {{ color }}</p>
</template>

2.5 KiB Raw Blame History