<NuxtLayout>
Nuxt 提供了 <NuxtLayout> 组件，用于在页面和错误页面上显示布局。
你可以使用 <NuxtLayout /> 组件来激活 app.vue 或 error.vue 中的 default 布局。
app.vue
<template>
<NuxtLayout>
some page content
</NuxtLayout>
</template>
Props
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，则当作为 name 属性传递给 <NuxtLayout /> 时，它将变为 error-layout。error.vue
<template>
<NuxtLayout name="error-layout">
<NuxtPage />
</NuxtLayout>
</template>
fallback：如果传递给name属性的布局无效，则不会渲染任何布局。指定在这种情况下要渲染的fallback布局。它必须与layouts/目录中相应布局文件的名称匹配。- 类型:
string - 默认值:
null
- 类型:
额外的 Props
NuxtLayout 还接受你可能需要传递给布局的任何其他 props。这些自定义 props 随后可以作为属性访问。
pages/some-page.vue
<template>
<div>
<NuxtLayout name="custom" title="I am a custom layout">
<-- ... -->
</NuxtLayout>
</div>
</template>
在上面的示例中，可以使用模板中的 $attrs.title 或在 custom.vue 中的 <script setup> 中使用 useAttrs().title 来访问 title 的值。
layouts/custom.vue
<script setup lang="ts">
const layoutCustomProps = useAttrs()
console.log(layoutCustomProps.title) // I am a custom layout
</script>
过渡效果
<NuxtLayout /> 通过 <slot /> 渲染传入的内容，然后将其包裹在 Vue 的 <Transition /> 组件周围以激活布局过渡效果。为了使其按预期工作，建议 <NuxtLayout /> 不是页面组件的根元素。
<template>
<div>
<NuxtLayout name="custom">
<template #header> Some header template content. </template>
</NuxtLayout>
</div>
</template>
布局的 Ref
要获取布局组件的 ref，请通过 ref.value.layoutRef 访问它。
<script setup lang="ts">
const layout = ref()
function logFoo () {
layout.value.layoutRef.foo()
}
</script>
<template>
<NuxtLayout ref="layout">
default layout
</NuxtLayout>
</template>