Nuxt/docs/content/3.docs/2.directory-structure/6.layouts.md

113 lines
2.5 KiB
Markdown
Raw Normal View History

---
icon: IconDirectory
title: 'layouts'
head.title: Layouts directory
---
# Layouts directory
2021-06-30 16:32:22 +00:00
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 setting a `layout` property as part of your page metadata (if you are using the `~/pages` integration), or by using the `<NuxtLayout>` component.
2021-06-30 16:32:22 +00:00
If you only have a single layout in your application, it is recommended to use [app.vue](/docs/directory-structure/app) instead.
2021-06-30 16:32:22 +00:00
::alert{type=warning}
Unlike other components, your layouts must have a single root element to allow Nuxt to apply transitions between layout changes.
::
## Example: Enabling layouts with `app.vue`
2021-06-30 16:32:22 +00:00
```bash
-| layouts/
---| custom.vue
-| app.vue
2021-06-30 16:32:22 +00:00
```
In your layout files, you'll need to use `<slot />` to define where the content of your layout will be loaded. For example:
2021-06-30 16:32:22 +00:00
```vue{}[layouts/custom.vue]
2021-06-30 16:32:22 +00:00
<template>
<div>
Some shared layout content:
<slot />
</div>
</template>
```
Here's how you might use that layout in `app.vue`:
2021-06-30 16:32:22 +00:00
```vue{}[app.vue]
<template>
<NuxtLayout name="custom">
Hello world!
</NuxtLayout>
</template>
```
## Example: setting the layout with `~/pages`
```bash
-| layouts/
---| custom.vue
-| pages/
---| index.vue
```
You can set your layout within your page components like this:
```vue{}[pages/index.vue]
2021-06-30 16:32:22 +00:00
<script>
// This will also work in `<script setup>`
definePageMeta({
2021-06-30 16:32:22 +00:00
layout: "custom",
});
2021-06-30 16:32:22 +00:00
</script>
```
::alert{type=info}
Learn more about [defining page meta](/docs/directory-structure/pages#page-metadata).
::
## Example: manual control with `~/pages`
2021-06-30 16:32:22 +00:00
Even if you are using the `~/pages` integration, you can take full control by using the `<NuxtLayout>` component (which is globally available throughout your application), by setting `layout: false`.
2021-06-30 16:32:22 +00:00
```vue
<template>
<NuxtLayout name="custom">
<template #header> Some header template content. </template>
The rest of the page
</NuxtLayout>
</template>
<script setup>
definePageMeta({
2021-06-30 16:32:22 +00:00
layout: false,
});
2021-06-30 16:32:22 +00:00
</script>
```
## Example: changing the layout
You can also use a ref or computed property for your layout.
```vue
<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>
```