v3.16
GitHub

layouts

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

启用布局

通过将 <NuxtLayout> 添加到您的 app.vue 可以启用布局：

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

要使用布局：

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

默认布局

添加 ~/layouts/default.vue：

layouts/default.vue
<template>
  <div>
    <p>在所有页面中共享的一些默认布局内容</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.vue
<script setup lang="ts">
// 您可以根据 API 调用或登录状态选择此项
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
Read and edit a live example in Docs > Examples > Features > Layouts.

动态更改布局

您还可以使用 setPageLayout 帮助程序动态更改布局：

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

<template>
  <div>
    <button @click="enableCustomLayout">更新布局</button>
  </div>
</template>
Read and edit a live example in Docs > Examples > Features > Layouts.

按页面覆盖布局

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

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

<template>
  <div>
    <NuxtLayout name="custom">
      <template #header> 一些头部模板内容。 </template>

      页面其余部分
    </NuxtLayout>
  </div>
</template>
如果您在页面内使用 <NuxtLayout>，确保它不是根元素（或 禁用layouts/页面过渡）。