layouts

Nuxt 提供了一个布局框架，用于将常见的 UI 模式提取到可重用的布局中。
为了获得最佳性能，放置在此目录中的组件在使用时将通过异步导入自动加载。

启用布局

通过将 <NuxtLayout> 添加到你的 app.vue 来启用布局。

app/app.vue
<template>
  <NuxtLayout>
    <NuxtPage />
  </NuxtLayout>
</template>

使用布局

  • 使用 definePageMeta 在你的页面中设置 layout 属性。
  • 设置 <NuxtLayout> 的 name 属性。
布局名称会规范化为 kebab-case，因此 someLayout 会变成 some-layout。
如果未指定布局，将使用 app/layouts/default.vue。
如果你的应用程序中只有一个布局，我们建议改用 app.vue。
与其他组件不同，你的布局必须有一个单一的根元素，以允许 Nuxt 在布局更改之间应用过渡——并且此根元素不能是 <slot />。

默认布局

添加 ~/layouts/default.vue

app/layouts/default.vue
<template>
  <div>
    <p>Some default layout content shared across all pages</p>
    <slot />
  </div>
</template>

在布局文件中，页面的内容将显示在 <slot /> 组件中。

命名布局

目录结构
-| layouts/
---| default.vue
---| custom.vue

然后你可以在你的页面中使用 custom 布局

pages/about.vue
<script setup lang="ts">
definePageMeta({
  layout: 'custom',
})
</script>
了解更多关于 definePageMeta。

你可以使用 <NuxtLayout> 的 name 属性直接覆盖所有页面的默认布局。

app/app.vue
<script setup lang="ts">
// You might choose this based on an API call or logged-in status
const layout = 'custom'
</script>

<template>
  <NuxtLayout :name="layout">
    <NuxtPage />
  </NuxtLayout>
</template>

如果你的布局位于嵌套目录中，布局的名称将基于其自身的路径目录和文件名，并移除重复的片段。

文件布局名称
~/layouts/desktop/default.vuedesktop-default
~/layouts/desktop-base/base.vuedesktop-base
~/layouts/desktop/index.vuedesktop

为清晰起见，我们建议布局的文件名与其名称匹配

文件布局名称
~/layouts/desktop/DesktopDefault.vuedesktop-default
~/layouts/desktop-base/DesktopBase.vuedesktop-base
~/layouts/desktop/Desktop.vuedesktop
在 文档 > 4 X > 示例 > 功能 > 布局 中阅读和编辑实时示例。

动态更改布局

你还可以使用 setPageLayout 辅助函数动态更改布局。

<script setup lang="ts">
function enableCustomLayout () {
  setPageLayout('custom')
}
definePageMeta({
  layout: false,
})
</script>

<template>
  <div>
    <button @click="enableCustomLayout">
      Update layout
    </button>
  </div>
</template>
在 文档 > 4 X > 示例 > 功能 > 布局 中阅读和编辑实时示例。

逐页覆盖布局

如果你正在使用页面，你可以通过设置 layout: false 然后在页面内使用 <NuxtLayout> 组件来完全控制。

<script setup lang="ts">
definePageMeta({
  layout: false,
})
</script>

<template>
  <div>
    <NuxtLayout name="custom">
      <template #header>
        Some header template content.
      </template>

      The rest of the page
    </NuxtLayout>
  </div>
</template>
如果你在页面中使用 <NuxtLayout>，请确保它不是根元素（或禁用布局/页面过渡）。