layouts

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

启用布局

通过将 <NuxtLayout> 添加到您的 app.vue 中即可启用布局。

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

使用布局

  • 在页面中使用 definePageMeta 设置 layout 属性。
  • 设置 <NuxtLayout> 的 name 属性。
  • 在路由规则（route rules）中设置 appLayout 属性。
布局名称会被标准化为 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">
declare module 'nuxt/app' {
  interface NuxtLayouts {
    'custom': unknown
  }
}
// ---cut---
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
在 Docs > 4 X > Examples > Features > Layouts 中阅读并编辑在线示例。

动态更改布局

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

app/pages/index.vue
<script setup lang="ts">
declare module 'nuxt/app' {
  interface NuxtLayouts {
    'custom': unknown
  }
}
// ---cut---
function enableCustomLayout () {
  setPageLayout('custom')
}
definePageMeta({
  layout: false,
})
</script>

<template>
  <div>
    <button @click="enableCustomLayout">
      Update layout
    </button>
  </div>
</template>

您还可以使用路由规则中的 appLayout 属性为特定路由设置布局。

nuxt.config.ts
export default defineNuxtConfig({
  routeRules: {
    // Set layout for specific route
    '/admin': { appLayout: 'admin' },
    // Set layout for multiple routes
    '/dashboard/**': { appLayout: 'dashboard' },
    // Disable layout for a route
    '/landing': { appLayout: false },
  },
})
当您希望在配置中集中管理布局而不是在每个页面文件中管理时，或者当您需要为没有对应页面组件的路由（例如可能匹配多个路径的兜底页面）应用布局时，这非常有用。
在 Docs > 4 X > Examples > Features > Layouts 中阅读并编辑在线示例。

将 Props 传递给布局

您可以通过多种方式将 props 传递给布局。

通过 definePageMeta

对 layout 属性使用对象语法，直接从页面传递 props

<script setup lang="ts">
definePageMeta({
  layout: {
    name: 'panel',
    props: {
      sidebar: true,
      title: 'Dashboard',
    },
  },
})
</script>
Props 会根据布局的 defineProps 进行完全类型化。您将在编辑器中获得自动补全和类型检查。

通过 setPageLayout

当使用 setPageLayout 动态更改布局时，也可以传递 props。

setPageLayout('panel', { sidebar: true, title: 'Dashboard' })

按页面覆盖布局

如果您正在使用页面，可以通过设置 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>，请确保它不是根元素（或者 禁用布局/页面过渡）。