Layouts Directory

Nuxt provides a customizable layouts framework you can use throughout your application, ideal for extracting common UI or code patterns into reusable layout components.

Layouts are placed in the layouts/ directory and will be automatically loaded via asynchronous import when used. Layouts are used by adding <NuxtLayout> to your app.vue, and either setting a layout property as part of your page metadata (if you are using the ~/pages integration), or by manually specifying it as a prop to <NuxtLayout>. (Note: The layout name is normalized to kebab-case, so someLayout becomes some-layout.)

If you only have a single layout in your application, we recommend using app.vue instead.

Unlike other components, your layouts must have a single root element to allow Nuxt to apply transitions between layout changes - and this root element cannot be a <slot />.

Enabling the Default Layout

Add a ~/layouts/default.vue:

layouts/default.vue
<template>
  <div>
    Some default layout shared across all pages
    <slot />
  </div>
</template>

In a layout file, the content of the layout will be loaded in the <slot />, rather than using a special component.

If you use a app.vue you will also need to add <NuxtLayout>:

app.vue
<template>
  <NuxtLayout>
    some page content
  </NuxtLayout>
</template>

Setting Another Layout

-| layouts/
---| default.vue
---| custom.vue

You can directly override the default layout like this:

app.vue
<template>
  <NuxtLayout :name="layout">
    <NuxtPage />
  </NuxtLayout>
</template>

<script setup>
// You might choose this based on an API call or logged-in status
const layout = "custom";
</script>

Alternatively, you can override the default layout per-page like this:

pages/index.vue
<script>
// This will also work in `<script setup>`
definePageMeta({
  layout: "custom",
});
</script>
app.vue
<template>
  <NuxtLayout>
    <NuxtPage />
  </NuxtLayout>
</template>
layouts/custom.vue
<template>
  <div>
    Some *custom* layout
    <slot />
  </div>
</template>
layouts/default.vue
<template>
  <div>
    A *default* layout
    <slot />
  </div>
</template>
Learn more about defining page meta .

Changing the Layout Dynamically

You can also use a ref or computed property for your layout.

<template>
  <div>
    <button @click="enableCustomLayout">Update layout</button>
  </div>
</template>

<script setup>
const route = useRoute()
function enableCustomLayout () {
  route.meta.layout = "custom"
}
definePageMeta({
  layout: false,
});
</script>
🔎
Read and edit a live example in Examples > Routing > Layouts.

Overriding a Layout on a Per-page Basis

If you are using the ~/pages integration, you can take full control by setting layout: false and then using the <NuxtLayout> component within the page.

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

      The rest of the page
    </NuxtLayout>
  </div>
</template>

<script setup>
definePageMeta({
  layout: false,
});
</script>
layouts/custom.vue
<template>
  <div>
    <header>
      <slot name="header">
        Default header content
      </slot>
    </header>
    <main>
      <slot />
    </main>
  </div>
</template>
If you use <NuxtLayout> within your pages, make sure it is not the root element (or disable layout/page transitions).
Edit this page on GitHub Updated at Sat, Aug 13, 2022