レイアウト

レイアウトは、ページのラッパーとして使用されます。たとえば、ヘッダーやフッターなど、共通のコンポーネントでページをラップするために使用できます。レイアウトは、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
}

パラメータ

レイアウト

型：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に設定されている場合、テンプレートは宛先ファイルに書き込まれます。それ以外の場合、テンプレートは仮想ファイルシステムでのみ使用されます。