@nuxt/docs 3.20.1 → 3.21.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/1.getting-started/01.introduction.md +5 -5
- package/1.getting-started/02.installation.md +4 -7
- package/1.getting-started/03.configuration.md +32 -32
- package/1.getting-started/04.views.md +10 -8
- package/1.getting-started/05.assets.md +8 -8
- package/1.getting-started/06.styling.md +24 -18
- package/1.getting-started/07.routing.md +11 -11
- package/1.getting-started/08.seo-meta.md +10 -6
- package/1.getting-started/09.transitions.md +12 -12
- package/1.getting-started/10.data-fetching.md +18 -18
- package/1.getting-started/11.state-management.md +7 -7
- package/1.getting-started/12.error-handling.md +28 -22
- package/1.getting-started/13.server.md +9 -9
- package/1.getting-started/14.layers.md +52 -18
- package/1.getting-started/15.prerendering.md +10 -4
- package/1.getting-started/16.deployment.md +3 -2
- package/1.getting-started/17.testing.md +18 -8
- package/1.getting-started/18.upgrade.md +111 -60
- package/{2.guide/1.directory-structure → 2.directory-structure}/0.nuxt.md +1 -1
- package/{2.guide/1.directory-structure → 2.directory-structure}/0.output.md +2 -2
- package/{2.guide/1.directory-structure → 2.directory-structure}/1.assets.md +3 -3
- package/{2.guide/1.directory-structure → 2.directory-structure}/1.components.md +13 -9
- package/{2.guide/1.directory-structure → 2.directory-structure}/1.composables.md +4 -4
- package/{2.guide/1.directory-structure → 2.directory-structure}/1.content.md +2 -2
- package/2.directory-structure/1.layers.md +87 -0
- package/{2.guide/1.directory-structure → 2.directory-structure}/1.layouts.md +37 -5
- package/{2.guide/1.directory-structure → 2.directory-structure}/1.middleware.md +8 -8
- package/{2.guide/1.directory-structure → 2.directory-structure}/1.modules.md +10 -4
- package/{2.guide/1.directory-structure → 2.directory-structure}/1.node_modules.md +2 -2
- package/{2.guide/1.directory-structure → 2.directory-structure}/1.pages.md +43 -22
- package/{2.guide/1.directory-structure → 2.directory-structure}/1.plugins.md +6 -3
- package/{2.guide/1.directory-structure → 2.directory-structure}/1.public.md +1 -1
- package/{2.guide/1.directory-structure → 2.directory-structure}/1.server.md +29 -9
- package/{2.guide/1.directory-structure → 2.directory-structure}/1.shared.md +4 -4
- package/{2.guide/1.directory-structure → 2.directory-structure}/1.utils.md +5 -5
- package/{2.guide/1.directory-structure → 2.directory-structure}/2.env.md +4 -4
- package/{2.guide/1.directory-structure → 2.directory-structure}/2.nuxtignore.md +2 -1
- package/{2.guide/1.directory-structure → 2.directory-structure}/2.nuxtrc.md +6 -3
- package/{2.guide/1.directory-structure → 2.directory-structure}/3.app-config.md +2 -2
- package/{2.guide/1.directory-structure → 2.directory-structure}/3.app.md +5 -5
- package/{2.guide/1.directory-structure → 2.directory-structure}/3.error.md +10 -8
- package/{2.guide/1.directory-structure → 2.directory-structure}/3.nuxt-config.md +2 -2
- package/{2.guide/1.directory-structure → 2.directory-structure}/3.package.md +1 -1
- package/{2.guide/1.directory-structure → 2.directory-structure}/3.tsconfig.md +3 -2
- package/2.directory-structure/index.md +65 -0
- package/3.guide/0.index.md +28 -0
- package/{2.guide/2.concepts/3.rendering.md → 3.guide/1.concepts/1.rendering.md} +8 -33
- package/{2.guide/2.concepts/2.vuejs-development.md → 3.guide/1.concepts/10.vuejs-development.md} +11 -10
- package/{2.guide/2.concepts/10.nuxt-lifecycle.md → 3.guide/1.concepts/2.nuxt-lifecycle.md} +34 -27
- package/{2.guide/2.concepts/1.auto-imports.md → 3.guide/1.concepts/3.auto-imports.md} +10 -10
- package/{2.guide/2.concepts → 3.guide/1.concepts}/4.server-engine.md +3 -3
- package/{2.guide/2.concepts → 3.guide/1.concepts}/5.modules.md +15 -2
- package/{2.guide/2.concepts → 3.guide/1.concepts}/7.esm.md +5 -4
- package/{2.guide/2.concepts → 3.guide/1.concepts}/8.typescript.md +11 -17
- package/{2.guide/2.concepts → 3.guide/1.concepts}/9.code-style.md +1 -1
- package/{2.guide/5.best-practices → 3.guide/2.best-practices}/hydration.md +1 -1
- package/{2.guide/5.best-practices → 3.guide/2.best-practices}/performance.md +5 -5
- package/3.guide/3.ai/.navigation.yml +3 -0
- package/3.guide/3.ai/1.mcp.md +277 -0
- package/3.guide/3.ai/2.llms-txt.md +65 -0
- package/3.guide/4.modules/.navigation.yml +3 -0
- package/3.guide/4.modules/1.getting-started.md +103 -0
- package/3.guide/4.modules/2.module-anatomy.md +138 -0
- package/3.guide/4.modules/3.recipes-basics.md +330 -0
- package/3.guide/4.modules/4.recipes-advanced.md +243 -0
- package/3.guide/4.modules/5.testing.md +76 -0
- package/3.guide/4.modules/6.best-practices.md +104 -0
- package/3.guide/4.modules/7.ecosystem.md +32 -0
- package/3.guide/4.modules/index.md +36 -0
- package/{2.guide/4.recipes → 3.guide/5.recipes}/1.custom-routing.md +4 -4
- package/{2.guide/4.recipes → 3.guide/5.recipes}/2.vite-plugin.md +5 -1
- package/{2.guide/4.recipes → 3.guide/5.recipes}/3.custom-usefetch.md +3 -3
- package/{2.guide/4.recipes → 3.guide/5.recipes}/4.sessions-and-authentication.md +2 -2
- package/{2.guide/3.going-further → 3.guide/6.going-further}/1.events.md +3 -4
- package/{2.guide/3.going-further → 3.guide/6.going-further}/1.experimental-features.md +212 -87
- package/3.guide/6.going-further/1.features.md +108 -0
- package/{2.guide/3.going-further → 3.guide/6.going-further}/1.internals.md +5 -4
- package/{2.guide/3.going-further → 3.guide/6.going-further}/10.runtime-config.md +3 -3
- package/{2.guide/3.going-further → 3.guide/6.going-further}/11.nightly-release-channel.md +1 -1
- package/{2.guide/3.going-further → 3.guide/6.going-further}/2.hooks.md +7 -7
- package/{2.guide/3.going-further → 3.guide/6.going-further}/4.kit.md +3 -3
- package/{2.guide/3.going-further → 3.guide/6.going-further}/6.nuxt-app.md +6 -6
- package/{2.guide/3.going-further → 3.guide/6.going-further}/7.layers.md +40 -14
- package/{2.guide/3.going-further → 3.guide/6.going-further}/9.debugging.md +3 -2
- package/{3.api → 4.api}/1.components/1.nuxt-client-fallback.md +5 -1
- package/{3.api → 4.api}/1.components/10.nuxt-picture.md +1 -1
- package/{3.api → 4.api}/1.components/11.teleports.md +2 -2
- package/{3.api → 4.api}/1.components/12.nuxt-route-announcer.md +1 -3
- package/{3.api → 4.api}/1.components/13.nuxt-time.md +0 -2
- package/{3.api → 4.api}/1.components/2.nuxt-page.md +4 -4
- package/{3.api → 4.api}/1.components/3.nuxt-layout.md +7 -7
- package/{3.api → 4.api}/1.components/4.nuxt-link.md +13 -13
- package/{3.api → 4.api}/1.components/5.nuxt-loading-indicator.md +2 -2
- package/{3.api → 4.api}/1.components/6.nuxt-error-boundary.md +2 -2
- package/{3.api → 4.api}/1.components/7.nuxt-welcome.md +2 -2
- package/{3.api → 4.api}/1.components/8.nuxt-island.md +9 -2
- package/{3.api → 4.api}/2.composables/use-app-config.md +1 -1
- package/{3.api → 4.api}/2.composables/use-async-data.md +5 -5
- package/4.api/2.composables/use-cookie.md +183 -0
- package/{3.api → 4.api}/2.composables/use-error.md +3 -3
- package/{3.api → 4.api}/2.composables/use-fetch.md +37 -37
- package/{3.api → 4.api}/2.composables/use-head-safe.md +1 -1
- package/{3.api → 4.api}/2.composables/use-head.md +22 -7
- package/{3.api → 4.api}/2.composables/use-lazy-async-data.md +1 -1
- package/{3.api → 4.api}/2.composables/use-lazy-fetch.md +9 -9
- package/{3.api → 4.api}/2.composables/use-nuxt-app.md +11 -9
- package/{3.api → 4.api}/2.composables/use-response-header.md +1 -1
- package/{3.api → 4.api}/2.composables/use-route-announcer.md +0 -2
- package/{3.api → 4.api}/2.composables/use-route.md +2 -2
- package/4.api/2.composables/use-router.md +94 -0
- package/{3.api → 4.api}/2.composables/use-runtime-config.md +5 -5
- package/{3.api → 4.api}/2.composables/use-seo-meta.md +2 -2
- package/{3.api → 4.api}/2.composables/use-server-seo-meta.md +2 -2
- package/{3.api → 4.api}/2.composables/use-state.md +12 -2
- package/{3.api → 4.api}/3.utils/$fetch.md +2 -2
- package/{3.api → 4.api}/3.utils/abort-navigation.md +3 -3
- package/{3.api → 4.api}/3.utils/add-route-middleware.md +1 -1
- package/{3.api → 4.api}/3.utils/call-once.md +2 -4
- package/{3.api → 4.api}/3.utils/clear-error.md +1 -1
- package/{3.api → 4.api}/3.utils/create-error.md +7 -7
- package/{3.api → 4.api}/3.utils/define-lazy-hydration-component.md +5 -5
- package/{3.api → 4.api}/3.utils/define-nuxt-component.md +1 -1
- package/{3.api → 4.api}/3.utils/define-nuxt-plugin.md +12 -12
- package/{3.api → 4.api}/3.utils/define-nuxt-route-middleware.md +3 -3
- package/{3.api → 4.api}/3.utils/define-page-meta.md +23 -16
- package/{3.api → 4.api}/3.utils/define-route-rules.md +2 -2
- package/{3.api → 4.api}/3.utils/navigate-to.md +14 -14
- package/{3.api → 4.api}/3.utils/on-before-route-leave.md +1 -1
- package/{3.api → 4.api}/3.utils/on-before-route-update.md +1 -1
- package/{3.api → 4.api}/3.utils/preload-route-components.md +2 -2
- package/{3.api → 4.api}/3.utils/refresh-cookie.md +0 -2
- package/{3.api → 4.api}/3.utils/refresh-nuxt-data.md +1 -1
- package/{3.api → 4.api}/3.utils/reload-nuxt-app.md +1 -1
- package/{3.api → 4.api}/3.utils/set-page-layout.md +36 -0
- package/{3.api → 4.api}/3.utils/set-response-status.md +3 -3
- package/{3.api → 4.api}/3.utils/show-error.md +4 -4
- package/{3.api → 4.api}/3.utils/update-app-config.md +2 -2
- package/{3.api → 4.api}/4.commands/add.md +11 -11
- package/4.api/4.commands/analyze.md +42 -0
- package/4.api/4.commands/build-module.md +42 -0
- package/4.api/4.commands/build.md +47 -0
- package/{3.api → 4.api}/4.commands/cleanup.md +6 -6
- package/4.api/4.commands/dev.md +60 -0
- package/{3.api → 4.api}/4.commands/devtools.md +7 -7
- package/4.api/4.commands/generate.md +42 -0
- package/4.api/4.commands/info.md +33 -0
- package/4.api/4.commands/init.md +50 -0
- package/4.api/4.commands/module.md +84 -0
- package/4.api/4.commands/prepare.md +41 -0
- package/4.api/4.commands/preview.md +44 -0
- package/4.api/4.commands/test.md +40 -0
- package/4.api/4.commands/typecheck.md +44 -0
- package/4.api/4.commands/upgrade.md +37 -0
- package/{3.api → 4.api}/5.kit/1.modules.md +31 -18
- package/{3.api → 4.api}/5.kit/10.templates.md +23 -23
- package/{3.api → 4.api}/5.kit/11.nitro.md +36 -36
- package/{3.api → 4.api}/5.kit/12.resolving.md +2 -2
- package/{3.api → 4.api}/5.kit/14.builder.md +35 -23
- package/{3.api → 4.api}/5.kit/16.layers.md +16 -16
- package/{3.api → 4.api}/5.kit/2.programmatic.md +2 -2
- package/{3.api → 4.api}/5.kit/3.compatibility.md +2 -2
- package/{3.api → 4.api}/5.kit/4.autoimports.md +18 -18
- package/4.api/5.kit/5.components.md +146 -0
- package/{3.api → 4.api}/5.kit/6.context.md +1 -1
- package/{3.api → 4.api}/5.kit/8.layout.md +1 -1
- package/4.api/6.advanced/1.hooks.md +105 -0
- package/{3.api → 4.api}/index.md +7 -7
- package/5.community/4.contribution.md +10 -10
- package/5.community/5.framework-contribution.md +9 -9
- package/5.community/6.roadmap.md +25 -25
- package/5.community/7.changelog.md +20 -0
- package/6.bridge/1.overview.md +9 -1
- package/6.bridge/3.bridge-composition-api.md +2 -2
- package/6.bridge/4.plugins-and-middleware.md +4 -4
- package/6.bridge/5.nuxt3-compatible-api.md +1 -1
- package/6.bridge/8.nitro.md +4 -0
- package/7.migration/10.bundling.md +1 -1
- package/7.migration/11.server.md +3 -3
- package/7.migration/2.configuration.md +6 -6
- package/7.migration/20.module-authors.md +3 -3
- package/7.migration/3.auto-imports.md +1 -1
- package/7.migration/4.meta.md +1 -1
- package/7.migration/5.plugins-and-middleware.md +3 -3
- package/7.migration/6.pages-and-layouts.md +9 -9
- package/7.migration/7.component-options.md +6 -6
- package/7.migration/8.runtime-config.md +1 -1
- package/package.json +1 -1
- package/2.guide/0.index.md +0 -25
- package/2.guide/3.going-further/1.features.md +0 -103
- package/2.guide/3.going-further/3.modules.md +0 -901
- package/3.api/2.composables/use-cookie.md +0 -183
- package/3.api/2.composables/use-router.md +0 -94
- package/3.api/4.commands/analyze.md +0 -42
- package/3.api/4.commands/build-module.md +0 -42
- package/3.api/4.commands/build.md +0 -47
- package/3.api/4.commands/dev.md +0 -60
- package/3.api/4.commands/generate.md +0 -42
- package/3.api/4.commands/info.md +0 -33
- package/3.api/4.commands/init.md +0 -50
- package/3.api/4.commands/module.md +0 -84
- package/3.api/4.commands/prepare.md +0 -41
- package/3.api/4.commands/preview.md +0 -44
- package/3.api/4.commands/test.md +0 -40
- package/3.api/4.commands/typecheck.md +0 -44
- package/3.api/4.commands/upgrade.md +0 -37
- package/3.api/5.kit/5.components.md +0 -146
- package/3.api/6.advanced/1.hooks.md +0 -105
- /package/{2.guide/1.directory-structure → 2.directory-structure}/.navigation.yml +0 -0
- /package/{2.guide/1.directory-structure → 2.directory-structure}/2.gitignore.md +0 -0
- /package/{2.guide → 3.guide}/.navigation.yml +0 -0
- /package/{2.guide/2.concepts → 3.guide/1.concepts}/.navigation.yml +0 -0
- /package/{2.guide/5.best-practices → 3.guide/2.best-practices}/.navigation.yml +0 -0
- /package/{2.guide/5.best-practices → 3.guide/2.best-practices}/plugins.md +0 -0
- /package/{2.guide/4.recipes → 3.guide/5.recipes}/.navigation.yml +0 -0
- /package/{2.guide/3.going-further → 3.guide/6.going-further}/.navigation.yml +0 -0
- /package/{2.guide/3.going-further → 3.guide/6.going-further}/index.md +0 -0
- /package/{3.api → 4.api}/.navigation.yml +0 -0
- /package/{3.api → 4.api}/1.components/.navigation.yml +0 -0
- /package/{3.api → 4.api}/1.components/1.client-only.md +0 -0
- /package/{3.api → 4.api}/1.components/1.dev-only.md +0 -0
- /package/{3.api → 4.api}/1.components/9.nuxt-img.md +0 -0
- /package/{3.api → 4.api}/2.composables/.navigation.yml +0 -0
- /package/{3.api → 4.api}/2.composables/on-prehydrate.md +0 -0
- /package/{3.api → 4.api}/2.composables/use-hydration.md +0 -0
- /package/{3.api → 4.api}/2.composables/use-loading-indicator.md +0 -0
- /package/{3.api → 4.api}/2.composables/use-nuxt-data.md +0 -0
- /package/{3.api → 4.api}/2.composables/use-preview-mode.md +0 -0
- /package/{3.api → 4.api}/2.composables/use-request-event.md +0 -0
- /package/{3.api → 4.api}/2.composables/use-request-fetch.md +0 -0
- /package/{3.api → 4.api}/2.composables/use-request-header.md +0 -0
- /package/{3.api → 4.api}/2.composables/use-request-headers.md +0 -0
- /package/{3.api → 4.api}/2.composables/use-request-url.md +0 -0
- /package/{3.api → 4.api}/2.composables/use-runtime-hook.md +0 -0
- /package/{3.api → 4.api}/3.utils/.navigation.yml +0 -0
- /package/{3.api → 4.api}/3.utils/clear-nuxt-data.md +0 -0
- /package/{3.api → 4.api}/3.utils/clear-nuxt-state.md +0 -0
- /package/{3.api → 4.api}/3.utils/on-nuxt-ready.md +0 -0
- /package/{3.api → 4.api}/3.utils/prefetch-components.md +0 -0
- /package/{3.api → 4.api}/3.utils/preload-components.md +0 -0
- /package/{3.api → 4.api}/3.utils/prerender-routes.md +0 -0
- /package/{3.api → 4.api}/4.commands/.navigation.yml +0 -0
- /package/{3.api → 4.api}/5.kit/.navigation.yml +0 -0
- /package/{3.api → 4.api}/5.kit/10.runtime-config.md +0 -0
- /package/{3.api → 4.api}/5.kit/13.logging.md +0 -0
- /package/{3.api → 4.api}/5.kit/15.examples.md +0 -0
- /package/{3.api → 4.api}/5.kit/7.pages.md +0 -0
- /package/{3.api → 4.api}/5.kit/9.head.md +0 -0
- /package/{3.api → 4.api}/5.kit/9.plugins.md +0 -0
- /package/{3.api → 4.api}/6.advanced/.navigation.yml +0 -0
- /package/{3.api → 4.api}/6.advanced/2.import-meta.md +0 -0
- /package/{3.api → 4.api}/6.nuxt-config.md +0 -0
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Lifecycle Hooks'
|
|
3
|
+
description: Nuxt provides a powerful hooking system to expand almost every aspect using hooks.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
:read-more{to="/docs/3.x/guide/going-further/hooks"}
|
|
7
|
+
|
|
8
|
+
## App Hooks (runtime)
|
|
9
|
+
|
|
10
|
+
Check the [app source code](https://github.com/nuxt/nuxt/blob/main/packages/nuxt/src/app/nuxt.ts#L37) for all available hooks.
|
|
11
|
+
|
|
12
|
+
| Hook | Arguments | Environment | Description |
|
|
13
|
+
|------------------------------|---------------------|-----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
14
|
+
| `app:created` | `vueApp` | Server & Client | Called when initial `vueApp` instance is created. |
|
|
15
|
+
| `app:error` | `err` | Server & Client | Called when a fatal error occurs. |
|
|
16
|
+
| `app:error:cleared` | `{ redirect? }` | Server & Client | Called when a fatal error occurs. |
|
|
17
|
+
| `vue:setup` | - | Server & Client | Called when the setup of Nuxt root is initialized. This callback must be synchronous. |
|
|
18
|
+
| `vue:error` | `err, target, info` | Server & Client | Called when a vue error propagates to the root component. [Learn More](https://vuejs.org/api/composition-api-lifecycle#onerrorcaptured). |
|
|
19
|
+
| `app:rendered` | `renderContext` | Server | Called when SSR rendering is done. |
|
|
20
|
+
| `app:redirected` | - | Server | Called before SSR redirection. |
|
|
21
|
+
| `app:beforeMount` | `vueApp` | Client | Called before mounting the app, called only on client side. |
|
|
22
|
+
| `app:mounted` | `vueApp` | Client | Called when Vue app is initialized and mounted in browser. |
|
|
23
|
+
| `app:suspense:resolve` | `appComponent` | Client | On [Suspense](https://vuejs.org/guide/built-ins/suspense#suspense) resolved event. |
|
|
24
|
+
| `app:manifest:update` | `{ id, timestamp }` | Client | Called when there is a newer version of your app detected. |
|
|
25
|
+
| `app:data:refresh` | `keys?` | Client | Called when `refreshNuxtData` is called. |
|
|
26
|
+
| `link:prefetch` | `to` | Client | Called when a `<NuxtLink>` is observed to be prefetched. |
|
|
27
|
+
| `page:start` | `pageComponent?` | Client | Called on [Suspense](https://vuejs.org/guide/built-ins/suspense#suspense) inside of `NuxtPage` pending event. |
|
|
28
|
+
| `page:finish` | `pageComponent?` | Client | Called on [Suspense](https://vuejs.org/guide/built-ins/suspense#suspense) inside of `NuxtPage` resolved event. |
|
|
29
|
+
| `page:loading:start` | - | Client | Called when the `setup()` of the new page is running. |
|
|
30
|
+
| `page:loading:end` | - | Client | Called after `page:finish` |
|
|
31
|
+
| `page:transition:finish` | `pageComponent?` | Client | After page transition [onAfterLeave](https://vuejs.org/guide/built-ins/transition#javascript-hooks) event. |
|
|
32
|
+
| `dev:ssr-logs` | `logs` | Client | Called with an array of server-side logs that have been passed to the client (if `features.devLogs` is enabled). |
|
|
33
|
+
| `page:view-transition:start` | `transition` | Client | Called after `document.startViewTransition` is called when [experimental viewTransition support is enabled](/docs/3.x/getting-started/transitions#view-transitions-api-experimental). |
|
|
34
|
+
|
|
35
|
+
## Nuxt Hooks (build time)
|
|
36
|
+
|
|
37
|
+
Check the [schema source code](https://github.com/nuxt/nuxt/blob/main/packages/schema/src/types/hooks.ts#L83) for all available hooks.
|
|
38
|
+
|
|
39
|
+
| Hook | Arguments | Description |
|
|
40
|
+
|-----------------------------|----------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
41
|
+
| `kit:compatibility` | `compatibility, issues` | Allows extending compatibility checks. |
|
|
42
|
+
| `ready` | `nuxt` | Called after Nuxt initialization, when the Nuxt instance is ready to work. |
|
|
43
|
+
| `close` | `nuxt` | Called when Nuxt instance is gracefully closing. |
|
|
44
|
+
| `restart` | `{ hard?: boolean }` | To be called to restart the current Nuxt instance. |
|
|
45
|
+
| `modules:before` | - | Called during Nuxt initialization, before installing user modules. |
|
|
46
|
+
| `modules:done` | - | Called during Nuxt initialization, after installing user modules. |
|
|
47
|
+
| `app:resolve` | `app` | Called after resolving the `app` instance. |
|
|
48
|
+
| `app:templates` | `app` | Called during `NuxtApp` generation, to allow customizing, modifying or adding new files to the build directory (either virtually or to written to `.nuxt`). |
|
|
49
|
+
| `app:templatesGenerated` | `app` | Called after templates are compiled into the [virtual file system](/docs/3.x/directory-structure/nuxt) (vfs). |
|
|
50
|
+
| `build:before` | - | Called before Nuxt bundle builder. |
|
|
51
|
+
| `build:done` | - | Called after Nuxt bundle builder is complete. |
|
|
52
|
+
| `build:manifest` | `manifest` | Called during the manifest build by Vite and webpack. This allows customizing the manifest that Nitro will use to render `<script>` and `<link>` tags in the final HTML. |
|
|
53
|
+
| `builder:generateApp` | `options` | Called before generating the app. |
|
|
54
|
+
| `builder:watch` | `event, path` | Called at build time in development when the watcher spots a change to a file or directory in the project. |
|
|
55
|
+
| `pages:extend` | `pages` | Called after page routes are scanned from the file system. |
|
|
56
|
+
| `pages:resolved` | `pages` | Called after page routes have been augmented with scanned metadata. |
|
|
57
|
+
| `pages:routerOptions` | `{ files: Array<{ path: string, optional?: boolean }> }` | Called when resolving `router.options` files. Later items in the array override earlier ones. |
|
|
58
|
+
| `server:devHandler` | `handler` | Called when the dev middleware is being registered on the Nitro dev server. |
|
|
59
|
+
| `imports:sources` | `presets` | Called at setup allowing modules to extend sources. |
|
|
60
|
+
| `imports:extend` | `imports` | Called at setup allowing modules to extend imports. |
|
|
61
|
+
| `imports:context` | `context` | Called when the [unimport](https://github.com/unjs/unimport) context is created. |
|
|
62
|
+
| `imports:dirs` | `dirs` | Allows extending import directories. |
|
|
63
|
+
| `components:dirs` | `dirs` | Called within `app:resolve` allowing to extend the directories that are scanned for auto-importable components. |
|
|
64
|
+
| `components:extend` | `components` | Allows extending new components. |
|
|
65
|
+
| `nitro:config` | `nitroConfig` | Called before initializing Nitro, allowing customization of Nitro's configuration. |
|
|
66
|
+
| `nitro:init` | `nitro` | Called after Nitro is initialized, which allows registering Nitro hooks and interacting directly with Nitro. |
|
|
67
|
+
| `nitro:build:before` | `nitro` | Called before building the Nitro instance. |
|
|
68
|
+
| `nitro:build:public-assets` | `nitro` | Called after copying public assets. Allows modifying public assets before Nitro server is built. |
|
|
69
|
+
| `prerender:routes` | `ctx` | Allows extending the routes to be pre-rendered. |
|
|
70
|
+
| `build:error` | `error` | Called when an error occurs at build time. |
|
|
71
|
+
| `prepare:types` | `options` | Called before `@nuxt/cli` writes TypeScript configuration files (`.nuxt/tsconfig.app.json`, `.nuxt/tsconfig.server.json`, etc.) and `.nuxt/nuxt.d.ts`, allowing addition of custom references and declarations in `nuxt.d.ts`, or directly modifying the options in generated configurations |
|
|
72
|
+
| `listen` | `listenerServer, listener` | Called when the dev server is loading. |
|
|
73
|
+
| `schema:extend` | `schemas` | Allows extending default schemas. |
|
|
74
|
+
| `schema:resolved` | `schema` | Allows extending resolved schema. |
|
|
75
|
+
| `schema:beforeWrite` | `schema` | Called before writing the given schema. |
|
|
76
|
+
| `schema:written` | - | Called after the schema is written. |
|
|
77
|
+
| `vite:extend` | `viteBuildContext` | Allows extending Vite default context. |
|
|
78
|
+
| `vite:extendConfig` | `viteInlineConfig, env` | Allows extending Vite default config. **Deprecated in Nuxt 5+.** In Nuxt 5, this operates on a shared configuration rather than separate client/server configs. |
|
|
79
|
+
| `vite:configResolved` | `viteInlineConfig, env` | Allows reading the resolved Vite config. **Deprecated in Nuxt 5+.** In Nuxt 5, this operates on a shared configuration rather than separate client/server configs. |
|
|
80
|
+
| `vite:serverCreated` | `viteServer, env` | Called when the Vite server is created. |
|
|
81
|
+
| `vite:compiled` | - | Called after Vite server is compiled. |
|
|
82
|
+
| `webpack:config` | `webpackConfigs` | Called before configuring the webpack compiler. |
|
|
83
|
+
| `webpack:configResolved` | `webpackConfigs` | Allows reading the resolved webpack config. |
|
|
84
|
+
| `webpack:compile` | `options` | Called right before compilation. |
|
|
85
|
+
| `webpack:compiled` | `options` | Called after resources are loaded. |
|
|
86
|
+
| `webpack:change` | `shortPath` | Called on `change` on WebpackBar. |
|
|
87
|
+
| `webpack:error` | - | Called on `done` if has errors on WebpackBar. |
|
|
88
|
+
| `webpack:done` | - | Called on `allDone` on WebpackBar. |
|
|
89
|
+
| `webpack:progress` | `statesArray` | Called on `progress` on WebpackBar. |
|
|
90
|
+
|
|
91
|
+
## Nitro App Hooks (runtime, server-side)
|
|
92
|
+
|
|
93
|
+
See [Nitro](https://nitro.build/guide/plugins#available-hooks) for all available hooks.
|
|
94
|
+
|
|
95
|
+
| Hook | Arguments | Description | Types |
|
|
96
|
+
|-------------------|--------------------------------------------|---------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
97
|
+
| `dev:ssr-logs` | `{ path, logs }` | Server | Called at the end of a request cycle with an array of server-side logs. |
|
|
98
|
+
| `render:response` | `response, { event }` | Called before sending the response. | [response](https://github.com/nuxt/nuxt/blob/71ef8bd3ff207fd51c2ca18d5a8c7140476780c7/packages/nuxt/src/core/runtime/nitro/renderer.ts#L24), [event](https://github.com/h3js/h3/blob/f6ceb5581043dc4d8b6eab91e9be4531e0c30f8e/src/types.ts#L38) |
|
|
99
|
+
| `render:html` | `html, { event }` | Called before constructing the HTML. | [html](https://github.com/nuxt/nuxt/blob/71ef8bd3ff207fd51c2ca18d5a8c7140476780c7/packages/nuxt/src/core/runtime/nitro/renderer.ts#L15), [event](https://github.com/h3js/h3/blob/f6ceb5581043dc4d8b6eab91e9be4531e0c30f8e/src/types.ts#L38) |
|
|
100
|
+
| `render:island` | `islandResponse, { event, islandContext }` | Called before constructing the island HTML. | [islandResponse](https://github.com/nuxt/nuxt/blob/e50cabfed1984c341af0d0c056a325a8aec26980/packages/nuxt/src/core/runtime/nitro/renderer.ts#L28), [event](https://github.com/h3js/h3/blob/f6ceb5581043dc4d8b6eab91e9be4531e0c30f8e/src/types.ts#L38), [islandContext](https://github.com/nuxt/nuxt/blob/e50cabfed1984c341af0d0c056a325a8aec26980/packages/nuxt/src/core/runtime/nitro/renderer.ts#L38) |
|
|
101
|
+
| `close` | - | Called when Nitro is closed. | - |
|
|
102
|
+
| `error` | `error, { event? }` | Called when an error occurs. | [error](https://github.com/nitrojs/nitro/blob/d20ffcbd16fc4003b774445e1a01e698c2bb078a/src/types/runtime/nitro.ts#L48), [event](https://github.com/h3js/h3/blob/f6ceb5581043dc4d8b6eab91e9be4531e0c30f8e/src/types.ts#L38) |
|
|
103
|
+
| `request` | `event` | Called when a request is received. | [event](https://github.com/h3js/h3/blob/f6ceb5581043dc4d8b6eab91e9be4531e0c30f8e/src/types.ts#L38) |
|
|
104
|
+
| `beforeResponse` | `event, { body }` | Called before sending the response. | [event](https://github.com/h3js/h3/blob/f6ceb5581043dc4d8b6eab91e9be4531e0c30f8e/src/types.ts#L38), unknown |
|
|
105
|
+
| `afterResponse` | `event, { body }` | Called after sending the response. | [event](https://github.com/h3js/h3/blob/f6ceb5581043dc4d8b6eab91e9be4531e0c30f8e/src/types.ts#L38), unknown |
|
package/{3.api → 4.api}/index.md
RENAMED
|
@@ -7,25 +7,25 @@ surround: false
|
|
|
7
7
|
---
|
|
8
8
|
|
|
9
9
|
::card-group
|
|
10
|
-
::card{icon="i-lucide-box" title="Components" to="/docs/api/components/client-only"}
|
|
10
|
+
::card{icon="i-lucide-box" title="Components" to="/docs/3.x/api/components/client-only"}
|
|
11
11
|
Explore Nuxt built-in components for pages, layouts, head, and more.
|
|
12
12
|
::
|
|
13
|
-
::card{icon="i-lucide-arrow-left-right" title="Composables" to="/docs/api/composables/use-app-config"}
|
|
13
|
+
::card{icon="i-lucide-arrow-left-right" title="Composables" to="/docs/3.x/api/composables/use-app-config"}
|
|
14
14
|
Discover Nuxt composable functions for data-fetching, head management and more.
|
|
15
15
|
::
|
|
16
|
-
::card{icon="i-lucide-square-function" title="Utils" to="/docs/api/utils/dollarfetch"}
|
|
16
|
+
::card{icon="i-lucide-square-function" title="Utils" to="/docs/3.x/api/utils/dollarfetch"}
|
|
17
17
|
Learn about Nuxt utility functions for navigation, error handling and more.
|
|
18
18
|
::
|
|
19
|
-
::card{icon="i-lucide-square-terminal" title="Commands" to="/docs/api/commands/add"}
|
|
19
|
+
::card{icon="i-lucide-square-terminal" title="Commands" to="/docs/3.x/api/commands/add"}
|
|
20
20
|
List of Nuxt CLI commands to init, analyze, build, and preview your application.
|
|
21
21
|
::
|
|
22
|
-
::card{icon="i-lucide-package" title="Nuxt Kit" to="/docs/api/kit/modules"}
|
|
22
|
+
::card{icon="i-lucide-package" title="Nuxt Kit" to="/docs/3.x/api/kit/modules"}
|
|
23
23
|
Understand Nuxt Kit utilities to create modules and control Nuxt.
|
|
24
24
|
::
|
|
25
|
-
::card{icon="i-lucide-brain" title="Advanced" to="/docs/api/advanced/hooks"}
|
|
25
|
+
::card{icon="i-lucide-brain" title="Advanced" to="/docs/3.x/api/advanced/hooks"}
|
|
26
26
|
Go deep in Nuxt internals with Nuxt lifecycle hooks.
|
|
27
27
|
::
|
|
28
|
-
::card{icon="i-lucide-cog" title="Nuxt Configuration" to="/docs/api/nuxt-config"}
|
|
28
|
+
::card{icon="i-lucide-cog" title="Nuxt Configuration" to="/docs/3.x/api/nuxt-config"}
|
|
29
29
|
Explore all Nuxt configuration options to customize your application.
|
|
30
30
|
::
|
|
31
31
|
::
|
|
@@ -11,7 +11,7 @@ There is a range of different ways you might be able to contribute to the Nuxt e
|
|
|
11
11
|
The Nuxt ecosystem includes many different projects and organizations:
|
|
12
12
|
|
|
13
13
|
* [nuxt/](https://github.com/nuxt) - core repositories for the Nuxt framework itself. [**nuxt/nuxt**](https://github.com/nuxt/nuxt) contains the Nuxt framework (both versions 2 and 3).
|
|
14
|
-
* [nuxt-modules/](https://github.com/nuxt-modules) - community-contributed and maintained modules and libraries. There is a [process to migrate a module](/docs/3.x/guide/
|
|
14
|
+
* [nuxt-modules/](https://github.com/nuxt-modules) - community-contributed and maintained modules and libraries. There is a [process to migrate a module](/docs/3.x/guide/modules/ecosystem) to `nuxt-modules`. While these modules have individual maintainers, they are not dependent on a single person.
|
|
15
15
|
* [unjs/](https://github.com/unjs) - many of these libraries are used throughout the Nuxt ecosystem. They are designed to be universal libraries that are framework- and environment-agnostic. We welcome contributions and usage by other frameworks and projects.
|
|
16
16
|
|
|
17
17
|
## How To Contribute
|
|
@@ -42,7 +42,7 @@ If you're working on a feature, then we ask that you **open a feature request is
|
|
|
42
42
|
|
|
43
43
|
For typo fixes, it's recommended to batch multiple typo fixes into one pull request to maintain a cleaner commit history.
|
|
44
44
|
|
|
45
|
-
For bigger changes to Nuxt itself, we recommend that you first [create a Nuxt module](#create-a-module) and implement the feature there. This allows for quick proof-of-concept. You can then [create an RFC](#make-an-rfc) in the form of a discussion. As users adopt it and you gather feedback, it can then be refined and either added to Nuxt core or continue as a standalone module.
|
|
45
|
+
For bigger changes to Nuxt itself, we recommend that you first [create a Nuxt module](/docs/3.x/community/contribution#create-a-module) and implement the feature there. This allows for quick proof-of-concept. You can then [create an RFC](/docs/3.x/community/contribution#make-an-rfc) in the form of a discussion. As users adopt it and you gather feedback, it can then be refined and either added to Nuxt core or continue as a standalone module.
|
|
46
46
|
|
|
47
47
|
#### Commit Conventions
|
|
48
48
|
|
|
@@ -58,7 +58,7 @@ If you are working in a project with a monorepo, like `nuxt/nuxt`, ensure that y
|
|
|
58
58
|
|
|
59
59
|
If you don't know how to send a pull request, we recommend reading [the guide](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request).
|
|
60
60
|
|
|
61
|
-
When sending a pull request, make sure your PR's title also follows the [Commit Convention](#commit-conventions).
|
|
61
|
+
When sending a pull request, make sure your PR's title also follows the [Commit Convention](/docs/3.x/community/contribution#commit-conventions).
|
|
62
62
|
|
|
63
63
|
If your PR fixes or resolves existing issues, please make sure you mention them in the PR description.
|
|
64
64
|
|
|
@@ -100,13 +100,13 @@ Our aim is ensuring quality and maintaining the joy of collaborating and communi
|
|
|
100
100
|
|
|
101
101
|
### Create a Module
|
|
102
102
|
|
|
103
|
-
If you've built something with Nuxt that's cool, why not [extract it into a module](/docs/3.x/guide/
|
|
103
|
+
If you've built something with Nuxt that's cool, why not [extract it into a module](/docs/3.x/guide/modules), so it can be shared with others? We have [many excellent modules already](/modules), but there's always room for more.
|
|
104
104
|
|
|
105
105
|
If you need help while building it, feel free to [check in with us](/docs/3.x/community/getting-help).
|
|
106
106
|
|
|
107
107
|
### Make an RFC
|
|
108
108
|
|
|
109
|
-
We highly recommend [creating a module](#create-a-module) first to test out big new features and gain community adoption.
|
|
109
|
+
We highly recommend [creating a module](/docs/3.x/community/contribution#create-a-module) first to test out big new features and gain community adoption.
|
|
110
110
|
|
|
111
111
|
If you have done this already, or it's not appropriate to create a new module, then please start by creating a new discussion. Make sure it explains your thinking as clearly as possible. Include code examples or function signatures for new APIs. Reference existing issues or pain points with examples.
|
|
112
112
|
|
|
@@ -126,7 +126,7 @@ The following conventions are _required_ within the `nuxt/` organization and rec
|
|
|
126
126
|
|
|
127
127
|
#### Module Conventions
|
|
128
128
|
|
|
129
|
-
Modules should follow the [Nuxt module template](https://github.com/nuxt/starter/tree/module). See [module guide](/docs/3.x/guide/
|
|
129
|
+
Modules should follow the [Nuxt module template](https://github.com/nuxt/starter/tree/module). See [module guide](/docs/3.x/guide/modules) for more information.
|
|
130
130
|
|
|
131
131
|
#### Use Core `unjs/` Libraries
|
|
132
132
|
|
|
@@ -134,7 +134,7 @@ We recommend the following libraries which are used throughout the ecosystem:
|
|
|
134
134
|
|
|
135
135
|
* [pathe](https://github.com/unjs/pathe) - universal path utilities (replacement for node `path`)
|
|
136
136
|
* [ufo](https://github.com/unjs/ufo) - URL parsing and joining utilities
|
|
137
|
-
* [
|
|
137
|
+
* [obuild](https://github.com/unjs/obuild) - rolldown-powered build system
|
|
138
138
|
* ... check out the rest of the [unjs/](https://github.com/unjs) organization for many more!
|
|
139
139
|
|
|
140
140
|
#### Use ESM Syntax and Default to `type: module`
|
|
@@ -143,7 +143,7 @@ Most of the Nuxt ecosystem can consume ESM directly. In general we advocate that
|
|
|
143
143
|
|
|
144
144
|
#### What's Corepack
|
|
145
145
|
|
|
146
|
-
[Corepack](https://
|
|
146
|
+
[Corepack](https://github.com/nodejs/corepack) makes sure you are using the correct version for package manager when you run corresponding commands. Projects might have `packageManager` field in their `package.json`.
|
|
147
147
|
|
|
148
148
|
Under projects with configuration as shown below, Corepack will install `v7.5.0` of `pnpm` (if you don't have it already) and use it to run your commands.
|
|
149
149
|
|
|
@@ -172,7 +172,7 @@ We recommend using [VS Code](https://code.visualstudio.com) along with the [ESLi
|
|
|
172
172
|
|
|
173
173
|
#### No Prettier
|
|
174
174
|
|
|
175
|
-
Since ESLint is already configured to format the code, there is no need to duplicate the functionality with Prettier. To format the code, you can run `yarn lint --fix`, `pnpm lint --fix`, or `
|
|
175
|
+
Since ESLint is already configured to format the code, there is no need to duplicate the functionality with Prettier. To format the code, you can run `yarn lint --fix`, `pnpm lint --fix`, `bun run lint --fix`, or `deno run lint --fix` or referring the [ESLint section](/docs/3.x/community/contribution#use-eslint) for IDE Setup.
|
|
176
176
|
|
|
177
177
|
If you have Prettier installed in your editor, we recommend you disable it when working on the project to avoid conflict.
|
|
178
178
|
|
|
@@ -218,6 +218,6 @@ Here are some tips that may help improve your documentation:
|
|
|
218
218
|
Nuxt will throw an error.
|
|
219
219
|
::
|
|
220
220
|
|
|
221
|
-
::read-more{to="/docs/community/framework-contribution#documentation-guide"}
|
|
221
|
+
::read-more{to="/docs/3.x/community/framework-contribution#documentation-guide"}
|
|
222
222
|
Learn how to contribute to the documentation.
|
|
223
223
|
::
|
|
@@ -8,19 +8,19 @@ Once you've read the [general contribution guide](/docs/3.x/community/contributi
|
|
|
8
8
|
|
|
9
9
|
## Monorepo Guide
|
|
10
10
|
|
|
11
|
-
- `packages/kit`: Toolkit for authoring Nuxt
|
|
12
|
-
- `packages/nuxt`: The core of Nuxt, published as [`nuxt`](https://npmjs.com/package/nuxt).
|
|
13
|
-
- `packages/schema`: Cross-version Nuxt typedefs and defaults, published as [`@nuxt/schema`](https://npmjs.com/package/@nuxt/schema).
|
|
14
|
-
- `packages/rspack`: The [Rspack](https://rspack.
|
|
15
|
-
- `packages/vite`: The [Vite](https://vite.dev) bundler for Nuxt, published as [`@nuxt/vite-builder`](https://npmjs.com/package/@nuxt/vite-builder).
|
|
16
|
-
- `packages/webpack`: The [webpack](https://webpack.js.org) bundler for Nuxt, published as [`@nuxt/webpack-builder`](https://npmjs.com/package/@nuxt/webpack-builder).
|
|
11
|
+
- `packages/kit`: Toolkit for authoring Nuxt modules, published as [`@nuxt/kit`](https://www.npmjs.com/package/@nuxt/kit).
|
|
12
|
+
- `packages/nuxt`: The core of Nuxt, published as [`nuxt`](https://www.npmjs.com/package/nuxt).
|
|
13
|
+
- `packages/schema`: Cross-version Nuxt typedefs and defaults, published as [`@nuxt/schema`](https://www.npmjs.com/package/@nuxt/schema).
|
|
14
|
+
- `packages/rspack`: The [Rspack](https://rspack.rs) bundler for Nuxt, published as [`@nuxt/rspack-builder`](https://www.npmjs.com/package/@nuxt/rspack-builder).
|
|
15
|
+
- `packages/vite`: The [Vite](https://vite.dev) bundler for Nuxt, published as [`@nuxt/vite-builder`](https://www.npmjs.com/package/@nuxt/vite-builder).
|
|
16
|
+
- `packages/webpack`: The [webpack](https://webpack.js.org) bundler for Nuxt, published as [`@nuxt/webpack-builder`](https://www.npmjs.com/package/@nuxt/webpack-builder).
|
|
17
17
|
|
|
18
18
|
## Setup
|
|
19
19
|
|
|
20
20
|
To contribute to Nuxt, you need to set up a local environment.
|
|
21
21
|
|
|
22
|
-
1. [Fork](https://
|
|
23
|
-
2. Ensure using the latest [Node.js](https://nodejs.org/en)
|
|
22
|
+
1. [Fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo) the [`nuxt/nuxt`](https://github.com/nuxt/nuxt) repository to your own GitHub account and then [clone](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) it to your local device.
|
|
23
|
+
2. Ensure using the latest [Node.js](https://nodejs.org/en)
|
|
24
24
|
3. Enable [Corepack](https://github.com/nodejs/corepack) to have `pnpm` and `yarn`
|
|
25
25
|
```bash [Terminal]
|
|
26
26
|
corepack enable
|
|
@@ -42,7 +42,7 @@ To contribute to Nuxt, you need to set up a local environment.
|
|
|
42
42
|
git checkout -b my-new-branch
|
|
43
43
|
```
|
|
44
44
|
|
|
45
|
-
Then, test your changes against the [playground](#playground) and [test](#testing) your changes before submitting a pull request.
|
|
45
|
+
Then, test your changes against the [playground](/docs/3.x/community/framework-contribution#playground) and [test](/docs/3.x/community/framework-contribution#testing) your changes before submitting a pull request.
|
|
46
46
|
|
|
47
47
|
### Playground
|
|
48
48
|
|
package/5.community/6.roadmap.md
CHANGED
|
@@ -28,22 +28,22 @@ In roadmap below are some features we are planning or working on at the moment.
|
|
|
28
28
|
Check [Discussions](https://github.com/nuxt/nuxt/discussions) and [RFCs](https://github.com/nuxt/nuxt/discussions/categories/rfcs) for more upcoming features and ideas.
|
|
29
29
|
::
|
|
30
30
|
|
|
31
|
-
Milestone | Expected date | Notes
|
|
32
|
-
|
|
33
|
-
SEO & PWA | 2025 | [nuxt/nuxt#18395](https://github.com/nuxt/nuxt/discussions/18395)
|
|
34
|
-
Assets | 2025 | [nuxt/nuxt#22012](https://github.com/nuxt/nuxt/discussions/22012)
|
|
35
|
-
Translations | - | [nuxt/
|
|
31
|
+
| Milestone | Expected date | Notes | Description |
|
|
32
|
+
|--------------|---------------|--------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------|
|
|
33
|
+
| SEO & PWA | 2025 | [nuxt/nuxt#18395](https://github.com/nuxt/nuxt/discussions/18395) | Migrating from [nuxt-community/pwa-module](https://github.com/nuxt-community/pwa-module) for built-in SEO utils and service worker support |
|
|
34
|
+
| Assets | 2025 | [nuxt/nuxt#22012](https://github.com/nuxt/nuxt/discussions/22012) | Allow developers and modules to handle loading third-party assets. |
|
|
35
|
+
| Translations | - | [nuxt/nuxt.com#1711](https://github.com/nuxt/nuxt.com/issues/1711) | A collaborative project for a stable translation process for Nuxt docs. Currently pending for ideas and documentation tooling support. |
|
|
36
36
|
|
|
37
37
|
## Core Modules Roadmap
|
|
38
38
|
|
|
39
39
|
In addition to the Nuxt framework, there are modules that are vital for the ecosystem. Their status will be updated below.
|
|
40
40
|
|
|
41
|
-
Module
|
|
42
|
-
|
|
43
|
-
[Scripts](https://scripts.nuxt.com)
|
|
44
|
-
Auth Utils
|
|
45
|
-
|
|
46
|
-
Hints
|
|
41
|
+
| Module | Status | Nuxt Support | Repository | Description |
|
|
42
|
+
|----------------------------------------|--------------|--------------|-------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
43
|
+
| [Scripts](https://scripts.nuxt.com) | Public Beta | 3.x, 4.x | [nuxt/scripts](https://github.com/nuxt/scripts) | Easy 3rd party script management. |
|
|
44
|
+
| Auth Utils | Planned | 4.x, 5.x | `nuxt/auth-utils` to be announced | The temporary repository [atinux/nuxt-auth-utils](https://github.com/atinux/nuxt-auth-utils) is available while awaiting its official integration into Nuxt via RFC. |
|
|
45
|
+
| [a11y](https://github.com/nuxt/a11y) | Public Alpha | 3.x, 4.x | [nuxt/a11y](https://github.com/nuxt/a11y). | Real-time accessibility feedback and automated testing in your browser during development (see [nuxt/nuxt#23255](https://github.com/nuxt/nuxt/issues/23255)). |
|
|
46
|
+
| [Hints](https://github.com/nuxt/hints) | Public Alpha | 4.x, 5.x | [nuxt/hints](https://github.com/nuxt/hints) | Guidance and suggestions for enhancing development practices. |
|
|
47
47
|
|
|
48
48
|
## Release Cycle
|
|
49
49
|
|
|
@@ -65,20 +65,20 @@ Nuxt 3 will continue to receive maintenance updates (both bug fixes and backport
|
|
|
65
65
|
|
|
66
66
|
Each active version has its own nightly releases which are generated automatically. For more about enabling the Nuxt nightly release channel, see [the nightly release channel docs](/docs/3.x/guide/going-further/nightly-release-channel).
|
|
67
67
|
|
|
68
|
-
Release
|
|
69
|
-
|
|
70
|
-
**5.x** (scheduled)
|
|
71
|
-
**4.x** (stable)
|
|
72
|
-
**3.x** (maintenance)
|
|
73
|
-
**2.x** (unsupported)
|
|
74
|
-
**1.x** (unsupported)
|
|
68
|
+
| Release | | Initial release | End Of Life | Docs |
|
|
69
|
+
|-----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------|----------------------------|-------------------------------------------------------------------|
|
|
70
|
+
| **5.x** (scheduled) | | Q4 2025 (estimated) | TBA | |
|
|
71
|
+
| **4.x** (stable) | <a href="https://www.npmjs.com/package/nuxt?activeTab=versions"><img alt="Nuxt latest version" src="https://img.shields.io/npm/v/nuxt.svg?logo=nuxt&label=&style=flat&colorA=18181B&colorB=28CF8D" class="not-prose h-5 w-auto" :zoom="false"></a> | 2025-07-16 | 6 months after 5.x release | [nuxt.com](/docs/3.x/getting-started/introduction) |
|
|
72
|
+
| **3.x** (maintenance) | <a href="https://www.npmjs.com/package/nuxt?activeTab=versions"><img alt="Nuxt 3.x version" src="https://img.shields.io/npm/v/nuxt/3x.svg?logo=nuxt&label=&style=flat&colorA=18181B&colorB=28CF8D" class="not-prose h-5 w-auto" :zoom="false"></a> | 2022-11-16 | 2026-01-31 | [nuxt.com](/docs/3.x/getting-started/introduction) |
|
|
73
|
+
| **2.x** (unsupported) | <a href="https://www.npmjs.com/package/nuxt?activeTab=versions"><img alt="Nuxt 2.x version" src="https://img.shields.io/npm/v/nuxt/2x.svg?logo=nuxt&label=&style=flat&colorA=18181B&colorB=28CF8D" class="not-prose h-5 w-auto" :zoom="false"></a> | 2018-09-21 | 2024-06-30 | [v2.nuxt.com](https://v2.nuxt.com/docs/get-started/installation/) |
|
|
74
|
+
| **1.x** (unsupported) | <a href="https://www.npmjs.com/package/nuxt?activeTab=versions"><img alt="Nuxt 1.x version" src="https://img.shields.io/npm/v/nuxt/1x.svg?logo=nuxt&label=&style=flat&colorA=18181B&colorB=28CF8D" class="not-prose h-5 w-auto" :zoom="false"></a> | 2018-01-08 | 2019-09-21 | |
|
|
75
75
|
|
|
76
76
|
### Support Status
|
|
77
77
|
|
|
78
|
-
Status | Description
|
|
79
|
-
|
|
80
|
-
Unsupported | This version is not maintained any more and will not receive security patches
|
|
81
|
-
Maintenance | This version will only receive security patches
|
|
82
|
-
Stable | This version is being developed for and will receive security patches
|
|
83
|
-
Development | This version could be unstable
|
|
84
|
-
Scheduled | This version does not exist yet but is planned
|
|
78
|
+
| Status | Description |
|
|
79
|
+
|-------------|-------------------------------------------------------------------------------|
|
|
80
|
+
| Unsupported | This version is not maintained any more and will not receive security patches |
|
|
81
|
+
| Maintenance | This version will only receive security patches |
|
|
82
|
+
| Stable | This version is being developed for and will receive security patches |
|
|
83
|
+
| Development | This version could be unstable |
|
|
84
|
+
| Scheduled | This version does not exist yet but is planned |
|
|
@@ -28,6 +28,16 @@ navigation.icon: i-lucide-bell-dot
|
|
|
28
28
|
::card
|
|
29
29
|
---
|
|
30
30
|
icon: i-simple-icons-github
|
|
31
|
+
title: nuxt/a11y
|
|
32
|
+
to: https://github.com/nuxt/a11y/releases
|
|
33
|
+
target: _blank
|
|
34
|
+
ui.icon.base: text-black dark:text-white
|
|
35
|
+
---
|
|
36
|
+
Nuxt A11y releases.
|
|
37
|
+
::
|
|
38
|
+
::card
|
|
39
|
+
---
|
|
40
|
+
icon: i-simple-icons-github
|
|
31
41
|
title: nuxt/content
|
|
32
42
|
to: https://github.com/nuxt/content/releases
|
|
33
43
|
target: _blank
|
|
@@ -58,6 +68,16 @@ navigation.icon: i-lucide-bell-dot
|
|
|
58
68
|
::card
|
|
59
69
|
---
|
|
60
70
|
icon: i-simple-icons-github
|
|
71
|
+
title: nuxt/hints
|
|
72
|
+
to: https://github.com/nuxt/hints/releases
|
|
73
|
+
target: _blank
|
|
74
|
+
ui.icon.base: text-black dark:text-white
|
|
75
|
+
---
|
|
76
|
+
Nuxt Hints releases.
|
|
77
|
+
::
|
|
78
|
+
::card
|
|
79
|
+
---
|
|
80
|
+
icon: i-simple-icons-github
|
|
61
81
|
title: nuxt/image
|
|
62
82
|
to: https://github.com/nuxt/image/releases
|
|
63
83
|
target: _blank
|
package/6.bridge/1.overview.md
CHANGED
|
@@ -46,6 +46,10 @@ pnpm install
|
|
|
46
46
|
bun install
|
|
47
47
|
```
|
|
48
48
|
|
|
49
|
+
```bash [deno]
|
|
50
|
+
deno install
|
|
51
|
+
```
|
|
52
|
+
|
|
49
53
|
::
|
|
50
54
|
|
|
51
55
|
::note
|
|
@@ -74,13 +78,17 @@ pnpm add -D @nuxt/bridge nuxi
|
|
|
74
78
|
bun add -D @nuxt/bridge nuxi
|
|
75
79
|
```
|
|
76
80
|
|
|
81
|
+
```bash [deno]
|
|
82
|
+
deno add -D npm:@nuxt/bridge npm:nuxi
|
|
83
|
+
```
|
|
84
|
+
|
|
77
85
|
::
|
|
78
86
|
|
|
79
87
|
### Update `nuxt.config`
|
|
80
88
|
|
|
81
89
|
Please make sure to avoid any CommonJS syntax such as `module.exports`, `require` or `require.resolve` in your config file. It will soon be deprecated and unsupported.
|
|
82
90
|
|
|
83
|
-
You can use static `import`, dynamic `import()` and `export default` instead. Using TypeScript by renaming to [`nuxt.config.ts`](/docs/3.x/
|
|
91
|
+
You can use static `import`, dynamic `import()` and `export default` instead. Using TypeScript by renaming to [`nuxt.config.ts`](/docs/3.x/directory-structure/nuxt-config) is also possible and recommended.
|
|
84
92
|
|
|
85
93
|
```ts [nuxt.config.ts]
|
|
86
94
|
import { defineNuxtConfig } from '@nuxt/bridge'
|
|
@@ -91,7 +91,7 @@ export default <Middleware> function (ctx) { }
|
|
|
91
91
|
|
|
92
92
|
This was a type-helper stub function that is now removed.
|
|
93
93
|
|
|
94
|
-
You may also keep using Nuxt 2-style plugins, by removing the function (as with [defineNuxtMiddleware](#definenuxtmiddleware)).
|
|
94
|
+
You may also keep using Nuxt 2-style plugins, by removing the function (as with [defineNuxtMiddleware](/docs/3.x/bridge/bridge-composition-api#definenuxtmiddleware)).
|
|
95
95
|
|
|
96
96
|
Remove the `defineNuxtPlugin` wrapper:
|
|
97
97
|
|
|
@@ -113,7 +113,7 @@ export default <Plugin> function (ctx, inject) {}
|
|
|
113
113
|
While this example is valid, Nuxt 3 introduces a new defineNuxtPlugin function that has a slightly different signature.
|
|
114
114
|
::
|
|
115
115
|
|
|
116
|
-
:ReadMore{link="/docs/
|
|
116
|
+
:ReadMore{link="/docs/3.x/directory-structure/plugins#creating-plugins"}
|
|
117
117
|
|
|
118
118
|
### `useRouter` and `useRoute`
|
|
119
119
|
|
|
@@ -7,7 +7,7 @@ description: 'Learn how to migrate from Nuxt 2 to Nuxt Bridge new plugins and mi
|
|
|
7
7
|
|
|
8
8
|
You can now migrate to the Nuxt 3 plugins API, which is slightly different in format from Nuxt 2.
|
|
9
9
|
|
|
10
|
-
Plugins now take only one argument (`nuxtApp`). You can find out more in [the docs](/docs/3.x/
|
|
10
|
+
Plugins now take only one argument (`nuxtApp`). You can find out more in [the docs](/docs/3.x/directory-structure/plugins).
|
|
11
11
|
|
|
12
12
|
```ts [plugins/hello.ts]
|
|
13
13
|
export default defineNuxtPlugin((nuxtApp) => {
|
|
@@ -28,7 +28,7 @@ Although a compatibility interface is provided via `nuxtApp.vueApp` you should a
|
|
|
28
28
|
|
|
29
29
|
You can now migrate to the Nuxt 3 middleware API, which is slightly different in format from Nuxt 2.
|
|
30
30
|
|
|
31
|
-
Middleware now take only two argument (`to`, `from`). You can find out more in [the docs](/docs/3.x/
|
|
31
|
+
Middleware now take only two argument (`to`, `from`). You can find out more in [the docs](/docs/3.x/directory-structure/middleware).
|
|
32
32
|
|
|
33
33
|
```ts twoslash
|
|
34
34
|
export default defineNuxtRouteMiddleware((to) => {
|
|
@@ -39,14 +39,14 @@ export default defineNuxtRouteMiddleware((to) => {
|
|
|
39
39
|
```
|
|
40
40
|
|
|
41
41
|
::important
|
|
42
|
-
Use of `defineNuxtRouteMiddleware` is not supported outside of the middleware directory.
|
|
42
|
+
Use of `defineNuxtRouteMiddleware` is not supported outside of the `middleware` directory.
|
|
43
43
|
::
|
|
44
44
|
|
|
45
45
|
## definePageMeta
|
|
46
46
|
|
|
47
47
|
You can also use [`definePageMeta`](/docs/3.x/api/utils/define-page-meta) in Nuxt Bridge.
|
|
48
48
|
|
|
49
|
-
|
|
49
|
+
It can be enabled with the `macros.pageMeta` option in your configuration file
|
|
50
50
|
|
|
51
51
|
```ts [nuxt.config.ts]
|
|
52
52
|
import { defineNuxtConfig } from '@nuxt/bridge'
|
|
@@ -204,4 +204,4 @@ export default defineNuxtConfig({
|
|
|
204
204
|
})
|
|
205
205
|
```
|
|
206
206
|
|
|
207
|
-
This will disable auto-imports completely but it's still possible to use [explicit imports](#explicit-imports) from `#imports`.
|
|
207
|
+
This will disable auto-imports completely but it's still possible to use [explicit imports](/docs/3.x/bridge/nuxt3-compatible-api#explicit-imports) from `#imports`.
|
package/6.bridge/8.nitro.md
CHANGED
|
@@ -16,7 +16,7 @@ If you need to configure any of Nuxt's build tools, you can do so in your `nuxt.
|
|
|
16
16
|
|
|
17
17
|
In addition, Nuxt ships with TypeScript support.
|
|
18
18
|
|
|
19
|
-
:read-more{to="/docs/guide/concepts/typescript"}
|
|
19
|
+
:read-more{to="/docs/3.x/guide/concepts/typescript"}
|
|
20
20
|
|
|
21
21
|
## Steps
|
|
22
22
|
|
package/7.migration/11.server.md
CHANGED
|
@@ -5,7 +5,7 @@ description: 'Learn how to migrate from Nuxt 2 to Nuxt 3 server.'
|
|
|
5
5
|
|
|
6
6
|
In a built Nuxt 3 application, there is no runtime Nuxt dependency. That means your site will be highly performant, and ultra-slim. But it also means you can no longer hook into runtime Nuxt server hooks.
|
|
7
7
|
|
|
8
|
-
:read-more{to="/docs/guide/concepts/server-engine"}
|
|
8
|
+
:read-more{to="/docs/3.x/guide/concepts/server-engine"}
|
|
9
9
|
|
|
10
10
|
## Steps
|
|
11
11
|
|
|
@@ -13,5 +13,5 @@ In a built Nuxt 3 application, there is no runtime Nuxt dependency. That means y
|
|
|
13
13
|
2. Any files in `~/server/api` and `~/server/middleware` will be automatically registered; you can remove them from your `serverMiddleware` array.
|
|
14
14
|
3. Update any other items in your `serverMiddleware` array to point to files or npm packages directly, rather than using inline functions.
|
|
15
15
|
|
|
16
|
-
:read-more{to="/docs/
|
|
17
|
-
:read-more{to="/docs/guide/going-further/hooks#server-hooks-runtime"}
|
|
16
|
+
:read-more{to="/docs/3.x/directory-structure/server"}
|
|
17
|
+
:read-more{to="/docs/3.x/guide/going-further/hooks#server-hooks-runtime"}
|