布局

布局用于成为你页面的包装器。它可以用于用公共组件包装你的页面，例如，一个头部和一个尾部。布局可以通过 addLayout 实用工具进行注册。

addLayout

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

类型

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

interface NuxtTemplate {
  src?: string
  filename?: string
  dst?: string
  options?: Record<string, any>
  getContents?: (data: Record<string, any>) => string | Promise<string>
  write?: boolean
}

参数

layout

类型: NuxtTemplate | string

必需: true

一个模板对象或一个指向模板的路径的字符串。如果提供了字符串，它将被转换为具有 src 设置为字符串值的模板对象。如果提供了模板对象，则必须具有以下属性：

• src （可选）
  类型: string
  模板的路径。如果未提供 src，则必须提供 getContents。
• filename （可选）
  类型: string
  模板的文件名。如果未提供 filename，则将根据 src 路径生成。在这种情况下，src 选项是必需的。
• dst （可选）
  类型: string
  目标文件的路径。如果未提供 dst，将根据 filename 路径和 nuxt buildDir 选项生成。
• options （可选）
  类型: Options
  要传递给模板的选项。
• getContents （可选）
  类型: (data: Options) => string | Promise<string>
  将与 options 对象一起调用的函数。它应该返回一个字符串或解析为字符串的 promise。如果提供了 src，则此函数将被忽略。
• write （可选）
  类型: boolean
  如果设置为 true，则模板将写入目标文件。否则，模板将仅在虚拟文件系统中使用。