@nuxt/docs 4.2.0 → 4.2.2

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.
Files changed (241) hide show
  1. package/1.getting-started/01.introduction.md +1 -1
  2. package/1.getting-started/02.installation.md +3 -3
  3. package/1.getting-started/03.configuration.md +27 -27
  4. package/1.getting-started/04.views.md +5 -5
  5. package/1.getting-started/05.assets.md +8 -8
  6. package/1.getting-started/06.styling.md +15 -15
  7. package/1.getting-started/07.routing.md +10 -6
  8. package/1.getting-started/08.seo-meta.md +3 -3
  9. package/1.getting-started/09.transitions.md +10 -10
  10. package/1.getting-started/10.data-fetching.md +16 -16
  11. package/1.getting-started/11.state-management.md +3 -3
  12. package/1.getting-started/12.error-handling.md +6 -6
  13. package/1.getting-started/13.server.md +6 -6
  14. package/1.getting-started/14.layers.md +32 -13
  15. package/1.getting-started/16.deployment.md +1 -1
  16. package/1.getting-started/17.testing.md +35 -4
  17. package/1.getting-started/18.upgrade.md +42 -34
  18. package/{2.guide/1.directory-structure → 2.directory-structure}/0.nuxt.md +1 -1
  19. package/{2.guide/1.directory-structure → 2.directory-structure}/0.output.md +1 -1
  20. package/{2.guide/1.directory-structure → 2.directory-structure}/1.app/1.assets.md +2 -2
  21. package/{2.guide/1.directory-structure → 2.directory-structure}/1.app/1.components.md +6 -6
  22. package/{2.guide/1.directory-structure → 2.directory-structure}/1.app/1.composables.md +2 -2
  23. package/{2.guide/1.directory-structure → 2.directory-structure}/1.app/1.layouts.md +3 -3
  24. package/{2.guide/1.directory-structure → 2.directory-structure}/1.app/1.middleware.md +5 -5
  25. package/{2.guide/1.directory-structure → 2.directory-structure}/1.app/1.pages.md +17 -17
  26. package/{2.guide/1.directory-structure → 2.directory-structure}/1.app/1.plugins.md +3 -7
  27. package/{2.guide/1.directory-structure → 2.directory-structure}/1.app/1.utils.md +3 -3
  28. package/{2.guide/1.directory-structure → 2.directory-structure}/1.app/3.app.md +4 -4
  29. package/{2.guide/1.directory-structure → 2.directory-structure}/1.app/3.error.md +1 -3
  30. package/{2.guide/1.directory-structure → 2.directory-structure}/1.content.md +2 -2
  31. package/{2.guide/1.directory-structure → 2.directory-structure}/1.modules.md +1 -1
  32. package/{2.guide/1.directory-structure → 2.directory-structure}/1.node_modules.md +2 -2
  33. package/{2.guide/1.directory-structure → 2.directory-structure}/1.public.md +1 -1
  34. package/{2.guide/1.directory-structure → 2.directory-structure}/1.server.md +7 -7
  35. package/{2.guide/1.directory-structure → 2.directory-structure}/1.shared.md +3 -3
  36. package/{2.guide/1.directory-structure → 2.directory-structure}/2.env.md +2 -2
  37. package/{2.guide/1.directory-structure → 2.directory-structure}/2.nuxtignore.md +1 -1
  38. package/{2.guide/1.directory-structure → 2.directory-structure}/2.nuxtrc.md +1 -1
  39. package/{2.guide/1.directory-structure → 2.directory-structure}/3.nuxt-config.md +1 -1
  40. package/{2.guide/1.directory-structure → 2.directory-structure}/3.package.md +1 -1
  41. package/2.directory-structure/3.tsconfig.md +69 -0
  42. package/2.directory-structure/index.md +61 -0
  43. package/{2.guide → 3.guide}/0.index.md +4 -7
  44. package/{2.guide/2.concepts/3.rendering.md → 3.guide/1.concepts/1.rendering.md} +4 -30
  45. package/{2.guide/2.concepts/2.vuejs-development.md → 3.guide/1.concepts/10.vuejs-development.md} +7 -6
  46. package/{2.guide/2.concepts/10.nuxt-lifecycle.md → 3.guide/1.concepts/2.nuxt-lifecycle.md} +32 -25
  47. package/{2.guide/2.concepts/1.auto-imports.md → 3.guide/1.concepts/3.auto-imports.md} +7 -7
  48. package/{2.guide/2.concepts → 3.guide/1.concepts}/4.server-engine.md +3 -3
  49. package/{2.guide/2.concepts → 3.guide/1.concepts}/5.modules.md +1 -1
  50. package/{2.guide/2.concepts → 3.guide/1.concepts}/7.esm.md +3 -2
  51. package/{2.guide/2.concepts → 3.guide/1.concepts}/8.typescript.md +15 -38
  52. package/{2.guide/2.concepts → 3.guide/1.concepts}/9.code-style.md +1 -1
  53. package/{2.guide/5.best-practices → 3.guide/2.best-practices}/hydration.md +1 -1
  54. package/{2.guide/5.best-practices → 3.guide/2.best-practices}/performance.md +2 -2
  55. package/3.guide/3.ai/.navigation.yml +3 -0
  56. package/3.guide/3.ai/1.mcp.md +255 -0
  57. package/3.guide/3.ai/2.llms-txt.md +65 -0
  58. package/{2.guide → 3.guide}/4.recipes/1.custom-routing.md +5 -5
  59. package/{2.guide → 3.guide}/4.recipes/2.vite-plugin.md +1 -1
  60. package/{2.guide → 3.guide}/4.recipes/3.custom-usefetch.md +1 -1
  61. package/{2.guide → 3.guide}/4.recipes/4.sessions-and-authentication.md +1 -1
  62. package/{2.guide/3.going-further → 3.guide/5.going-further}/1.events.md +2 -3
  63. package/{2.guide/3.going-further → 3.guide/5.going-further}/1.experimental-features.md +10 -10
  64. package/{2.guide/3.going-further → 3.guide/5.going-further}/1.features.md +1 -1
  65. package/{2.guide/3.going-further → 3.guide/5.going-further}/1.internals.md +3 -2
  66. package/{2.guide/3.going-further → 3.guide/5.going-further}/10.runtime-config.md +2 -2
  67. package/{2.guide/3.going-further → 3.guide/5.going-further}/2.hooks.md +2 -2
  68. package/{2.guide/3.going-further → 3.guide/5.going-further}/3.modules.md +78 -11
  69. package/{2.guide/3.going-further → 3.guide/5.going-further}/6.nuxt-app.md +5 -5
  70. package/{2.guide/3.going-further → 3.guide/5.going-further}/7.layers.md +42 -25
  71. package/{2.guide/3.going-further → 3.guide/5.going-further}/9.debugging.md +1 -1
  72. package/{3.api → 4.api}/1.components/10.nuxt-picture.md +1 -1
  73. package/{3.api → 4.api}/1.components/11.teleports.md +1 -1
  74. package/{3.api → 4.api}/1.components/12.nuxt-route-announcer.md +1 -3
  75. package/{3.api → 4.api}/1.components/13.nuxt-time.md +0 -2
  76. package/{3.api → 4.api}/1.components/2.nuxt-page.md +3 -3
  77. package/{3.api → 4.api}/1.components/3.nuxt-layout.md +5 -5
  78. package/{3.api → 4.api}/1.components/4.nuxt-link.md +11 -11
  79. package/{3.api → 4.api}/1.components/5.nuxt-loading-indicator.md +1 -1
  80. package/{3.api → 4.api}/1.components/6.nuxt-error-boundary.md +1 -1
  81. package/{3.api → 4.api}/1.components/7.nuxt-welcome.md +2 -2
  82. package/{3.api → 4.api}/2.composables/use-app-config.md +1 -1
  83. package/{3.api → 4.api}/2.composables/use-async-data.md +76 -13
  84. package/4.api/2.composables/use-cookie.md +183 -0
  85. package/{3.api → 4.api}/2.composables/use-fetch.md +33 -33
  86. package/{3.api → 4.api}/2.composables/use-head-safe.md +37 -20
  87. package/4.api/2.composables/use-head.md +169 -0
  88. package/{3.api → 4.api}/2.composables/use-hydration.md +24 -18
  89. package/4.api/2.composables/use-lazy-async-data.md +96 -0
  90. package/4.api/2.composables/use-lazy-fetch.md +111 -0
  91. package/{3.api → 4.api}/2.composables/use-nuxt-app.md +7 -7
  92. package/{3.api → 4.api}/2.composables/use-nuxt-data.md +1 -1
  93. package/{3.api → 4.api}/2.composables/use-request-fetch.md +1 -1
  94. package/{3.api → 4.api}/2.composables/use-response-header.md +1 -1
  95. package/{3.api → 4.api}/2.composables/use-route-announcer.md +0 -2
  96. package/{3.api → 4.api}/2.composables/use-route.md +2 -2
  97. package/4.api/2.composables/use-router.md +94 -0
  98. package/{3.api → 4.api}/2.composables/use-runtime-config.md +1 -1
  99. package/{3.api → 4.api}/2.composables/use-runtime-hook.md +1 -1
  100. package/{3.api → 4.api}/2.composables/use-state.md +1 -1
  101. package/{3.api → 4.api}/3.utils/$fetch.md +1 -1
  102. package/{3.api → 4.api}/3.utils/abort-navigation.md +3 -3
  103. package/{3.api → 4.api}/3.utils/add-route-middleware.md +1 -1
  104. package/{3.api → 4.api}/3.utils/call-once.md +0 -2
  105. package/{3.api → 4.api}/3.utils/define-lazy-hydration-component.md +4 -4
  106. package/{3.api → 4.api}/3.utils/define-nuxt-component.md +1 -1
  107. package/4.api/3.utils/define-nuxt-plugin.md +102 -0
  108. package/{3.api → 4.api}/3.utils/define-nuxt-route-middleware.md +2 -2
  109. package/{3.api → 4.api}/3.utils/define-page-meta.md +14 -14
  110. package/{3.api → 4.api}/3.utils/navigate-to.md +15 -15
  111. package/{3.api → 4.api}/3.utils/on-before-route-leave.md +1 -1
  112. package/{3.api → 4.api}/3.utils/on-before-route-update.md +1 -1
  113. package/{3.api → 4.api}/3.utils/refresh-cookie.md +1 -3
  114. package/{3.api → 4.api}/3.utils/update-app-config.md +2 -2
  115. package/{3.api → 4.api}/4.commands/add.md +10 -10
  116. package/4.api/4.commands/analyze.md +42 -0
  117. package/4.api/4.commands/build-module.md +42 -0
  118. package/4.api/4.commands/build.md +47 -0
  119. package/{3.api → 4.api}/4.commands/cleanup.md +6 -6
  120. package/4.api/4.commands/dev.md +60 -0
  121. package/{3.api → 4.api}/4.commands/devtools.md +7 -7
  122. package/4.api/4.commands/generate.md +42 -0
  123. package/4.api/4.commands/info.md +33 -0
  124. package/4.api/4.commands/init.md +50 -0
  125. package/4.api/4.commands/module.md +84 -0
  126. package/4.api/4.commands/prepare.md +41 -0
  127. package/4.api/4.commands/preview.md +44 -0
  128. package/4.api/4.commands/test.md +40 -0
  129. package/4.api/4.commands/typecheck.md +44 -0
  130. package/4.api/4.commands/upgrade.md +37 -0
  131. package/{3.api → 4.api}/5.kit/1.modules.md +18 -18
  132. package/{3.api → 4.api}/5.kit/10.templates.md +23 -23
  133. package/{3.api → 4.api}/5.kit/11.nitro.md +35 -35
  134. package/{3.api → 4.api}/5.kit/14.builder.md +21 -21
  135. package/{3.api → 4.api}/5.kit/16.layers.md +12 -12
  136. package/{3.api → 4.api}/5.kit/2.programmatic.md +2 -2
  137. package/{3.api → 4.api}/5.kit/4.autoimports.md +18 -18
  138. package/4.api/5.kit/5.components.md +146 -0
  139. package/4.api/6.advanced/1.hooks.md +105 -0
  140. package/{3.api → 4.api}/6.nuxt-config.md +29 -28
  141. package/5.community/3.reporting-bugs.md +1 -1
  142. package/5.community/4.contribution.md +1 -1
  143. package/5.community/5.framework-contribution.md +8 -8
  144. package/5.community/6.roadmap.md +25 -25
  145. package/5.community/7.changelog.md +10 -0
  146. package/6.bridge/1.overview.md +1 -1
  147. package/6.bridge/2.typescript.md +1 -1
  148. package/6.bridge/3.bridge-composition-api.md +1 -1
  149. package/6.bridge/4.plugins-and-middleware.md +2 -2
  150. package/7.migration/11.server.md +1 -1
  151. package/7.migration/2.configuration.md +3 -3
  152. package/7.migration/20.module-authors.md +1 -1
  153. package/7.migration/3.auto-imports.md +1 -1
  154. package/7.migration/5.plugins-and-middleware.md +2 -2
  155. package/7.migration/6.pages-and-layouts.md +6 -6
  156. package/README.md +1 -1
  157. package/package.json +1 -1
  158. package/2.guide/1.directory-structure/3.tsconfig.md +0 -38
  159. package/3.api/2.composables/use-cookie.md +0 -183
  160. package/3.api/2.composables/use-head.md +0 -69
  161. package/3.api/2.composables/use-lazy-async-data.md +0 -47
  162. package/3.api/2.composables/use-lazy-fetch.md +0 -55
  163. package/3.api/2.composables/use-router.md +0 -94
  164. package/3.api/3.utils/define-nuxt-plugin.md +0 -102
  165. package/3.api/4.commands/analyze.md +0 -42
  166. package/3.api/4.commands/build-module.md +0 -42
  167. package/3.api/4.commands/build.md +0 -47
  168. package/3.api/4.commands/dev.md +0 -60
  169. package/3.api/4.commands/generate.md +0 -42
  170. package/3.api/4.commands/info.md +0 -33
  171. package/3.api/4.commands/init.md +0 -50
  172. package/3.api/4.commands/module.md +0 -84
  173. package/3.api/4.commands/prepare.md +0 -41
  174. package/3.api/4.commands/preview.md +0 -44
  175. package/3.api/4.commands/test.md +0 -40
  176. package/3.api/4.commands/typecheck.md +0 -44
  177. package/3.api/4.commands/upgrade.md +0 -37
  178. package/3.api/5.kit/5.components.md +0 -146
  179. package/3.api/6.advanced/1.hooks.md +0 -105
  180. /package/{2.guide/1.directory-structure → 2.directory-structure}/.navigation.yml +0 -0
  181. /package/{2.guide/1.directory-structure → 2.directory-structure}/1.app/.navigation.yml +0 -0
  182. /package/{2.guide/1.directory-structure → 2.directory-structure}/1.app/3.app-config.md +0 -0
  183. /package/{2.guide/1.directory-structure → 2.directory-structure}/2.gitignore.md +0 -0
  184. /package/{2.guide → 3.guide}/.navigation.yml +0 -0
  185. /package/{2.guide/2.concepts → 3.guide/1.concepts}/.navigation.yml +0 -0
  186. /package/{2.guide/5.best-practices → 3.guide/2.best-practices}/.navigation.yml +0 -0
  187. /package/{2.guide/5.best-practices → 3.guide/2.best-practices}/plugins.md +0 -0
  188. /package/{2.guide → 3.guide}/4.recipes/.navigation.yml +0 -0
  189. /package/{2.guide/3.going-further → 3.guide/5.going-further}/.navigation.yml +0 -0
  190. /package/{2.guide/3.going-further → 3.guide/5.going-further}/11.nightly-release-channel.md +0 -0
  191. /package/{2.guide/3.going-further → 3.guide/5.going-further}/4.kit.md +0 -0
  192. /package/{2.guide/3.going-further → 3.guide/5.going-further}/index.md +0 -0
  193. /package/{3.api → 4.api}/.navigation.yml +0 -0
  194. /package/{3.api → 4.api}/1.components/.navigation.yml +0 -0
  195. /package/{3.api → 4.api}/1.components/1.client-only.md +0 -0
  196. /package/{3.api → 4.api}/1.components/1.dev-only.md +0 -0
  197. /package/{3.api → 4.api}/1.components/1.nuxt-client-fallback.md +0 -0
  198. /package/{3.api → 4.api}/1.components/8.nuxt-island.md +0 -0
  199. /package/{3.api → 4.api}/1.components/9.nuxt-img.md +0 -0
  200. /package/{3.api → 4.api}/2.composables/.navigation.yml +0 -0
  201. /package/{3.api → 4.api}/2.composables/on-prehydrate.md +0 -0
  202. /package/{3.api → 4.api}/2.composables/use-error.md +0 -0
  203. /package/{3.api → 4.api}/2.composables/use-loading-indicator.md +0 -0
  204. /package/{3.api → 4.api}/2.composables/use-preview-mode.md +0 -0
  205. /package/{3.api → 4.api}/2.composables/use-request-event.md +0 -0
  206. /package/{3.api → 4.api}/2.composables/use-request-header.md +0 -0
  207. /package/{3.api → 4.api}/2.composables/use-request-headers.md +0 -0
  208. /package/{3.api → 4.api}/2.composables/use-request-url.md +0 -0
  209. /package/{3.api → 4.api}/2.composables/use-seo-meta.md +0 -0
  210. /package/{3.api → 4.api}/2.composables/use-server-seo-meta.md +0 -0
  211. /package/{3.api → 4.api}/3.utils/.navigation.yml +0 -0
  212. /package/{3.api → 4.api}/3.utils/clear-error.md +0 -0
  213. /package/{3.api → 4.api}/3.utils/clear-nuxt-data.md +0 -0
  214. /package/{3.api → 4.api}/3.utils/clear-nuxt-state.md +0 -0
  215. /package/{3.api → 4.api}/3.utils/create-error.md +0 -0
  216. /package/{3.api → 4.api}/3.utils/define-route-rules.md +0 -0
  217. /package/{3.api → 4.api}/3.utils/on-nuxt-ready.md +0 -0
  218. /package/{3.api → 4.api}/3.utils/prefetch-components.md +0 -0
  219. /package/{3.api → 4.api}/3.utils/preload-components.md +0 -0
  220. /package/{3.api → 4.api}/3.utils/preload-route-components.md +0 -0
  221. /package/{3.api → 4.api}/3.utils/prerender-routes.md +0 -0
  222. /package/{3.api → 4.api}/3.utils/refresh-nuxt-data.md +0 -0
  223. /package/{3.api → 4.api}/3.utils/reload-nuxt-app.md +0 -0
  224. /package/{3.api → 4.api}/3.utils/set-page-layout.md +0 -0
  225. /package/{3.api → 4.api}/3.utils/set-response-status.md +0 -0
  226. /package/{3.api → 4.api}/3.utils/show-error.md +0 -0
  227. /package/{3.api → 4.api}/4.commands/.navigation.yml +0 -0
  228. /package/{3.api → 4.api}/5.kit/.navigation.yml +0 -0
  229. /package/{3.api → 4.api}/5.kit/10.runtime-config.md +0 -0
  230. /package/{3.api → 4.api}/5.kit/12.resolving.md +0 -0
  231. /package/{3.api → 4.api}/5.kit/13.logging.md +0 -0
  232. /package/{3.api → 4.api}/5.kit/15.examples.md +0 -0
  233. /package/{3.api → 4.api}/5.kit/3.compatibility.md +0 -0
  234. /package/{3.api → 4.api}/5.kit/6.context.md +0 -0
  235. /package/{3.api → 4.api}/5.kit/7.pages.md +0 -0
  236. /package/{3.api → 4.api}/5.kit/8.layout.md +0 -0
  237. /package/{3.api → 4.api}/5.kit/9.head.md +0 -0
  238. /package/{3.api → 4.api}/5.kit/9.plugins.md +0 -0
  239. /package/{3.api → 4.api}/6.advanced/.navigation.yml +0 -0
  240. /package/{3.api → 4.api}/6.advanced/2.import-meta.md +0 -0
  241. /package/{3.api → 4.api}/index.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/4.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/4.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/4.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 |
