使用方法

页面是 Vue 组件，可以具有 Nuxt 支持的任何有效扩展名（默认情况下为 .vue、.js、.jsx、.mjs、.ts 或 .tsx）。

Nuxt 将自动为 ~/pages/ 目录中的每个页面创建一个路由。

<template>
  <h1>首页</h1>
</template>

pages/index.vue 文件将映射到应用程序的 / 路由。

如果您正在使用 app.vue，请确保使用 <NuxtPage/> 组件来显示当前页面：

<template>
  <div>
    <!-- 所有页面共享的标记，例如：导航栏 -->
    <NuxtPage />
  </div>
</template>

页面必须有一个单一的根元素，以允许页面之间的路由过渡。HTML 注释也被视为元素。

这意味着当路由是服务器渲染或静态生成时，您将能够正确查看其内容，但当您在客户端导航期间导航到该路由时，路由之间的过渡将失败，您将看到该路由不会被渲染。

以下是一些示例，说明具有单一根元素的页面是什么样的：

<template>
  <div>
    <!-- 此页面正确地只有一个根元素 -->
    页面内容
  </div>
</template>

动态路由

如果您在方括号中放置任何内容，它将被转换为动态路由参数。您可以在文件名或目录中混合和匹配多个参数，甚至是非动态文本。

如果您希望参数是_可选的_，则必须将其括在双方括号中 - 例如，~/pages/[[slug]]/index.vue 或 ~/pages/[[slug]].vue 将匹配 / 和 /test。

-| pages/
---| index.vue
---| users-[group]/
-----| [id].vue

根据上面的示例，您可以通过 $route 对象在组件中访问 group/id：

<template>
  <p>{{ $route.params.group }} - {{ $route.params.id }}</p>
</template>

导航到 /users-admins/123 将渲染：

<p>admins - 123</p>

如果您想使用 Composition API 访问路由，可以使用全局的 useRoute 函数，就像在 Options API 中使用 this.$route 一样访问路由。

const route = useRoute()

if (route.params.group === 'admins' && !route.params.id) {
  console.log('警告！确保用户已认证！')
}

全匹配路由

如果您需要一个全匹配路由，可以通过使用名为 [...slug].vue 的文件来创建。这将匹配该路径下的_所有_路由。

<template>
  <p>{{ $route.params.slug }}</p>
</template>

导航到 /hello/world 将渲染：

<p>["hello", "world"]</p>

嵌套路由

可以使用 <NuxtPage> 显示嵌套路由。

示例：

-| pages/
---| parent/
-----| child.vue
---| parent.vue

此文件树将生成这些路由：

[
  {
    path: '/parent',
    component: '~/pages/parent.vue',
    name: 'parent',
    children: [
      {
        path: 'child',
        component: '~/pages/parent/child.vue',
        name: 'parent-child'
      }
    ]
  }
]

要显示 child.vue 组件，您必须在 pages/parent.vue 中插入 <NuxtPage> 组件：

<template>
  <div>
    <h1>我是父视图</h1>
    <NuxtPage :foobar="123" />
  </div>
</template>

const props = defineProps(['foobar'])

console.log(props.foobar)

子路由键

如果您想更好地控制 <NuxtPage> 组件何时重新渲染（例如，用于过渡），您可以通过 pageKey 属性传递字符串或函数，或者您可以通过 definePageMeta 定义一个 key 值：

<template>
  <div>
    <h1>我是父视图</h1>
    <NuxtPage :page-key="route => route.fullPath" />
  </div>
</template>

或者：

definePageMeta({
  key: route => route.fullPath
})

路由组

在某些情况下，您可能希望以不影响基于文件的路由的方式将一组路由分组。为此，您可以将文件放在用括号 - ( 和 ) 包裹的文件夹中。

例如：

-| pages/
---| index.vue
---| (marketing)/
-----| about.vue
-----| contact.vue

这将在您的应用程序中生成 /、/about 和 /contact 页面。marketing 组在您的 URL 结构中被忽略。

页面元数据

您可能希望为应用程序中的每个路由定义元数据。您可以使用 definePageMeta 宏来实现，这在 <script> 和 <script setup> 中都可以使用：

definePageMeta({
  title: '我的主页'
})

然后可以在应用程序的其他部分通过 route.meta 对象访问这些数据。

const route = useRoute()

console.log(route.meta.title) // 我的主页

如果您使用嵌套路由，这些路由的页面元数据将合并为一个对象。有关路由元数据的更多信息，请参阅 vue-router 文档。

