layouts
Nuxt 提供了一个布局框架，用于将常见的 UI 模式提取到可重用的布局中。
为了获得最佳性能，放置在此目录中的组件在使用时将通过异步导入自动加载。
启用布局
通过在 app.vue 中添加 <NuxtLayout> 来启用布局：
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 /> 组件中。
命名布局
Directory Structure
-| layouts/
---| default.vue
---| custom.vue
然后您可以在页面中使用 custom 布局：
pages/about.vue
definePageMeta({
layout: 'custom'
})您可以直接使用 <NuxtLayout> 的 name 属性覆盖所有页面的默认布局：
app.vue
<script setup lang="ts">
// 您可以根据 API 调用或登录状态选择此项
const layout = "custom";
</script>
<template>
<NuxtLayout :name="layout">
<NuxtPage />
</NuxtLayout>
</template>
如果您在嵌套目录中有布局，布局的名称将基于其路径目录和文件名，并删除重复的部分。
| 文件 | 布局名称 |
|---|---|
~/layouts/desktop/default.vue | desktop-default |
~/layouts/desktop-base/base.vue | desktop-base |
~/layouts/desktop/index.vue | desktop |
为了清晰起见，我们建议布局的文件名与其名称匹配：
| 文件 | 布局名称 |
|---|---|
~/layouts/desktop/DesktopDefault.vue | desktop-default |
~/layouts/desktop-base/DesktopBase.vue | desktop-base |
~/layouts/desktop/Desktop.vue | desktop |
示例代码的编辑与预览examples > features > layouts
动态更改布局
您还可以使用 setPageLayout 辅助函数动态更改布局：
<script setup lang="ts">
function enableCustomLayout () {
setPageLayout('custom')
}
definePageMeta({
layout: false,
});
</script>
<template>
<div>
<button @click="enableCustomLayout">更新布局</button>
</div>
</template>
示例代码的编辑与预览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>，请确保它不是根元素（或 禁用布局/页面过渡）。
※此页面是 Nuxt.js 官方文档的非官方翻译页面。