v3.16
Nuxt on GitHub

<NuxtLayout>

源代码
Nuxt 提供了 <NuxtLayout> 组件，用于在页面和错误页面上显示布局。

您可以使用 <NuxtLayout /> 组件在 app.vue 或 error.vue 上激活 default 布局。

app.vue
<template>
  <NuxtLayout>
    一些页面内容
  </NuxtLayout>
</template>
阅读更多 Docs > Guide > Directory Structure > Layouts.

属性

  • name：指定要渲染的布局名称，可以是字符串、响应式引用或计算属性。它必须与 layouts/ 目录中对应的布局文件名匹配。
    • 类型：string
    • 默认值：default
pages/index.vue
<script setup lang="ts">
// layouts/custom.vue
const layout = 'custom'
</script>

<template>
  <NuxtLayout :name="layout">
    <NuxtPage />
  </NuxtLayout>
</template>
请注意，布局名称会被规范化为 kebab-case，因此如果您的布局文件名为 errorLayout.vue，在传递给 <NuxtLayout /> 的 name 属性时将变为 error-layout。
error.vue
<template>
  <NuxtLayout name="error-layout">
    <NuxtPage />
  </NuxtLayout>
</template>
了解更多关于动态布局的信息。
  • fallback：如果传递给 name 属性的布局无效，将不会渲染任何布局。在此情况下，指定一个回退布局进行渲染。它必须与 layouts/ 目录中对应的布局文件名匹配。
    • 类型：string
    • 默认值：null

附加属性

NuxtLayout 还接受您可能需要传递给布局的任何附加属性。这些自定义属性随后可作为属性访问。

pages/some-page.vue
<template>
  <div>
    <NuxtLayout name="custom" title="我是一个自定义布局">
      <-- ... -->
    </NuxtLayout>
  </div>
</template>

在上述示例中，title 的值将在 custom.vue 中通过 $attrs.title（在模板中）或 useAttrs().title（在 <script setup> 中）访问。

layouts/custom.vue
<script setup lang="ts">
const layoutCustomProps = useAttrs()

console.log(layoutCustomProps.title) // 我是一个自定义布局
</script>

过渡效果

<NuxtLayout /> 通过 <slot /> 渲染传入的内容，随后被 Vue 的 <Transition /> 组件包裹以激活布局过渡效果。为确保正常工作，建议 <NuxtLayout />不作为页面组件的根元素。

<template>
  <div>
    <NuxtLayout name="custom">
      <template #header> 一些头部模板内容。 </template>
    </NuxtLayout>
  </div>
</template>
阅读更多 Docs > Getting Started > Transitions.

布局的引用

要获取布局组件的引用，可通过 ref.value.layoutRef 访问。

<script setup lang="ts">
const layout = ref()

function logFoo () {
  layout.value.layoutRef.foo()
}
</script>

<template>
  <NuxtLayout ref="layout">
    默认布局
  </NuxtLayout>
</template>
阅读更多 Docs > Guide > Directory Structure > Layouts.