@@ -202,7 +202,7 @@ This can be overridden with `definePageMeta` on an individual page. Only JSON-se
202
202
  - **Type**: `boolean`
203
203
  - **Default:** `false`
204
204
 
205
- **See**: [Vue KeepAlive](https://vuejs.org/api/built-in-components.html#keepalive)
205
+ **See**: [Vue KeepAlive](https://vuejs.org/api/built-in-components#keepalive)
206
206
 
207
207
  ### `layoutTransition`
208
208
 
@@ -213,7 +213,7 @@ This can be overridden with `definePageMeta` on an individual page. Only JSON-se
213
213
  - **Type**: `boolean`
214
214
  - **Default:** `false`
215
215
 
216
- **See**: [Vue Transition docs](https://vuejs.org/api/built-in-components.html#transition)
216
+ **See**: [Vue Transition docs](https://vuejs.org/api/built-in-components#transition)
217
217
 
218
218
  ### `pageTransition`
219
219
 
@@ -224,7 +224,7 @@ This can be overridden with `definePageMeta` on an individual page. Only JSON-se
224
224
  - **Type**: `boolean`
225
225
  - **Default:** `false`
226
226
 
227
- **See**: [Vue Transition docs](https://vuejs.org/api/built-in-components.html#transition)
227
+ **See**: [Vue Transition docs](https://vuejs.org/api/built-in-components#transition)
228
228
 
229
229
  ### `rootAttrs`
230
230
 
@@ -339,7 +339,7 @@ Shared build configuration.
339
339
 
340
340
  Nuxt allows visualizing your bundles and how to optimize them.
341
341
 
342
- Set to `true` to enable bundle analysis, or pass an object with options: [for webpack](https://github.com/webpack-contrib/webpack-bundle-analyzer#options-for-plugin) or [for vite](https://github.com/btd/rollup-plugin-visualizer#options).
342
+ Set to `true` to enable bundle analysis, or pass an object with options: [for webpack](https://github.com/webpack/webpack-bundle-analyzer#options-for-plugin) or [for vite](https://github.com/btd/rollup-plugin-visualizer#options).
343
343
 
344
344
  - **Type**: `object`
345
345
  - **Default**
@@ -505,7 +505,7 @@ Any components in the directories configured here can be used throughout your pa
505
505
  }
506
506
  ```
507
507
 
508
- **See**: [`app/components/` directory documentation](https://nuxt.com/docs/4.x/guide/directory-structure/app/components)
508
+ **See**: [`app/components/` directory documentation](https://nuxt.com/docs/4.x/directory-structure/app/components)
509
509
 
510
510
  ## css
511
511
 
@@ -801,6 +801,7 @@ More customizable than `ignorePrefix`: all files matching glob patterns specifie
801
801
  "**/*.stories.{js,cts,mts,ts,jsx,tsx}",
802
802
  "**/*.{spec,test}.{js,cts,mts,ts,jsx,tsx}",
803
803
  "**/*.d.{cts,mts,ts}",
804
+ "**/*.d.vue.{cts,mts,ts}",
804
805
  "**/.{pnpm-store,vercel,netlify,output,git,cache,data}",
805
806
  "**/*.sock",
806
807
  ".nuxt/analyze",
@@ -835,7 +836,7 @@ Any file in `app/pages/`, `app/layouts/`, `app/middleware/`, and `public/` direc
835
836
 
836
837
  Configure how Nuxt auto-imports composables into your application.
837
838
 
838
- **See**: [Nuxt documentation](https://nuxt.com/docs/4.x/guide/directory-structure/app/composables)
839
+ **See**: [Nuxt documentation](https://nuxt.com/docs/4.x/directory-structure/app/composables)
839
840
 
840
841
  ### `dirs`
841
842
 
@@ -1146,7 +1147,7 @@ and these plugins do not need to be listed in `nuxt.config` unless you
1146
1147
  need to customize their order. All plugins are deduplicated by their src path.
1147
1148
  ::
1148
1149
 
1149
- **See**: [`app/plugins/` directory documentation](https://nuxt.com/docs/4.x/guide/directory-structure/plugins)
1150
+ **See**: [`app/plugins/` directory documentation](https://nuxt.com/docs/4.x/directory-structure/app/plugins)
1150
1151
 
1151
1152
  **Example**:
1152
1153
  ```ts
@@ -1217,7 +1218,7 @@ Additional router options passed to `vue-router`. On top of the options for `vue
1217
1218
  For more control, you can use an `router.options.ts` file.
1218
1219
  ::
1219
1220
 
1220
- **See**: [Vue Router documentation](https://router.vuejs.org/api/interfaces/routeroptions.html).
1221
+ **See**: [Vue Router documentation](https://router.vuejs.org/api/interfaces/routeroptions)
1221
1222
 
1222
1223
  #### `hashMode`
1223
1224
 
@@ -1307,7 +1308,7 @@ Each handler accepts the following options:
1307
1308
 
1308
1309
  - **Type**: `array`
1309
1310
 
1310
- **See**: [`server/` directory documentation](https://nuxt.com/docs/4.x/guide/directory-structure/server)
1311
+ **See**: [`server/` directory documentation](https://nuxt.com/docs/4.x/directory-structure/server)
1311
1312
 
1312
1313
  ::callout
1313
1314
  **Note**: Files from `server/api`, `server/middleware` and `server/routes` will be automatically registered by Nuxt.
@@ -1586,7 +1587,7 @@ export default defineNuxtConfig({
1586
1587
 
1587
1588
  Configuration that will be passed directly to Vite.
1588
1589
 
1589
- **See**: [Vite configuration docs](https://vite.dev/config) for more information.
1590
+ **See**: [Vite configuration docs](https://vite.dev/config/) for more information.
1590
1591
  Please note that not all vite options are supported in Nuxt.
1591
1592
 
1592
1593
  ### `build`
@@ -1785,13 +1786,13 @@ Vue.js config
1785
1786
 
1786
1787
  Options for the Vue compiler that will be passed at build time.
1787
1788
 
1788
- **See**: [Vue documentation](https://vuejs.org/api/application.html#app-config-compileroptions)
1789
+ **See**: [Vue documentation](https://vuejs.org/api/application#app-config-compileroptions)
1789
1790
 
1790
1791
  ### `config`
1791
1792
 
1792
- It is possible to pass configure the Vue app globally. Only serializable options may be set in your `nuxt.config`. All other options should be set at runtime in a Nuxt plugin..
1793
+ It is possible to pass configure the Vue app globally. Only serializable options may be set in your `nuxt.config`. All other options should be set at runtime in a Nuxt plugin.
1793
1794
 
1794
- **See**: [Vue app config documentation](https://vuejs.org/api/application.html#app-config)
1795
+ **See**: [Vue app config documentation](https://vuejs.org/api/application#app-config)
1795
1796
 
1796
1797
  ### `propsDestructure`
1797
1798
 
@@ -1918,7 +1919,7 @@ Hard-replaces `typeof process`, `typeof window` and `typeof document` to tree-sh
1918
1919
 
1919
1920
  If you are using webpack, Nuxt uses `webpack-bundle-analyzer` to visualize your bundles and how to optimize them.
1920
1921
 
1921
- Set to `true` to enable bundle analysis, or pass an object with options: [for webpack](https://github.com/webpack-contrib/webpack-bundle-analyzer#options-for-plugin) or [for vite](https://github.com/btd/rollup-plugin-visualizer#options).
1922
+ Set to `true` to enable bundle analysis, or pass an object with options: [for webpack](https://github.com/webpack/webpack-bundle-analyzer#options-for-plugin) or [for vite](https://github.com/btd/rollup-plugin-visualizer#options).
1922
1923
 
1923
1924
  - **Type**: `object`
1924
1925
  - **Default**
@@ -1965,7 +1966,7 @@ Configure [webpack experiments](https://webpack.js.org/configuration/experiments
1965
1966
 
1966
1967
  Enables Common CSS Extraction.
1967
1968
 
1968
- Using [mini-css-extract-plugin](https://github.com/webpack-contrib/mini-css-extract-plugin) under the hood, your CSS will be extracted into separate files, usually one per component. This allows caching your CSS and JavaScript separately.
1969
+ Using [mini-css-extract-plugin](https://github.com/webpack/mini-css-extract-plugin) under the hood, your CSS will be extracted into separate files, usually one per component. This allows caching your CSS and JavaScript separately.
1969
1970
 
1970
1971
  - **Type**: `boolean`
1971
1972
  - **Default:** `true`
@@ -2067,7 +2068,7 @@ Set to `false` to disable the overlay provided by [FriendlyErrorsWebpackPlugin](
2067
2068
 
2068
2069
  ### `hotMiddleware`
2069
2070
 
2070
- See [webpack-hot-middleware](https://github.com/webpack-contrib/webpack-hot-middleware) for available options.
2071
+ See [webpack-hot-middleware](https://github.com/webpack/webpack-hot-middleware) for available options.
2071
2072
 
2072
2073
  ### `loaders`
2073
2074
 
@@ -2075,7 +2076,7 @@ Customize the options of Nuxt's integrated webpack loaders.
2075
2076
 
2076
2077
  #### `css`
2077
2078
 
2078
- See [css-loader](https://github.com/webpack-contrib/css-loader) for available options.
2079
+ See [css-loader](https://github.com/webpack/css-loader) for available options.
2079
2080
 
2080
2081
  ##### `esModule`
2081
2082
 
@@ -2095,7 +2096,7 @@ See [css-loader](https://github.com/webpack-contrib/css-loader) for available op
2095
2096
 
2096
2097
  #### `cssModules`
2097
2098
 
2098
- See [css-loader](https://github.com/webpack-contrib/css-loader) for available options.
2099
+ See [css-loader](https://github.com/webpack/css-loader) for available options.
2099
2100
 
2100
2101
  ##### `esModule`
2101
2102
 
@@ -2133,11 +2134,11 @@ See [css-loader](https://github.com/webpack-contrib/css-loader) for available op
2133
2134
  }
2134
2135
  ```
2135
2136
 
2136
- **See**: [esbuild loader](https://github.com/esbuild-kit/esbuild-loader)
2137
+ **See**: [esbuild loader](https://github.com/privatenumber/esbuild-loader)
2137
2138
 
2138
2139
  #### `file`
2139
2140
 
2140
- **See**: [`file-loader` Options](https://github.com/webpack-contrib/file-loader#options)
2141
+ **See**: [`file-loader` Options](https://github.com/webpack/file-loader#options)
2141
2142
 
2142
2143
  **Default**:
2143
2144
  ```json
@@ -2156,7 +2157,7 @@ See [css-loader](https://github.com/webpack-contrib/css-loader) for available op
2156
2157
 
2157
2158
  #### `fontUrl`
2158
2159
 
2159
- **See**: [`file-loader` Options](https://github.com/webpack-contrib/file-loader#options)
2160
+ **See**: [`file-loader` Options](https://github.com/webpack/file-loader#options)
2160
2161
 
2161
2162
  **Default**:
2162
2163
  ```json
@@ -2175,7 +2176,7 @@ See [css-loader](https://github.com/webpack-contrib/css-loader) for available op
2175
2176
 
2176
2177
  #### `imgUrl`
2177
2178
 
2178
- **See**: [`file-loader` Options](https://github.com/webpack-contrib/file-loader#options)
2179
+ **See**: [`file-loader` Options](https://github.com/webpack/file-loader#options)
2179
2180
 
2180
2181
  **Default**:
2181
2182
  ```json
@@ -2201,7 +2202,7 @@ See [css-loader](https://github.com/webpack-contrib/css-loader) for available op
2201
2202
  }
2202
2203
  ```
2203
2204
 
2204
- **See**: [`less-loader` Options](https://github.com/webpack-contrib/less-loader#options)
2205
+ **See**: [`less-loader` Options](https://github.com/webpack/less-loader#options)
2205
2206
 
2206
2207
  #### `pugPlain`
2207
2208
 
@@ -2209,7 +2210,7 @@ See [css-loader](https://github.com/webpack-contrib/css-loader) for available op
2209
2210
 
2210
2211
  #### `sass`
2211
2212
 
2212
- **See**: [`sass-loader` Options](https://github.com/webpack-contrib/sass-loader#options)
2213
+ **See**: [`sass-loader` Options](https://github.com/webpack/sass-loader#options)
2213
2214
 
2214
2215
  **Default**:
2215
2216
  ```json
@@ -2236,7 +2237,7 @@ See [css-loader](https://github.com/webpack-contrib/css-loader) for available op
2236
2237
  }
2237
2238
  ```
2238
2239
 
2239
- **See**: [`sass-loader` Options](https://github.com/webpack-contrib/sass-loader#options)
2240
+ **See**: [`sass-loader` Options](https://github.com/webpack/sass-loader#options)
2240
2241
 
2241
2242
  #### `stylus`
2242
2243
 
@@ -2247,7 +2248,7 @@ See [css-loader](https://github.com/webpack-contrib/css-loader) for available op
2247
2248
  }
2248
2249
  ```
2249
2250
 
2250
- **See**: [`stylus-loader` Options](https://github.com/webpack-contrib/stylus-loader#options)
2251
+ **See**: [`stylus-loader` Options](https://github.com/webpack/stylus-loader#options)
2251
2252
 
2252
2253
  #### `vue`
2253
2254
 
@@ -2341,7 +2342,7 @@ Defaults to true when `extractCSS` is enabled.
2341
2342
  - **Type**: `boolean`
2342
2343
  - **Default:** `false`
2343
2344
 
2344
- **See**: [css-minimizer-webpack-plugin documentation](https://github.com/webpack-contrib/css-minimizer-webpack-plugin).
2345
+ **See**: [css-minimizer-webpack-plugin documentation](https://github.com/webpack/css-minimizer-webpack-plugin).
2345
2346
 
2346
2347
  ### `plugins`
2347
2348
 
@@ -2368,7 +2369,7 @@ export default defineNuxtConfig({
2368
2369
 
2369
2370
  ### `postcss`
2370
2371
 
2371
- Customize PostCSS Loader. same options as [`postcss-loader` options](https://github.com/webpack-contrib/postcss-loader#options)
2372
+ Customize PostCSS Loader. same options as [`postcss-loader` options](https://github.com/webpack/postcss-loader#options)
2372
2373
 
2373
2374
  #### `postcssOptions`
2374
2375
 
@@ -39,7 +39,7 @@ If your issue concerns Vue or Vite, please try to reproduce it first with the Vu
39
39
 
40
40
  ::card-group
41
41
  :card{title="Vue SSR on StackBlitz" icon="i-simple-icons-stackblitz" to="https://stackblitz.com/github/nuxt-contrib/vue3-ssr-starter/tree/main?terminal=dev" target="_blank"}
42
- :card{title="Vue SSR on CodeSandbox" icon="i-simple-icons-codesandbox" to="https://codesandbox.io/s/github/nuxt-contrib/vue3-ssr-starter/main" target="_blank"}
42
+ :card{title="Vue SSR on CodeSandbox" icon="i-simple-icons-codesandbox" to="https://codesandbox.io/p/sandbox/github/nuxt-contrib/vue3-ssr-starter/main" target="_blank"}
43
43
  :card{title="Vue SSR Template on GitHub" icon="i-simple-icons-github" to="https://github.com/nuxt-contrib/vue3-ssr-starter/generate" target="_blank"}
44
44
  ::
45
45
 
@@ -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://nodejs.org/api/corepack.html) 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`.
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
 
@@ -8,19 +8,19 @@ Once you've read the [general contribution guide](/docs/4.x/community/contributi
8
8
 
9
9
  ## Monorepo Guide
10
10
 
11
- - `packages/kit`: Toolkit for authoring Nuxt Modules, published as [`@nuxt/kit`](https://npmjs.com/package/@nuxt/kit).
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.dev) bundler for Nuxt, published as [`@nuxt/rspack-builder`](https://npmjs.com/package/@nuxt/rspack-builder).
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://help.github.com/articles/fork-a-repo) the [`nuxt/nuxt`](https://github.com/nuxt/nuxt) repository to your own GitHub account and then [clone](https://help.github.com/articles/cloning-a-repository) it to your local device.
23
- 2. Ensure using the latest [Node.js](https://nodejs.org/en) (20.x)
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
@@ -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 | 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.
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 | 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 | Planned | 4.x, 5.x | `nuxt/a11y` to be announced | Accessibility hinting and utilities [nuxt/nuxt#23255](https://github.com/nuxt/nuxt/issues/23255)
46
- Hints | Planned | 4.x, 5.x | `nuxt/hints` to be announced | Guidance and suggestions for enhancing development practices.
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 | Planned | 4.x, 5.x | `nuxt/a11y` to be announced | Accessibility hinting and utilities [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/4.x/guide/going-further/nightly-release-channel).
67
67
 
68
- Release | | Initial release | End Of Life | Docs
69
- -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- | ---------------------------- | ---------------------------------------
70
- **5.x** (scheduled) | | Q4 2025 (estimated) | TBA | &nbsp;
71
- **4.x** (stable) | <a href="https://www.npmjs.com/package/nuxt?activeTab=versions"><img alt="Nuxt latest version" src="https://flat.badgen.net/npm/v/nuxt?label=" class="not-prose"></a> | 2025-07-16 | 6 months after 5.x release | [nuxt.com](/docs/4.x)
72
- **3.x** (maintenance) | <a href="https://www.npmjs.com/package/nuxt?activeTab=versions"><img alt="Nuxt 3.x version" src="https://flat.badgen.net/npm/v/nuxt/3x?label=" class="not-prose"></a> | 2022-11-16 | 2026-01-31 | [nuxt.com](/docs/3.x)
73
- **2.x** (unsupported) | <a href="https://www.npmjs.com/package/nuxt?activeTab=versions"><img alt="Nuxt 2.x version" src="https://flat.badgen.net/npm/v/nuxt/2x?label=" class="not-prose"></a> | 2018-09-21 | 2024-06-30 | [v2.nuxt.com](https://v2.nuxt.com/docs)
74
- **1.x** (unsupported) | <a href="https://www.npmjs.com/package/nuxt?activeTab=versions"><img alt="Nuxt 1.x version" src="https://flat.badgen.net/npm/v/nuxt/1x?label=" class="not-prose"></a> | 2018-01-08 | 2019-09-21 | &nbsp;
68
+ | Release | | Initial release | End Of Life | Docs |
69
+ |-----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------|----------------------------|-------------------------------------------------------------------|
70
+ | **5.x** (scheduled) | | Q4 2025 (estimated) | TBA | &nbsp; |
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/4.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 | &nbsp; |
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 |
@@ -58,6 +58,16 @@ navigation.icon: i-lucide-bell-dot
58
58
  ::card
59
59
  ---
60
60
  icon: i-simple-icons-github
61
+ title: nuxt/hints
62
+ to: https://github.com/nuxt/hints/releases
63
+ target: _blank
64
+ ui.icon.base: text-black dark:text-white
65
+ ---
66
+ Nuxt Hints releases.
67
+ ::
68
+ ::card
69
+ ---
70
+ icon: i-simple-icons-github
61
71
  title: nuxt/image
62
72
  to: https://github.com/nuxt/image/releases
63
73
  target: _blank
@@ -80,7 +80,7 @@ bun add -D @nuxt/bridge nuxi
80
80
 
81
81
  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
82
 
83
- You can use static `import`, dynamic `import()` and `export default` instead. Using TypeScript by renaming to [`nuxt.config.ts`](/docs/4.x/guide/directory-structure/nuxt-config) is also possible and recommended.
83
+ You can use static `import`, dynamic `import()` and `export default` instead. Using TypeScript by renaming to [`nuxt.config.ts`](/docs/4.x/directory-structure/nuxt-config) is also possible and recommended.
84
84
 
85
85
  ```ts [nuxt.config.ts]
86
86
  import { defineNuxtConfig } from '@nuxt/bridge'
@@ -37,7 +37,7 @@ If you are using TypeScript, you can edit your `tsconfig.json` to benefit from a
37
37
  ::note
38
38
  As `.nuxt/tsconfig.json` is generated and not checked into version control, you'll need to generate that file before running your tests. Add `nuxi prepare` as a step before your tests, otherwise you'll see `TS5083: Cannot read file '~/.nuxt/tsconfig.json'`
39
39
 
40
- For modern Nuxt projects, we recommend using [TypeScript project references](/docs/4.x/guide/directory-structure/tsconfig) instead of directly extending `.nuxt/tsconfig.json`.
40
+ For modern Nuxt projects, we recommend using [TypeScript project references](/docs/4.x/directory-structure/tsconfig) instead of directly extending `.nuxt/tsconfig.json`.
41
41
  ::
42
42
 
43
43
  ::note
@@ -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/4.x/guide/directory-structure/app/plugins#creating-plugins"}
116
+ :ReadMore{link="/docs/4.x/directory-structure/app/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/4.x/guide/directory-structure/plugins).
10
+ Plugins now take only one argument (`nuxtApp`). You can find out more in [the docs](/docs/4.x/directory-structure/app/plugins).
11
11
 
12
12
  ```ts [app/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/4.x/guide/directory-structure/app/middleware).
31
+ Middleware now take only two argument (`to`, `from`). You can find out more in [the docs](/docs/4.x/directory-structure/app/middleware).
32
32
 
33
33
  ```ts twoslash
34
34
  export default defineNuxtRouteMiddleware((to) => {
@@ -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/4.x/guide/directory-structure/server"}
16
+ :read-more{to="/docs/4.x/directory-structure/server"}
17
17
  :read-more{to="/docs/4.x/guide/going-further/hooks#server-hooks-runtime"}