与 defineEmits 或 defineProps 类似（参见 Vue 文档），definePageMeta 是一个编译器宏。它将被编译掉，因此您无法在组件中引用它。相反，传递给它的元数据将被提升到组件之外。 因此，页面元对象不能引用组件。但是，它可以引用导入的绑定以及本地定义的纯函数。

import { someData } from '~/utils/example'

function validateIdParam(route) {
  return route.params.id && !isNaN(Number(route.params.id))
}

const title = ref('')

definePageMeta({
  validate: validateIdParam,
  someData,
  title,    // 不要这样做，ref 将被提升到组件之外
})

特殊元数据

当然，您可以在整个应用程序中定义您自己的元数据。但是，使用 definePageMeta 定义的一些元数据具有特定用途：

alias

您可以定义页面别名。它们允许您从不同路径访问同一页面。它可以是字符串或字符串数组，如 vue-router 文档 中定义的那样。

keepalive

如果您在 definePageMeta 中设置 keepalive: true，Nuxt 将自动将您的页面包装在 Vue <KeepAlive> 组件 中。例如，如果您想在路由更改时保留页面状态，这可能在具有动态子路由的父路由中很有用。

当您的目标是保留父路由的状态时，请使用此语法：<NuxtPage keepalive />。您还可以设置传递给 <KeepAlive> 的属性（参见完整列表）。

您可以在 您的 nuxt.config 中为此属性设置默认值。

key

见上文。

layout

您可以定义用于渲染路由的布局。这可以是 false（禁用任何布局）、字符串或 ref/computed，如果您希望以某种方式使其具有反应性。更多关于布局的信息。

layoutTransition 和 pageTransition

您可以为包装您的页面和布局的 <transition> 组件定义过渡属性，或者传递 false 以禁用该路由的 <transition> 包装器。您可以查看可以传递的选项列表或阅读更多关于过渡如何工作的信息。

您可以在 您的 nuxt.config 中为这些属性设置默认值。

middleware

您可以定义在加载此页面之前应用的中间件。它将与任何匹配的父/子路由中使用的所有其他中间件合并。它可以是字符串、函数（遵循全局前置守卫模式的匿名/内联中间件函数）或字符串/函数数组。更多关于命名中间件的信息。

name

您可以为此页面的路由定义一个名称。

path

如果您有一个比文件名更复杂的模式，您可以定义一个路径匹配器。有关更多信息，请参阅 vue-router 文档。

props

允许将路由 params 作为传递给页面组件的属性访问。有关更多信息，请参阅vue-router 文档。

自定义元数据的类型

如果您为页面添加自定义元数据，您可能希望以类型安全的方式进行。这可以通过扩展 definePageMeta 接受的对象的类型来实现：

declare module '#app' {
  interface PageMeta {
    pageType?: string
  }
}

// 在扩展类型时，确保导入/导出某些内容始终很重要
export {}

导航

要在应用程序的页面之间导航，您应该使用 <NuxtLink> 组件。

此组件包含在 Nuxt 中，因此您不必像其他组件那样导入它。

一个简单的链接到 pages 文件夹中的 index.vue 页面：

<template>
  <NuxtLink to="/">主页</NuxtLink>
</template>

编程导航

Nuxt 允许通过 navigateTo() 实用方法进行编程导航。使用此实用方法，您将能够在应用程序中以编程方式导航用户。这对于从用户那里获取输入并在整个应用程序中动态导航他们非常有用。在此示例中，我们有一个简单的方法 navigate()，当用户提交搜索表单时调用。

const name = ref('');
const type = ref(1);

function navigate(){
  return navigateTo({
    path: '/search',
    query: {
      name: name.value,
      type: type.value
    }
  })
}

仅客户端页面

您可以通过给页面添加 .client.vue 后缀来定义一个仅客户端页面。此页面的内容将不会在服务器上渲染。

仅服务器页面

您可以通过给页面添加 .server.vue 后缀来定义一个仅服务器页面。虽然您可以使用 vue-router 控制的客户端导航导航到该页面，但它将自动使用服务器组件渲染，这意味着渲染页面所需的代码将不会在客户端包中。

自定义路由

随着应用程序变得越来越大和复杂，您的路由可能需要更多的灵活性。为此，Nuxt 直接公开了路由器、路由和路由器选项，以不同的方式进行自定义。

多页面目录

默认情况下，您的所有页面都应位于项目根目录下的一个 pages 目录中。

但是，您可以使用 Nuxt Layers 来创建应用程序页面的分组：

-| some-app/
---| nuxt.config.ts
---| pages/
-----| app-page.vue
-| nuxt.config.ts

// some-app/nuxt.config.ts
export default defineNuxtConfig({
})

export default defineNuxtConfig({
  extends: ['./some-app'],
})