<NuxtLayout>

<NuxtLayout /> コンポーネントを使用すると、app.vue または error.vue で default レイアウトを有効にできます。

<template>
  <NuxtLayout>
    some page content
  </NuxtLayout>
</template>

プロパティ

• name：レンダリングするレイアウト名を指定します。文字列、リアクティブな参照、または算出プロパティを指定できます。これは、layouts/ ディレクトリにある対応するレイアウトファイルの名前と一致する必要があります。
  • 型：string
  • デフォルト：default

<script setup lang="ts">
// layouts/custom.vue
const layout = 'custom'
</script>

<template>
  <NuxtLayout :name="layout">
    <NuxtPage />
  </NuxtLayout>
</template>

<template>
  <NuxtLayout name="error-layout">
    <NuxtPage />
  </NuxtLayout>
</template>

• fallback：無効なレイアウトが name プロパティに渡された場合、レイアウトはレンダリングされません。このシナリオでレンダリングされる fallback レイアウトを指定します。これは、layouts/ ディレクトリにある対応するレイアウトファイルの名前と一致する必要があります。
  • 型：string
  • デフォルト：null

追加プロパティ

NuxtLayout は、レイアウトに渡す必要のある追加のプロパティも受け入れます。これらのカスタムプロパティは、属性としてアクセスできるようになります。

<template>
  <div>
    <NuxtLayout name="custom" title="I am a custom layout">
      <-- ... -->
    </NuxtLayout>
  </div>
</template>

上記の例では、title の値は、テンプレートで $attrs.title を使用するか、custom.vue の <script setup> で useAttrs().title を使用して利用できます。

<script setup lang="ts">
const layoutCustomProps = useAttrs()

console.log(layoutCustomProps.title) // I am a custom layout
</script>

トランジション

<NuxtLayout /> は、レイアウトトランジションをアクティブ化するために、Vue の <Transition /> コンポーネントでラップされた <slot /> を介して着信コンテンツをレンダリングします。これが期待どおりに機能するためには、<NuxtLayout /> がページコンポーネントのルート要素ではないことが推奨されます。

<template>
  <div>
    <NuxtLayout name="custom">
      <template #header> Some header template content. </template>
    </NuxtLayout>
  </div>
</template>

レイアウトの Ref

レイアウトコンポーネントの ref を取得するには、ref.value.layoutRef を介してアクセスします。

<script setup lang="ts">
const layout = ref()

function logFoo () {
  layout.value.layoutRef.foo()
}
</script>

<template>
  <NuxtLayout ref="layout">
    default layout
  </NuxtLayout>
</template>