v3.17
Nuxt on GitHub

布局

源代码
Nuxt Kit 提供了一组实用工具，帮助您处理布局。

布局用于包装您的页面。它可用于用通用组件包装页面，例如头部和底部。可以使用 addLayout 实用工具注册布局。

addLayout

将模板注册为布局并将其添加到布局中。

在 Nuxt 2 中，error 布局也可以使用此实用工具注册。在 Nuxt 3+ 中，error 布局已替换为项目根目录中的 error.vue 页面。

使用

import { addLayout, createResolver, defineNuxtModule } from '@nuxt/kit'

export default defineNuxtModule({
  setup () {
    const { resolve } = createResolver(import.meta.url)

    addLayout({
      src: resolve('templates/custom-layout.ts'),
      filename: 'custom-layout.ts',
    }, 'custom')
  },
})

类型

function addLayout(layout: NuxtTemplate | string, name: string): void

参数

layout: 模板对象或包含模板路径的字符串。如果提供字符串，将转换为模板对象，并将 src 设置为该字符串值。如果提供模板对象，则必须具有以下属性：

属性类型必需描述
srcstringfalse模板的路径。如果未提供 src，则必须提供 getContents。
filenamestringfalse模板的文件名。如果未提供 filename，将根据 src 路径生成。在这种情况下，src 选项是必需的。
dststringfalse目标文件的路径。如果未提供 dst，将根据 filename 路径和 Nuxt 的 buildDir 选项生成。
optionsRecord<string, any>false传递给模板的选项。
getContents(data) => string | Promise<string>false一个函数，将接收 options 对象作为参数。它应返回字符串或解析为字符串的 Promise。如果提供了 src，此函数将被忽略。
writebooleanfalse如果设置为 true，模板将被写入目标文件。否则，模板仅在虚拟文件系统中使用。

name: 注册布局的名称（例如，default、custom 等）。

示例

这将注册一个名为 custom 的布局，用头部和底部包装页面。

import { addLayout, defineNuxtModule } from '@nuxt/kit'

export default defineNuxtModule({
  setup () {
    addLayout({
      write: true,
      filename: 'my-layout.vue',
      getContents: () => `<template>
  <div>
    <header>我的头部</header>
    <slot />
    <footer>我的底部</footer>
  </div>
</template>`,
    }, 'custom')
  },
})

您可以在页面中使用此布局：

pages/about.vue
<script setup lang="ts">
definePageMeta({
  layout: 'custom',
})
</script>

<template>
  <div>关于页面</div>
</template>
由于 @vitejs/plugin-vue 不支持虚拟 .vue 文件，您可以通过将 write: true 传递给 addLayout 的第一个参数来解决此限制。