2022-10-06 09:15:30 +00:00
---
navigation.icon: uil:database
description: Nuxt provides useState composable to create a reactive and SSR-friendly shared state.
---
2022-04-06 05:56:08 +00:00
# State Management
2021-10-11 17:48:03 +00:00
2022-10-06 09:15:30 +00:00
Nuxt provides useState composable to create a reactive and SSR-friendly shared state across components.
2021-10-11 17:48:03 +00:00
2022-02-07 10:16:45 +00:00
`useState` is an SSR-friendly [`ref` ](https://vuejs.org/api/reactivity-core.html#ref ) replacement. Its value will be preserved after server-side rendering (during client-side hydration) and shared across all components using a unique key.
2021-10-11 17:48:03 +00:00
2022-04-06 05:56:08 +00:00
::ReadMore{link="/api/composables/use-state"}
::
2021-10-11 17:48:03 +00:00
2021-11-15 10:30:38 +00:00
::alert{icon=👉}
2022-02-07 10:16:45 +00:00
`useState` only works during `setup` or [`Lifecycle Hooks` ](https://vuejs.org/api/composition-api-lifecycle.html#composition-api-lifecycle-hooks ).
2021-11-16 16:12:36 +00:00
::
2022-07-21 08:56:01 +00:00
::alert{type=warning}
Because the data inside `useState` will be serialized to JSON, it is important that it does not contain anything that cannot be serialized, such as classes, functions or symbols.
::
2021-11-16 16:12:36 +00:00
2022-08-13 07:27:04 +00:00
## Best Practices
2021-11-16 16:12:36 +00:00
::alert{type=danger icon=🚨}
Never define `const state = ref()` outside of `<script setup>` or `setup()` function.< br >
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')`
2021-11-15 10:30:38 +00:00
::
2021-11-16 15:37:36 +00:00
## Examples
2021-10-11 17:48:03 +00:00
2022-08-13 07:27:04 +00:00
### Basic Usage
2021-11-15 20:41:05 +00:00
2021-11-16 15:37:36 +00:00
In this example, we use a component-local counter state. Any other component that uses `useState('counter')` shares the same reactive state.
2021-10-11 17:48:03 +00:00
2021-11-15 20:41:05 +00:00
```vue [app.vue]
< script setup >
2021-11-16 15:37:36 +00:00
const counter = useState('counter', () => Math.round(Math.random() * 1000))
2021-11-15 20:41:05 +00:00
< / script >
2021-10-11 17:48:03 +00:00
2021-11-15 20:41:05 +00:00
< template >
2021-11-16 15:37:36 +00:00
< div >
Counter: {{ counter }}
< button @click =" counter ++" >
+
< / button >
< button @click =" counter-- " >
-
< / button >
< / div >
2021-11-15 20:41:05 +00:00
< / template >
2021-11-16 13:17:52 +00:00
```
2022-10-25 09:33:09 +00:00
::LinkExample{link="/examples/composables/use-state"}
::
2021-11-15 20:41:05 +00:00
2022-04-06 05:56:08 +00:00
::ReadMore{link="/api/composables/use-state"}
::
2021-11-16 16:12:36 +00:00
### Advanced
2021-11-16 15:37:36 +00:00
2021-11-21 12:31:44 +00:00
In this example, we use a composable that detects the user's default locale from the HTTP request headers and keeps it in a `locale` state.
2021-11-16 13:17:52 +00:00
2022-10-25 09:33:09 +00:00
::LinkExample{link="/examples/other/locale"}
::
2021-10-11 17:48:03 +00:00
2022-08-13 07:27:04 +00:00
## Shared State
2021-11-16 15:37:36 +00:00
2022-04-06 05:56:08 +00:00
By using [auto-imported composables ](/guide/directory-structure/composables ) we can define global type-safe states and import them across the app.
2021-11-16 13:17:52 +00:00
2021-11-16 15:37:36 +00:00
```ts [composables/states.ts]
export const useCounter = () => useState< number > ('counter', () => 0)
export const useColor = () => useState< string > ('color', () => 'pink')
```
2021-11-16 13:17:52 +00:00
```vue [app.vue]
< script setup >
2021-11-16 15:37:36 +00:00
const color = useColor() // Same as useState('color')
2021-11-16 13:17:52 +00:00
< / script >
< template >
2021-11-16 16:12:36 +00:00
< p > Current color: {{ color }}< / p >
2021-11-16 13:17:52 +00:00
< / template >
```