---
title: "<NuxtLayout>"
description: "Nuxt 提供了 <NuxtLayout> 组件，用于在页面和错误页面上显示布局。"
canonical_url: "https://nuxt.zhcndoc.com/docs/3.x/api/components/nuxt-layout"
---
# \<NuxtLayout>

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

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

```vue [app.vue]
<template>
  <NuxtLayout>
    一些页面内容
  </NuxtLayout>
</template>
```

::read-more{to="https://nuxt.zhcndoc.com/docs/3.x/directory-structure/layouts"}
::

## Props

- `name`：指定要渲染的布局名称，可以是字符串、响应式引用或计算属性。它**必须**与 [`layouts/`](https://nuxt.zhcndoc.com/docs/3.x/directory-structure/layouts) 目录中对应的布局文件名称匹配，或者设为 `false` 以禁用布局。
  - **type**：`string | false`
  - **default**：`default`

```vue [pages/index.vue]
<script setup lang="ts">
// layouts/custom.vue
const layout = 'custom'
</script>

<template>
  <NuxtLayout :name="layout">
    <NuxtPage />
  </NuxtLayout>
</template>
```

::note
请注意，布局名称会被规范化为短横线命名法（kebab-case），所以如果你的布局文件名是 `errorLayout.vue`，传递给 `<NuxtLayout />` 的 `name` 属性时会变为 `error-layout`。
::

```vue [error.vue]
<template>
  <NuxtLayout name="error-layout">
    <NuxtPage />
  </NuxtLayout>
</template>
```

::read-more{to="https://nuxt.zhcndoc.com/docs/3.x/directory-structure/layouts"}
了解有关动态布局的更多信息。
::

- `fallback`：如果传递给 `name` 属性的布局无效，则不会渲染任何布局。在这种情况下，指定一个要渲染的 `fallback` 布局。它**必须**与 [`layouts/`](https://nuxt.zhcndoc.com/docs/3.x/directory-structure/layouts) 目录中对应的布局文件名称匹配。
  - **type**：`string`
  - **default**：`null`

## 额外 Props

`NuxtLayout` 也接受你可能需要传递给布局的任何额外属性。然后这些自定义属性会作为属性（attributes）被访问。

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

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

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

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

## 过渡效果

`<NuxtLayout />` 通过 `<slot />` 渲染传入的内容，然后被包裹在 Vue 的 `<Transition />` 组件中以激活布局过渡。为了使其正常工作，建议 `<NuxtLayout />` **不要**作为页面组件的根元素。

::code-group
```vue [pages/index.vue]
<template>
  <div>
    <NuxtLayout name="custom">
      <template #header>
        一些头部模板内容。
      </template>
    </NuxtLayout>
  </div>
</template>
```

```vue [layouts/custom.vue]
<template>
  <div>
    <!-- 命名插槽 -->
    <slot name="header" />
    <slot />
  </div>
</template>
```
::

::read-more{to="https://nuxt.zhcndoc.com/docs/3.x/getting-started/transitions"}
::

## 布局的 Ref

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

::code-group
```vue [app.vue]
<script setup lang="ts">
const layout = ref()

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

<template>
  <NuxtLayout ref="layout">
    默认布局
  </NuxtLayout>
</template>
```

```vue [layouts/default.vue]
<script setup lang="ts">
const foo = () => console.log('foo')
defineExpose({
  foo,
})
</script>

<template>
  <div>
    默认布局
    <slot />
  </div>
</template>
```
::

::read-more{to="https://nuxt.zhcndoc.com/docs/3.x/directory-structure/layouts"}
::

---

- [源码](https://github.com/nuxt/nuxt/blob/main/packages/nuxt/src/app/components/nuxt-layout.ts)


## Sitemap

See the full [sitemap](https://nuxt.zhcndoc.com/sitemap.md) for all pages.