通过 100 多个技巧的集合学习 Nuxt!

页面和布局

了解如何将 Nuxt 2 的页面和布局迁移到 Nuxt 3。

app.vue

Nuxt 3 通过 ~/app.vue 为你的应用提供了一个中心入口点。

如果你的源代码目录中没有 app.vue 文件,Nuxt 将使用其自身的默认版本。

此文件非常适合放置需要在应用程序启动时运行一次的任何自定义代码,以及应用程序每个页面上都存在的任何组件。例如,如果你只有一个布局,你可以将其移动到 app.vue 中。

文档 > 指南 > 目录结构 > 应用中阅读更多内容。
文档 > 示例 > Hello World中阅读和编辑一个实时示例。

迁移

考虑创建一个 app.vue 文件,并包含需要在应用程序顶层运行一次的任何逻辑。你可以查看此处的示例

布局

如果你在应用程序中对多个页面使用布局,则只需要进行少量更改。

在 Nuxt 2 中,<Nuxt> 组件用于在布局中渲染当前页面。在 Nuxt 3 中,布局改用插槽,因此你必须将该组件替换为 <slot />。这也允许使用命名和作用域插槽的高级用例。阅读有关布局的更多信息

你还需要使用 definePageMeta 编译器宏来更改定义页面使用的布局的方式。布局将使用 kebab-case 命名。因此,在页面中引用 layouts/customLayout.vue 时,它会变为 custom-layout

迁移

  1. <Nuxt /> 替换为 <slot />
    layouts/custom.vue
      <template>
        <div id="app-layout">
          <main>
    -       <Nuxt />
    +       <slot />
          </main>
        </div>
      </template>
    
  2. 使用definePageMeta来选择你的页面使用的布局。
    pages/index.vue
      <script>
    + definePageMeta({
    +   layout: 'custom'
    + })
    - export default {
    -   layout: 'custom'
    - }
      </script>
    
  3. ~/layouts/_error.vue 移动到 ~/error.vue。请参阅错误处理文档。如果你想确保此页面使用布局,你可以直接在 error.vue 中使用 <NuxtLayout>
    error.vue
    <template>
      <div>
        <NuxtLayout name="default">
          <!-- -->
        </NuxtLayout>
      </div>
    </template>
    

页面

Nuxt 3 附带了一个可选的 vue-router 集成,该集成由源代码目录中存在 pages/ 目录触发。如果你只有一个页面,你可以考虑将其移动到 app.vue 中以进行更轻量级的构建。

动态路由

在 Nuxt 3 中定义动态路由的格式与 Nuxt 2 略有不同,因此你可能需要重命名 pages/ 中的某些文件。

  1. 以前使用 _id 定义动态路由参数的地方,现在使用 [id]
  2. 以前使用 _.vue 定义通配符路由的地方,现在使用 [...slug].vue

嵌套路由

在 Nuxt 2 中,你将使用 <Nuxt><NuxtChild> 定义任何嵌套路由(带有父组件和子组件)。在 Nuxt 3 中,这些已被单个 <NuxtPage> 组件替换。

页面键和 Keep-alive 属性

如果你向 <Nuxt> 传递自定义页面键或 keep-alive 属性,现在将使用 definePageMeta 设置这些选项。

文档 > 指南 > 目录结构 > 页面#特殊元数据中阅读更多内容。

页面和布局过渡

如果你直接在组件选项中为页面或布局定义了过渡,现在需要使用 definePageMeta 来设置过渡。自 Vue 3 以来,-enter 和 -leave CSS 类已重命名<Nuxt> 中的 style 属性在 <slot> 上使用时不再应用于过渡,因此请将样式移动到你的 -active 类。

文档 > 开始使用 > 过渡中阅读更多内容。

迁移

  1. 重命名任何带有动态参数的页面以匹配新格式。
  2. <Nuxt><NuxtChild> 更新为 <NuxtPage>
  3. 如果您正在使用 Composition API,您也可以将 this.$routethis.$router 迁移为使用 useRouteuseRouter composables。

示例:动态路由

- URL: /users
- Page: /pages/users/index.vue

- URL: /users/some-user-name
- Page: /pages/users/_user.vue
- Usage: params.user

- URL: /users/some-user-name/edit
- Page: /pages/users/_user/edit.vue
- Usage: params.user

- URL: /users/anything-else
- Page: /pages/users/_.vue
- Usage: params.pathMatch

示例:嵌套路由和 definePageMeta

<template>
  <div>
    <NuxtChild keep-alive :keep-alive-props="{ exclude: ['modal'] }" :nuxt-child-key="$route.slug" />
  </div>
</template>

<script>
export default {
  transition: 'page' // or { name: 'page' }
}
</script>

对于全局 NuxtLink 组件,大多数语法和功能都是相同的。如果您之前使用的是快捷方式 <NLink> 格式,则应将其更新为使用 <NuxtLink>

<NuxtLink> 现在是所有链接(甚至是外部链接)的直接替代品。您可以阅读更多关于它的信息,以及如何扩展它以提供您自己的链接组件。

请在 文档 > API > 组件 > Nuxt Link 中阅读更多内容。

编程式导航

当从 Nuxt 2 迁移到 Nuxt 3 时,您需要更新您以编程方式导航用户的方式。在 Nuxt 2 中,您可以通过 this.$router 访问底层 Vue Router。在 Nuxt 3 中,您可以使用 navigateTo() 实用方法,它允许您向 Vue Router 传递路由和参数。

请务必始终 await navigateTo 的结果,或者通过从函数返回来链式处理它的结果。
<script>
export default {
  methods: {
    navigate(){
      this.$router.push({
        path: '/search',
        query: {
          name: 'first name',
          type: '1'
        }
      })
    }
  }
}
</script>