Nuxt Nation 大会即将到来。加入我们,11 月 12-13 日。

页面和布局

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

app.vue

Nuxt 3 通过 ~/app.vue 提供应用程序的中心入口点。

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

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

文档 > 指南 > 目录结构 > App 中了解更多信息。
文档 > 示例 > Hello World 中阅读和编辑实时示例。

迁移

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

布局

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

在 Nuxt 2 中,<Nuxt> 组件用于在布局内渲染当前页面。在 Nuxt 3 中,布局使用插槽,因此您必须将该组件替换为 <slot />。这也允许使用命名插槽和作用域插槽的高级用例。详细了解布局

您还需要更改使用 definePageMeta 编译器宏定义页面使用的布局的方式。布局将使用连字符分隔。因此,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 Props

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

文档 > 指南 > 目录结构 > Pages#特殊元数据 中了解更多信息。

页面和布局过渡

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

文档 > 入门 > 过渡 中了解更多信息。

迁移

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

示例:动态路由

- 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。

确保始终在 navigateTo 上使用 await 或通过从函数返回来链接其结果。
<script>
export default {
  methods: {
    navigate(){
      this.$router.push({
        path: '/search',
        query: {
          name: 'first name',
          type: '1'
        }
      })
    }
  }
}
</script>