mirror of
https://github.com/nuxt/nuxt.git
synced 2024-11-26 23:52:06 +00:00
233 lines
7.1 KiB
Markdown
233 lines
7.1 KiB
Markdown
---
|
|
title: Pages and Layouts
|
|
description: Learn how to migrate from Nuxt 2 to Nuxt 3 pages and layouts.
|
|
---
|
|
|
|
## `app.vue`
|
|
|
|
Nuxt 3 provides a central entry point to your app via `~/app.vue`.
|
|
|
|
::callout
|
|
If you don't have an `app.vue` file in your source directory, Nuxt will use its own default version.
|
|
::
|
|
|
|
This file is a great place to put any custom code that needs to be run once when your app starts up, as well as any components that are present on every page of your app. For example, if you only have one layout, you can move this to `app.vue` instead.
|
|
|
|
:read-more{to="/docs/guide/directory-structure/app"}
|
|
|
|
:link-example{to="/docs/examples/hello-world"}
|
|
|
|
### Migration
|
|
|
|
Consider creating an `app.vue` file and including any logic that needs to run once at the top-level of your app. You can check out [an example here](/docs/guide/directory-structure/app).
|
|
|
|
## Layouts
|
|
|
|
If you are using layouts in your app for multiple pages, there is only a slight change required.
|
|
|
|
In Nuxt 2, the `<Nuxt>` component is used within a layout to render the current page. In Nuxt 3, layouts use slots instead, so you will have to replace that component with a `<slot />`. This also allows advanced use cases with named and scoped slots. [Read more about layouts](/docs/guide/directory-structure/layouts).
|
|
|
|
You will also need to change how you define the layout used by a page using the `definePageMeta` compiler macro. Layouts will be kebab-cased. So `layouts/customLayout.vue` becomes `custom-layout` when referenced in your page.
|
|
|
|
### Migration
|
|
|
|
1. Replace `<Nuxt />` with `<slot />`
|
|
```diff [layouts/custom.vue]
|
|
<template>
|
|
<div id="app-layout">
|
|
<main>
|
|
- <Nuxt />
|
|
+ <slot />
|
|
</main>
|
|
</div>
|
|
</template>
|
|
```
|
|
2. Use [`definePageMeta`](/docs/api/utils/define-page-meta) to select the layout used by your page.
|
|
```diff [pages/index.vue]
|
|
<script>
|
|
+ definePageMeta({
|
|
+ layout: 'custom'
|
|
+ })
|
|
- export default {
|
|
- layout: 'custom'
|
|
- }
|
|
</script>
|
|
```
|
|
3. Move `~/layouts/_error.vue` to `~/error.vue`. See [the error handling docs](/docs/getting-started/error-handling). If you want to ensure that this page uses a layout, you can use [`<NuxtLayout>`](/docs/guide/directory-structure/layouts) directly within `error.vue`:
|
|
```vue [error.vue]
|
|
<template>
|
|
<div>
|
|
<NuxtLayout name="default">
|
|
<!-- -->
|
|
</NuxtLayout>
|
|
</div>
|
|
</template>
|
|
```
|
|
|
|
## Pages
|
|
|
|
Nuxt 3 ships with an optional `vue-router` integration triggered by the existence of a [`pages/`](/docs/guide/directory-structure/pages) directory in your source directory. If you only have a single page, you may consider instead moving it to `app.vue` for a lighter build.
|
|
|
|
### Dynamic Routes
|
|
|
|
The format for defining dynamic routes in Nuxt 3 is slightly different from Nuxt 2, so you may need to rename some of the files within `pages/`.
|
|
|
|
1. Where you previously used `_id` to define a dynamic route parameter you now use `[id]`.
|
|
2. Where you previously used `_.vue` to define a catch-all route, you now use `[...slug].vue`.
|
|
|
|
### Nested Routes
|
|
|
|
In Nuxt 2, you will have defined any nested routes (with parent and child components) using `<Nuxt>` and `<NuxtChild>`. In Nuxt 3, these have been replaced with a single `<NuxtPage>` component.
|
|
|
|
### Page Keys and Keep-alive Props
|
|
|
|
If you were passing a custom page key or keep-alive props to `<Nuxt>`, you will now use `definePageMeta` to set these options.
|
|
|
|
:read-more{to="/docs/guide/directory-structure/pages#special-metadata"}
|
|
|
|
### Page and Layout Transitions
|
|
|
|
If you have been defining transitions for your page or layout directly in your component options, you will now need to use `definePageMeta` to set the transition. Since Vue 3, [-enter and -leave CSS classes have been renamed](https://v3-migration.vuejs.org/breaking-changes/transition.html). The `style` prop from `<Nuxt>` no longer applies to transition when used on `<slot>`, so move the styles to your `-active` class.
|
|
|
|
:read-more{to="/docs/getting-started/transitions"}
|
|
|
|
### Migration
|
|
|
|
1. Rename any pages with dynamic parameters to match the new format.
|
|
2. Update `<Nuxt>` and `<NuxtChild>` to be `<NuxtPage>`.
|
|
3. If you're using the Composition API, you can also migrate `this.$route` and `this.$router` to use [`useRoute`](/docs/api/composables/use-route) and [`useRouter`](/docs/api/composables/use-router) composables.
|
|
|
|
#### Example: Dynamic Routes
|
|
|
|
::code-group
|
|
|
|
``` [Nuxt 2]
|
|
- URL: /users
|
|
- Page: /pages/users/index.vue
|
|
|
|
- URL: /users/some-user-name
|
|
- Page: /pages/users/_user.vue
|
|
- Usage: params.user
|
|
|
|
- URL: /users/some-user-name/edit
|
|
- Page: /pages/users/_user/edit.vue
|
|
- Usage: params.user
|
|
|
|
- URL: /users/anything-else
|
|
- Page: /pages/users/_.vue
|
|
- Usage: params.pathMatch
|
|
```
|
|
|
|
``` [Nuxt 3]
|
|
- URL: /users
|
|
- Page: /pages/users/index.vue
|
|
|
|
- URL: /users/some-user-name
|
|
- Page: /pages/users/[user].vue
|
|
- Usage: params.user
|
|
|
|
- URL: /users/some-user-name/edit
|
|
- Page: /pages/users/[user]/edit.vue
|
|
- Usage: params.user
|
|
|
|
- URL: /users/anything-else
|
|
- Page: /pages/users/[...slug].vue
|
|
- Usage: params.slug
|
|
```
|
|
|
|
::
|
|
|
|
#### Example: Nested Routes and `definePageMeta`
|
|
|
|
::code-group
|
|
|
|
```vue [Nuxt 2]
|
|
<template>
|
|
<div>
|
|
<NuxtChild keep-alive :keep-alive-props="{ exclude: ['modal'] }" :nuxt-child-key="$route.slug" />
|
|
</div>
|
|
</template>
|
|
|
|
<script>
|
|
export default {
|
|
transition: 'page' // or { name: 'page' }
|
|
}
|
|
</script>
|
|
```
|
|
|
|
```vue [Nuxt 3]
|
|
<template>
|
|
<div>
|
|
<NuxtPage />
|
|
</div>
|
|
</template>
|
|
|
|
<script setup lang="ts">
|
|
// This compiler macro works in both <script> and <script setup>
|
|
definePageMeta({
|
|
// you can also pass a string or a computed property
|
|
key: route => route.slug,
|
|
transition: {
|
|
name: 'page',
|
|
},
|
|
keepalive: {
|
|
exclude: ['modal']
|
|
},
|
|
})
|
|
</script>
|
|
```
|
|
|
|
::
|
|
|
|
## `<NuxtLink>` Component
|
|
|
|
Most of the syntax and functionality are the same for the global [NuxtLink](/docs/api/components/nuxt-link) component. If you have been using the shortcut `<NLink>` format, you should update this to use `<NuxtLink>`.
|
|
|
|
`<NuxtLink>` is now a drop-in replacement for _all_ links, even external ones. You can read more about it, and how to extend it to provide your own link component.
|
|
|
|
:read-more{to="/docs/api/components/nuxt-link"}
|
|
|
|
## Programmatic Navigation
|
|
|
|
When migrating from Nuxt 2 to Nuxt 3, you will have to update how you programmatically navigate your users. In Nuxt 2, you had access to the underlying Vue Router with `this.$router`. In Nuxt 3, you can use the `navigateTo()` utility method which allows you to pass a route and parameters to Vue Router.
|
|
|
|
::callout{color="amber" icon="i-ph-warning-duotone"}
|
|
Ensure to always `await` on [`navigateTo`](/docs/api/utils/navigate-to) or chain its result by returning from functions.
|
|
::
|
|
|
|
::code-group
|
|
|
|
```vue [Nuxt 2]
|
|
<script>
|
|
export default {
|
|
methods: {
|
|
navigate(){
|
|
this.$router.push({
|
|
path: '/search',
|
|
query: {
|
|
name: 'first name',
|
|
type: '1'
|
|
}
|
|
})
|
|
}
|
|
}
|
|
}
|
|
</script>
|
|
```
|
|
|
|
```vue [Nuxt 3]
|
|
<script setup lang="ts">
|
|
function navigate(){
|
|
return navigateTo({
|
|
path: '/search',
|
|
query: {
|
|
name: 'first name',
|
|
type: '1'
|
|
}
|
|
})
|
|
}
|
|
</script>
|
|
```
|
|
|
|
::
|