布局

源文件
Nuxt Kit 提供了一套工具，帮助您处理布局相关功能。

布局（Layouts）被用作页面的包装器。它可用于利用通用组件（例如页眉和页脚）来包裹您的页面。可以使用 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>My Header</header>
    <slot />
    <footer>My Footer</footer>
  </div>
</template>`,
    }, 'custom')
  },
})

之后，您便可以在页面中使用此布局：

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

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