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>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>
您可以使用 <NuxtLayout> 的 name 属性直接覆盖所有页面的默认布局。
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.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 |
在 文档 > 示例 > 功能 > 布局 中阅读和编辑实时示例。
动态更改布局
您还可以使用 setPageLayout 辅助函数来动态更改布局
<script setup lang="ts">
function enableCustomLayout () {
setPageLayout('custom')
}
definePageMeta({
layout: false,
});
</script>
<template>
<div>
<button @click="enableCustomLayout">Update layout</button>
</div>
</template>
在 文档 > 示例 > 功能 > 布局 中阅读和编辑实时示例。
在每个页面上覆盖布局
如果您正在使用页面，则可以通过设置 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>，请确保它不是根元素（或禁用布局/页面过渡）。