v3.17
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 的第一个参数来解决此限制。