通过从 @nuxtjs/composition-api 迁移到 Nuxt 3 兼容的 API,在迁移到 Nuxt 3 时可以减少重写工作。
ssrRef 和 shallowSsrRef这两个函数已被一个在底层工作方式非常相似的新组合式函数取代:useState。
主要区别在于,您必须为此状态提供一个键(Nuxt 会为 ssrRef 和 shallowSsrRef 自动生成),并且它只能在 Nuxt 3 插件(由 defineNuxtPlugin 定义)或组件实例中调用。(换句话说,您不能在全局/环境上下文中使用 useState,因为存在跨请求共享状态的风险。)
- import { ssrRef } from '@nuxtjs/composition-api'
- const ref1 = ssrRef('initialData')
- const ref2 = ssrRef(() => 'factory function')
+ const ref1 = useState('ref1-key', () => 'initialData')
+ const ref2 = useState('ref2-key', () => 'factory function')
// accessing the state
console.log(ref1.value)
由于状态是带键的,只要使用相同的键,您就可以从多个位置访问相同的状态。
您可以在Nuxt 3 文档中阅读有关如何使用此组合式函数的更多信息。
ssrPromise此函数已被移除,如果您正在使用它,则需要找到替代实现。如果您有 ssrPromise 的用例,请通过讨论告知我们。
onGlobalSetup此函数已被移除,但其用例可以通过在 defineNuxtPlugin 中使用 useNuxtApp 或 useState 来满足。您也可以在布局的 setup() 函数中运行任何自定义代码。
- import { onGlobalSetup } from '@nuxtjs/composition-api'
- export default () => {
- onGlobalSetup(() => {
+ export default defineNuxtPlugin((nuxtApp) => {
+ nuxtApp.hook('vue:setup', () => {
// ...
})
- }
+ })
useStore为了访问 Vuex store 实例,您可以使用 useNuxtApp().$store。
- import { useStore } from '@nuxtjs/composition-api`
+ const { $store } = useNuxtApp()
useContext 和 withContext您可以使用 useNuxtApp 访问注入的辅助函数。
- import { useContext } from '@nuxtjs/composition-api`
+ const { $axios } = useNuxtApp()
useNuxtApp() 还提供了一个名为 nuxt2Context 的键,它包含了您通常从 Nuxt 2 上下文中访问的所有相同属性,但建议不要直接使用它,因为它在 Nuxt 3 中将不存在。相反,请查看是否有其他方法可以访问您需要的内容。(如果没有,请提出功能请求或讨论。)wrapProperty此辅助函数不再提供,但您可以用以下代码替换它
import { computed, getCurrentInstance } from 'vue'
const wrapProperty = (property: string, makeComputed = true) => () => {
const vm = getCurrentInstance().proxy
return makeComputed ? computed(() => vm[property]) : vm[property]
}
useAsync 和 useFetch这两个组合式函数可以用 useLazyAsyncData 和 useLazyFetch 替换,它们在Nuxt 3 文档中有所记载。就像以前的 @nuxtjs/composition-api 组合式函数一样,这些组合式函数不会在客户端阻止路由导航(因此名称中带有“lazy”)。
useFetch 时所做的那样)。useLazyFetch 必须已为 Nitro 配置。从 useAsync 迁移到新的组合式函数
<script setup>
- import { useAsync } from '@nuxtjs/composition-api'
- const posts = useAsync(() => $fetch('/api/posts'))
+ const { data: posts } = useLazyAsyncData('posts', () => $fetch('/api/posts'))
+ // or, more simply!
+ const { data: posts } = useLazyFetch('/api/posts')
</script>
从 useFetch 迁移到新的组合式函数
<script setup>
- import { useFetch } from '@nuxtjs/composition-api'
- const posts = ref([])
- const { fetch } = useFetch(() => { posts.value = await $fetch('/api/posts') })
+ const { data: posts, refresh } = useLazyAsyncData('posts', () => $fetch('/api/posts'))
+ // or, more simply!
+ const { data: posts, refresh } = useLazyFetch('/api/posts')
function updatePosts() {
- return fetch()
+ return refresh()
}
</script>
useMeta为了与 vue-meta 交互,您可以使用 useNuxt2Meta,它将在 Nuxt Bridge(但不在 Nuxt 3)中工作,并允许您以 vue-meta 兼容的方式操作您的元标签。
<script setup>
- import { useMeta } from '@nuxtjs/composition-api'
useNuxt2Meta({
title: 'My Nuxt App',
})
</script>
您还可以传入计算值或 ref,元值将响应式更新
<script setup>
const title = ref('my title')
useNuxt2Meta({
title,
})
title.value = 'new title'
</script>
useNuxt2Meta() 和 Options API head(),因为行为可能不可预测。Nuxt Bridge 还提供了一个 Nuxt 3 兼容的元实现,可以通过 useHead 组合式函数访问。
<script setup>
- import { useMeta } from '@nuxtjs/composition-api'
useHead({
title: 'My Nuxt App',
})
</script>
您还需要在 nuxt.config 中明确启用它
import { defineNuxtConfig } from '@nuxt/bridge'
export default defineNuxtConfig({
bridge: {
meta: true,
},
})
此 useHead 组合式函数底层使用 @unhead/vue(而不是 vue-meta)来操作您的 <head>。因此,建议不要同时使用原生 Nuxt 2 的 head() 属性和 useHead,因为它们可能会冲突。
有关如何使用此组合式函数的更多信息,请参阅Nuxt 3 文档。
Nuxt 通过 #imports 别名暴露了所有自动导入,如果需要,可以使用该别名进行显式导入
<script setup lang="ts">
import { computed, ref } from '#imports'
const count = ref(1)
const double = computed(() => count.value * 2)
</script>
如果您想禁用组合式函数和工具的自动导入,可以在 nuxt.config 文件中将 imports.autoImport 设置为 false。
export default defineNuxtConfig({
imports: {
autoImport: false,
},
})
这将完全禁用自动导入,但仍然可以使用 从 #imports 进行的显式导入。