<NuxtPage>

<NuxtPage> 是 Nuxt 附带的内置组件。它允许您显示位于 app/pages/ 目录中的顶级或嵌套页面。

<NuxtPage> 包括以下组件：

<template>
  <RouterView v-slot="{ Component }">
    <!-- 可选，使用过渡时 -->
    <Transition>
      <!-- 可选，使用 keep-alive 时 -->
      <KeepAlive>
        <Suspense>
          <component :is="Component" />
        </Suspense>
      </KeepAlive>
    </Transition>
  </RouterView>
</template>

默认情况下，Nuxt 不启用 <Transition> 和 <KeepAlive>。您可以在 nuxt.config 文件中启用它们，或者在 <NuxtPage> 上设置 transition 和 keepalive 属性。如果您想定义特定的页面，可以在页面组件的 definePageMeta 中设置。

由于 <NuxtPage> 在底层使用 <Suspense>，页面更改期间的组件生命周期行为与典型的 Vue 应用程序不同。

在典型的 Vue 应用程序中，新页面组件仅在前一个组件完全卸载后才挂载。然而，在 Nuxt 中，由于 Vue <Suspense> 的实现方式，新页面组件在前一个组件卸载之前就挂载了。

Props

• name: 告诉 <RouterView> 渲染匹配的路由记录的 components 选项中具有相应名称的组件。
  • 类型: string
• route: 已解析所有组件的路由位置。
  • 类型: RouteLocationNormalized
• pageKey: 控制 NuxtPage 组件何时重新渲染。
  • 类型: string 或 function
• transition: 为使用 NuxtPage 组件渲染的所有页面定义全局过渡。
  • 类型: boolean 或 TransitionProps
• keepalive: 控制使用 NuxtPage 组件渲染的页面的状态保留。
  • 类型: boolean 或 KeepAliveProps

示例

例如，如果您传递一个永远不会更改的键，<NuxtPage> 组件将只渲染一次——当它首次挂载时。

<template>
  <NuxtPage page-key="static" />
</template>

您还可以基于当前路由使用动态键：

<NuxtPage :page-key="route => route.fullPath" />

或者，pageKey 可以通过 /pages 目录中的 Vue 组件的 <script> 部分中的 definePageMeta`` 作为 key` 值传递。

<script setup lang="ts">
definePageMeta({
  key: route => route.fullPath,
})
</script>

页面的 Ref

要获取页面组件的 ref，通过 ref.value.pageRef 访问它

<script setup lang="ts">
const page = ref()

function logFoo () {
  page.value.pageRef.foo()
}
</script>

<template>
  <NuxtPage ref="page" />
</template>

<script setup lang="ts">
const foo = () => {
  console.log('foo 方法被调用')
}

defineExpose({
  foo,
})
</script>

自定义 Props

<NuxtPage> 还接受您可能需要进一步向下传递到层次结构的自定义 props。

例如，在下面的示例中，foobar 的值将被传递到 NuxtPage 组件，然后传递到页面组件。

<template>
  <NuxtPage :foobar="123" />
</template>

我们可以在页面组件中访问 foobar prop：

<script setup lang="ts">
const props = defineProps<{ foobar: number }>()

console.log(props.foobar) // 输出: 123

如果您没有使用 defineProps 定义 prop，任何传递给 NuxtPage 的 props 仍然可以直接从页面 attrs 访问：

<script setup lang="ts">
const attrs = useAttrs()
console.log(attrs.foobar) // 输出: 123
</script>