用useState。有响应式和支持ssr共享。
useState是支持ssr的ref替代方案。其中,在后端渲染后(前端水合)会被保留,并通过唯一键在所有组件之间共享。
useState中的数据将序列化为JSON。
例子
基本用法
用组件本地的计算器状态。任何用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>
初始化状态
异步解析去初始化状态。
// 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>
与Pinia一起用
在Pinia 模块创建全局存储并在整个应用中使用它。
// stores/website.ts
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
}
}
})
高级用法
// composables/locale.ts
export const useLocale = () => {
return useState('locale', () => useDefaultLocale().value)
}
export cosnt useDefautLocale = (fallback = 'en-US') => {
const locale = ref(fallback)
return locale
}
export const useLocales = () => {
const locale = useLocale()
const locales = ref([
'en-US',
'en-GB',
...
])
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)))
}
// app.vue
<script setup lang="ts">
const locales = useLocales()
const locale = useLocale()
const date = useLocaleDate(new Date('2026-1-16'))
</script>
<template>
<div>
<h1>生日</h1>
<p>{{ date }}</p>
<label for="locale-chooser">语言</label>
<select id="locale-chooser" v-model="locale">
<option v-for="loc of locales" :key="loc" :value="loc">
{{ loc }}
</option>
</select>
</div>
</template>
共享状态
自动导入的组合式函数
// composables/states.ts
export const useColor = () => useState<string>('color', () => 'pink')
// app.vue
<script setup lang="ts">
const useColor = () => useState<string>('color', () => 'pink')
const color = useColor() // 与 useState('color')相同
</script>
<template>
<p>{{ color }}</p>
</template>
用库 - 第三方的
- Pinia
- Harlem
- XState