新的 Composition API
通过从 @nuxtjs/composition-api
迁移到与 Nuxt 3 兼容的 API,在迁移到 Nuxt 3 时将减少重写。
ssrRef
和 shallowSsrRef
这两个函数已被一个新的 composable 替换,该 composable 在底层的工作方式非常相似: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 文档中阅读有关如何使用此 composable 的更多信息。
ssrPromise
此函数已被删除,如果您正在使用它,则需要找到替代实现。如果您有 ssrPromise
的用例,请通过讨论告知我们。
onGlobalSetup
此函数已被删除,但可以通过使用 useNuxtApp
或 useState
在 defineNuxtPlugin
中来实现其用例。您还可以在布局的 setup()
函数中运行任何自定义代码。
- import { onGlobalSetup } from '@nuxtjs/composition-api'
- export default () => {
- onGlobalSetup(() => {
+ export default defineNuxtPlugin((nuxtApp) => {
+ nuxtApp.hook('vue:setup', () => {
// ...
})
- }
+ })
useStore
为了访问 Vuex 存储实例,您可以使用 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
此帮助程序函数不再提供,但您可以使用以下代码替换它
const wrapProperty = (property, makeComputed = true) => () => {
const vm = getCurrentInstance().proxy
return makeComputed ? computed(() => vm[property]) : vm[property]
}
useAsync
和 useFetch
这两个 composables 可以用 useLazyAsyncData
和 useLazyFetch
替换,这些 composables 在Nuxt 3 文档中有说明。就像之前的 @nuxtjs/composition-api
composables 一样,这些 composables 不会阻止客户端的路由导航(因此名称中的“lazy”部分)。
useFetch
所做的那样)。useLazyFetch
。从 useAsync
迁移到新的 composables
<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
迁移到新的 composables
<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
兼容的方式操作您的 meta 标签。
<script setup>
- import { useMeta } from '@nuxtjs/composition-api'
useNuxt2Meta({
title: 'My Nuxt App',
})
</script>
您还可以传入计算值或 refs,并且 meta 值将以响应方式更新
<script setup>
const title = ref('my title')
useNuxt2Meta({
title,
})
title.value = 'new title'
</script>
useNuxt2Meta()
和 Options API head()
,因为行为可能是不可预测的。Nuxt Bridge 还提供了与 Nuxt 3 兼容的 meta 实现,可以使用 useHead
composable 访问。
<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
composable 在底层使用 @unhead/vue
(而不是 vue-meta
)来操作您的 <head>
。因此,建议不要同时使用原生 Nuxt 2 head()
属性和 useHead
,因为它们可能会冲突。
有关如何使用此 composable 的更多信息,请参阅Nuxt 3 文档。
显式导入
Nuxt 使用 #imports
别名公开每个自动导入,如果需要,可以使用该别名进行显式导入
<script setup lang="ts">
import { ref, computed } from '#imports'
const count = ref(1)
const double = computed(() => count.value * 2)
</script>
禁用自动导入
如果您想禁用自动导入 composables 和实用程序,您可以在 nuxt.config
文件中将 imports.autoImport
设置为 false
。
export default defineNuxtConfig({
imports: {
autoImport: false
}
})
这将完全禁用自动导入,但仍然可以使用来自 #imports
的显式导入。