<NuxtLayout>
Nuxt 提供了 <NuxtLayout> 组件,用于在页面和错误页面上显示布局。
您可以使用 <NuxtLayout />
组件在 app.vue
或 error.vue
上激活 default
布局。
app.vue
<template>
<NuxtLayout>
some page content
</NuxtLayout>
</template>
属性
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
- 类型:
其他属性
NuxtLayout
还接受您可能需要传递给布局的任何其他属性。然后,这些自定义属性作为属性变得可访问。
pages/some-page.vue
<template>
<div>
<NuxtLayout name="custom" title="I am a custom layout">
<-- ... -->
</NuxtLayout>
</div>
</template>
在上面的示例中,title
的值可以通过 $attrs.title
在模板中或 useAttrs().title
在 <script setup>
中在 custom.vue 中获取。
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>