You are browsing Nuxt 2 docs. Go to Nuxt 3 docs, or learn more about Nuxt 2 Long Term Support.

Release Notes

Discover all the release notes for the Nuxt framework

A landscape image A landscape image

Version v3.7.3

Released on September 13, 2023

3.7.3 is a hotfix release to address a regression introduced in 3.7.2.

👉 Changelog

compare changes

🩹 Fixes

  • nuxt: Ensure plugins retain original order (#23174 )
  • nuxt: Allow importing server components from #components (#23188 )

💅 Refactors

  • nuxt: Don't wrap server placeholders/client fallbacks (#21980 )

📖 Documentation

  • Added missing leading slash (#23169 )
  • Update internal issue decision making flowchart link (#23162 )

❤️ Contributors

Version v3.7.2

Released on September 12, 2023

3.7.2 is a regularly scheduled patch release.

✅ Upgrading

As usual, our recommendation for upgrading is to run:

nuxi upgrade

👉 Changelog

compare changes

🩹 Fixes

  • nuxt: Scroll to top by default on dynamic routes (#22403 )
  • nuxt: Don't joinURL with remote sources on NuxtIsland (#23093 )
  • nuxt: Exclude data-v attrs from server component props (#23095 )
  • nuxt: Handle optional params within a path segment (#23070 )
  • nuxt: Include method when creating useFetch auto key (#23086 )
  • vite: Add css to manifest without cssCodeSplit (#23049 )
  • nuxt: Find parent routes by exact path match (#23040 )
  • nuxt: Load spaLoadingTemplate if file exists (#23048 )
  • nuxt: Handle unset spa-loading fallback (#23120 )
  • kit: Improve generated tsconfig.json defaults (#23121 )
  • vite: Remove dev styles injected via absolute path (#23126 )
  • nuxt: Default scanned layer components to priority 0 (#23127 )
  • nuxt: Allow granularly overriding pages in layers (#23134 )
  • nuxt: Respect layer order for other layer plugins (#23148 )
  • nuxt: Allow changing dirs within modules (#23133 )
  • nuxt: Allow overriding components + only warn if clash (#23156 )

📖 Documentation

  • Remove 'caching' section from data fetching (fe29948fe )
  • Fix broken links on experimental features (#23052 )
  • Fix typo (#23060 )
  • Add name param to PageMeta interface description (#23107 )
  • Fix typo for experimental.componentIslands (#23138 )
  • Change NuxtLabs UI to Nuxt UI (#23150 )
  • Fix typo in nuxi init command (#23155 )

🏡 Chore

🤖 CI

  • Test on node 20.5 rather than 20.6 (#23041 )
  • Update fixtures to node 18 (#23122 )
  • Unpin node 20 actions runners (#23135 )

❤️ Contributors

Version v3.7.1

Released on September 5, 2023

3.7.1 is a regularly scheduled patch release.

✅ Upgrading

As usual, our recommendation for upgrading is to run:

nuxi upgrade --force

This will refresh your lockfile as well, and ensures that you pull in updates from other dependencies that Nuxt relies on, particularly in the unjs ecosystem.

👉 Changelog

compare changes

🔥 Performance

  • nuxt: Prevent head dom from rendering twice (#22974 )
  • nuxt: Decrease default bundle size (#22999 )

🩹 Fixes

  • nuxt: Exclude resolved vite virtual modules prefix (#22834 )
  • nuxt: Ensure typed layout prop persists through build (#22855 )
  • nuxt: Render server components when ssr: false (#22869 )
  • kit: Respect priority when registering components dirs (#22882 )
  • kit: Allow passing a string to addLayout (#22902 )
  • nuxt: Ensure middleware is processed when returning true (#22905 )
  • nuxt: Unpause dom updates on error (#22945 )
  • nuxt: Disallow write: false for type templates (#22972 )
  • vite: Don't set explicit conditions in shouldExternalize (#22991 )
  • nuxt: Render inlined ssr styles before stylesheets (#22986 )
  • nuxt: Improve types within plugin templates (#22998 )
  • nuxt: Load layer plugins before project plugins (#22889 )
  • nuxt: Use destr in more places over JSON.parse (#22997 )
  • nuxt: Resolve head instance from Nuxt app (#22973 )
  • nuxt: Always use increment for id with client side islands (#22975 )

📖 Documentation

  • Add info about dynamic nested routes (#22862 )
  • Update nuxt bridge migration guide (#22815 )
  • Rename nuxt-community to nuxt-modules (9991da634 )
  • Add banner for readme (e92d99db3 )
  • Simplify readme (681f92915 )
  • Text center on banner (ea5142176 )
  • Clarify that 'it' is <NuxtPage> (#22912 )
  • Update examples of dynamic pageKey (#22920 )
  • Fix types in 'server utilities' example (#22978 )
  • Describe env object for nuxt plugins (#22963 )
  • Docs/3.api/3.utils/define-page-meta.md (#23006 )
  • Accessing custom props for NuxtLayout (#22989 )
  • Add information about server component context (#22964 )

🏡 Chore

  • Fix variable name in release scripts (adb6ec674 )
  • Track nuxi-edge rather than nuxi-ng (9610cf03d )

🤖 CI

  • Create 2.x release branch as well (cdf9b5547 )
  • Use GITHUB_REF_NAME to get branch for release (d49ea58de )
  • Use changelogen utility to get current branch (7431e2258 )

❤️ Contributors

Version v3.7.0

Released on August 25, 2023

👀 Highlights

🐣 A New CLI

We've refactored nuxi using unjs/citty and this marks the first Nuxt release that depends on the new version, safely in its own repository. We have grand plans for this - check out some of the features + roadmap discussions in nuxt/cli and please feel free to contribute!

Nuxi is now decoupled from the main nuxt version - we plan to iterate and release nuxi more quickly in future so you can expect new things coming soon!

🕸️ Native Web Streams and Response

With improvements in unjs/h3 and unjs/nitro , it's now possible to directly return a Response object from server routes, meaning it's also possible to return and handle streams natively in Nuxt.

👉 Check out the full detail in the unjs/h3 and unjs/nitro release notes.

🔥 HTML Rendering Optimisations

This release comes with a couple of improvements in rendering HTML responses from the server. We now determine whether to preload/prefetch resources at build time (so you can customise this in the build:manifest hook). We also now manage rendering the HTML for them directly in unhead (#22179 ), which means you can configure the order for <link>, <meta>, <script>, <style>, and more. And - in our preliminary testing - it's even faster!

It's possible to opt-in to upcoming head improvements with the experimental.headNext flag. This currently includes a new ordering algorithm based on capo.js (#22431 ) and allows enabling future optimisations as they are released in unhead:

export default defineNuxtConfig({
  experimental: {
    headNext: true
  }
})

We'd love your thoughts - you can respond with any issues/feedback in this discussion .

🛠️ Build Environment Shortcuts

In your Nuxt config you can now use $client and $server shortcuts to easily define configuration that is specific to just the Vite client/server (#22302 ) or webpack client/server (#22304 ) builds. This previously was only possible with the vite:extendConfig and webpack:config hooks.

For example:

export default defineNuxtConfig({
  vite: {
    $client: {
      build: {
        rollupOptions: {
          output: {
            chunkFileNames: '_nuxt/[hash].js',
            assetFileNames: '_nuxt/[hash][extname]',
            entryFileNames: '_nuxt/[hash].js'
          }
        }
      }
    }
  }
})

⚡️ Vite 4.4

We've chosen to unpin Vite from minor versions, meaning whenever Vite releases a new feature version you can opt-in straight away. Vite 4.4 brings a lot of exciting things, including experimental Lightning CSS support - and much more!

👉 Check out the Vite release notes for more.

💪 TypeScript Updates

We now use purely relative paths in the generated tsconfig.json instead of setting a baseUrl. This means better support for dev environments like docker images where the absolute path may not match your IDE (#22410 ).

We also set a couple of additional compiler flag defaults to match Vite/TS recommendations (#22468 ).

Plus, you should now get type hinted access to layouts in setPageLayout and also in <NuxtLayout name> (#22363 ).

🦄 Async Context support

If you've ever got an issue with 'Nuxt context unavailable' this might be one for you. We now support native async context for Bun and Node under an experimental flag, in both Nuxt and Nitro (#20918 ).

This enables using Nuxt composables on the server without needing to ensure they are being called directly in a setup function. It also allows the same in Nitro, with a new useEvent() utility that is usable in server routes.

To try it out, you can enable experimental.asyncContext:

export default defineNuxtConfig({
  experimental: {
    asyncContext: true
  }
})

👓 Watcher Updates

We've fixed a couple of issues with watchers, meaning that you should need to restart your server less often - and you should see a significant performance increase if you are using layers.

⚗️ Nitro 2.6

There lots more exciting features coming directly from Nitro 2.6, including smaller, lighter servers and new persistent data storage in a .data directory.

👉 Read more in the full release article .

✅ Upgrading

As usual, our recommendation for upgrading is to run:

npx nuxi upgrade --force

This will refresh your lockfile as well, and ensures that you pull in updates from other dependencies that Nuxt relies on, particularly in the unjs ecosystem.

👉 Changelog

compare changes

🚀 Enhancements

  • vite: Unpin vite from minor (#22031 )
  • nuxt: Polyfill idle callback utils (#21863 )
  • nuxt: Smooth scroll behavior option (#21948 )
  • schema,vite: Allow $client and $server vite env overrides (#22302 )
  • schema,webpack: Allow $client and $server overrides (#22304 )
  • nuxt: Allow dynamic scrollToTop page meta (#21741 )
  • nuxt: Expose filtered templates in app:templatesGenerated hook (#21935 )
  • nuxt: Render all head tags on server with unhead (#22179 )
  • nuxt: Auto-install @nuxt/webpack-builder when needed (#21747 )
  • nuxt: Allow remote sources for islands (#21592 )
  • nuxt: Environment-specific plugin execution for islands (#20726 )
  • kit,nuxi: Add writeTypes utility (#22385 )
  • nuxt: Autocomplete layouts in setPageLayout/<NuxtLayout> (#22362 )
  • nuxt: Allow 'lazy' (non-blocking) server components (#21918 )
  • nuxt: Use build plugin to access nuxt route injection (#21585 )
  • vite,webpack: Tree-shakable import.meta.* build flags (#22428 )
  • nuxt: Resolve unresolved paths within node_modules (#22478 )
  • nuxt: Experimental native async context support (#20918 )
  • nuxt: Warn on external webpack/nitro/postcss config (#22521 )
  • nuxt: Allow experimental global: 'sync' components (#22558 )
  • nuxt: Make app.rootId optional (#22528 )
  • nuxt: Add experimental.headNext unhead integration (#22620 )
  • cli: Detect bun package manager (#22673 )
  • nuxt: Upgrade nitro + reduce node-specific usage (#22515 )
  • nuxt: Add support for routeRules defined within pages (#20391 )
  • schema: Support setting hidden sourcemaps (#22787 )
  • kit,nuxt: Respect nuxt ignore patterns in nitro (#22808 )
  • nuxt: Migrate to new nuxt/cli (#22799 )
  • schema: Export ./schema/config.schema.json subpath (#22813 )

🔥 Performance

  • nuxt: Export DefineNuxtConfig interface from nuxt/config (#22391 )
  • nuxt: Write templates in single sync step + improve logs (#22384 )
  • nuxt: Render css/inline css higher than resource hints (#21793 )
  • nuxt: Experimental support of capo.js head tag order (#22431 )
  • nuxt: Use LRU prerender cache and limit cached items (#22465 )
  • nuxt: Reduce multiple calls to .toLowerCase() (#22743 )
  • nuxt: Reduce multiple calls to dirname (#22800 )

🩹 Fixes

  • nuxt: Await prerender:routes hook (#22247 )
  • nuxt: Access resolved scrollBehaviorType (#22264 )
  • nuxt: Add overloads for asyncData generic + default (#22258 )
  • nuxt: Bind createClientOnly render function to ctx (#22289 )
  • webpack: Remove legacy support for build.extend (#22305 )
  • nuxt: Allow validate return typing to be either error or boolean (#22323 )
  • kit: Handle tuple-format modules in hasNuxtModule (#22316 )
  • nuxt: Components auto-import for JSX (#22330 )
  • nuxt: Pass (and handle) relative paths in builder:watch (#22333 )
  • nuxt: Use computed path value for useFetch hash (#22378 )
  • cli: Only strip extensions from files (#22399 )
  • nuxt: Disallow redirects to more script protocols (#22366 )
  • nuxt: Test watch paths against all layer srcDirs (#22307 )
  • nuxt: name is an optional prop for <NuxtLayout> (0d9a0b753 )
  • kit: Don't unsubscribe from file writing (716a5b834 )
  • nuxt: Support uppercase route methods in useFetch (#22418 )
  • kit: Remove baseUrl and use relative paths in tsconfig (#22410 )
  • nuxt: Print name of missing island component (#22440 )
  • nuxt: Broken capo.js injectHead usage (#22447 )
  • kit: Apply preferred options for esbuild transpilation (#22468 )
  • nuxt: Correctly update object cookies in useCookie (#22474 )
  • nuxt: Use internal:nuxt namespace (9b0d371b0 )
  • nuxt: Remove unused normalize call (14bf2b02f )
  • cli: Display log when restarting nuxt (#22500 )
  • nuxt: Resolve type import paths (#22476 )
  • schema: webpack options should be optional (#22524 )
  • nuxt: Enable hmr of app.config.ts files (#22494 )
  • vite: Add hookable to externals list (4552d39c4 )
  • vite: Disable assignement in replace plugin (37ba58630 )
  • schema: Ignore empty string in app.{rootId ([rootTag} (#22543 )](https://github.com/nuxt/nuxt/commit/rootTag}` (#22543 )))
  • vite: Include import.meta build vars in define as well (#22576 )
  • nuxt: Provide fallback route (#22580 )
  • nuxt: Trigger immediate DOM update on page:finish (#22566 )
  • nuxt: Unsub from hooks when unmounting indicator (#22592 )
  • cli: Only watch distDir after first build (#22614 )
  • nuxt: Use relative paths when augmenting types (#22633 )
  • nuxt: Don't prompt to install packages in CI (#22636 )
  • cli: Ignore error if nitro is not enabled on bridge (#22642 )
  • nuxt: Remove experimental hash hydration (#22648 )
  • nuxt: Correct revive payload data type (#22667 )
  • vite: Use '' key for root scope in variable collector (#22679 )
  • nuxt: Warn when ignoring duplicate island/server component (#22709 )
  • nuxt: Add exclude paths to nitro tsconfig.server.json (#22768 )
  • nuxt: Recreate asyncData when immediate is disabled (#20980 )
  • nuxt: Respect ignorelist when scanning auto-imports (#22782 )
  • schema: Mark schema as free of side effects (#22793 )
  • nuxt: Default spaLoadingTemplate to false (#22798 )
  • nuxt: Fully resolve unctx where possible (#22811 )
  • vite: Only mark nitro deps as externals when building (#22812 )

💅 Refactors

  • nuxi,schema: Move loading template into schema (#22336 )
  • nuxt: Add additional flag to enable remote sources (#22409 )
  • nuxt: Use nuxi-ng for edge releases (#22413 )
  • nuxt: Import useNitroApp from subpath (#22785 )

📖 Documentation

  • Mention #components import for dynamic component (#22231 )
  • Fix typo (#22308 )
  • Add information on how to type custom hooks (#22312 )
  • Correct manually typing runtime config example (#22393 )
  • Update .env section (#22369 )
  • Add example for accessing vite config programmatically (#18812 )
  • Add recommendation to install nuxtr (#20808 )
  • Add some more debugging tips (#22415 )
  • Document NuxtIsland (#22434 )
  • Escape ] in code-block filenames (#22389 )
  • Add temporary website for docs contribution (#22469 )
  • Update prerender documentation (#22471 )
  • Update hybrid rendering section (#22475 )
  • Fix typo in scrollToTop (#22503 )
  • Add status type for useAsyncData (#22511 )
  • Rephrase link to useSeoMeta parameters (#22513 )
  • Update api example for pick (#22531 )
  • Add closing blocks for ReadMore components (#22541 )
  • Update rendering error page (#22523 )
  • Mention adding auto-import of third party packages (#22575 )
  • Update and shorten server example (#22583 )
  • Update twitter/X logo (#22569 )
  • Added addServerHandler example to modules author guide (#22603 )
  • Clarify server: false doesn't await on initial load (#22619 )
  • Fix link to deployment page (#22618 )
  • Warn directives must be registered on both server/client (#22627 )
  • Revert import.meta.* update until v3.7 release (98c17e5d4 )
  • Improve custom component dirs example (#22697 )
  • Mention NuxtIsland in server only components docs (#22685 )
  • Add additional type generics to useFetch docs (#22755 )
  • Add additional type generics to useAsyncData (#22760 )
  • Add instructions for Bun package manager (#22779 )
  • Fix typo in bun package manager name (#22781 )

📦 Build

🏡 Chore

  • Dedupe and bump semver (#22322 )
  • Update codesandbox links (5edf00f06 )
  • Add issue reproduction bot (#22495 )
  • Remove unused import (8eefb6548 )
  • Increase stale operations per run (#22501 )
  • Refresh lockfile (#22518 )
  • Increase stale bot limit to 300 (#22538 )
  • schema: Enable linting (#22546 )
  • Replace .eslintignore file with 'ignorePatterns' (#22547 )
  • kit: Remove unused internals (#22555 )
  • Depend on h3-nightly on edge releases (#22593 )
  • Check if deps exist (817c12f02 )

✅ Tests

  • Remove separate test for baseurl (#22467 )
  • Remove JS payload test + add non-async context test (#22530 )
  • Refactor test suite and reduce networkidle dependency (#22596 )
  • Reduce verbose log outputs (c8cba7a06 )
  • Add regression test for escaping payload (#22774 )

🤖 CI

  • Add ecosystem-ci pr comment trigger (#22239 )
  • Add semantic pull request workflow (#22241 )
  • Grant permission to comment on prs (6f1a557e5 )
  • Harden GitHub actions (#22321 )
  • Pin actionlint script (#22324 )
  • Skip semantic validation on release branches (459dc7d2d )
  • Update issue label for reproduire (4e0a499a0 )
  • Pin version of actionlint used (b702adc24 )
  • Try another way to disable semantic validation of release prs (eff05e1d4 )
  • Bump timeout minutes for windows fixtures 🙈 (33389dc4e )

❤️ Contributors

Version v3.6.5

Released on July 19, 2023

3.6.5 is a hotfix patch release addressing the regression with nuxt/content introduced in v3.6.4.

v3.6.4 release notes

✅ Upgrading

As usual, our recommendation for upgrading is to run:

nuxi upgrade --force

This will refresh your lockfile as well, and ensures that you pull in updates from other dependencies that Nuxt relies on, particularly in the unjs ecosystem.

👉 Changelog

compare changes

🩹 Fixes

  • nuxt: Remove dist from the default ignore list (#22227 )

❤️ Contributors

Version v3.6.4

Released on July 19, 2023

3.6.4 is a patch release, brought forward to allow releasing some important bug fixes before work begins on 3.7.

Warning We're currently investigating a regression with nuxt/content and will be releasing 3.6.5 later today.

✅ Upgrading

As usual, our recommendation for upgrading is to run:

nuxi upgrade --force

This will refresh your lockfile as well, and ensures that you pull in updates from other dependencies that Nuxt relies on, particularly in the unjs ecosystem.

👉 Changelog

compare changes

🔥 Performance

  • nuxt,schema: Do not watch buildDir and node_modules (#22214 )

🩹 Fixes

  • nuxt: Correctly use toLowerCase for possible moduleResolution (#22160 )
  • nuxt: Don't redirect if initial path has trailing slash (#22192 )
  • nuxt: Work around payload extraction issue (#22162 )
  • nuxt: Add baseURL to island fetch requests (#22009 )
  • nuxt: Resolve race condition regenerating auto imports (#22201 )
  • nuxt: Ensure we only increment hydrating count once (#22200 )
  • nuxt: Avoid premature hydration when using async layouts (#22198 )
  • cli: Support --inspect in dev mode (#22205 )
  • test-utils: Pass along error if server can't start (#22216 )

📖 Documentation

  • Add runtime storage configuration examples (#22189 )
  • Add instruction on how to use other modules in a module (#22081 )
  • Standardize indentation and tag positioning (#22157 )

❤️ Contributors

Version v3.6.3

Released on July 14, 2023

3.6.3 is the next patch release, including a number of fixes. It's anticipated this will be the last patch release before 3.7.

✅ Upgrading

As usual, our recommendation for upgrading is to run:

nuxi upgrade --force

This will refresh your lockfile as well, and ensures that you pull in updates from other dependencies that Nuxt relies on, particularly in the unjs ecosystem.

👉 Changelog

compare changes

🔥 Performance

  • nuxt: Prepopulate island payloads from rendered html (#22049 )

🩹 Fixes

  • kit: Module compatibility not working with module names (6cabe69ce )
  • schema: Correct type of unctx options (4e32e70bb )
  • vite: Pass modulesDir to isExternal (#21966 )
  • nuxt: Add pages in correct hook when generating (#22088 )
  • test-utils: Export from core playwright package (#22122 )
  • nuxt: Skip view transitions where there is no route change (#22140 )
  • nuxt: Skip scanning components that do not produce a name (#22074 )
  • cli: Add aliases to monorepo paths to tsconfig includes (#21997 )
  • cli: Allow non-existent experimental option (0643d4315 )

💅 Refactors

  • cli,schema: Add bundler module resolution flag (#22142 )

📖 Documentation

  • Fix accessing custom props from child pages (#21977 )
  • Add leading slash (3bae61507 )
  • Add more internal links (#22013 )
  • Add space in list (#22032 )
  • Add details and components folder to auto imports introduction (#22062 )
  • Use sfc syntax in example (#22073 )
  • Prefix internal links with / (#22118 )
  • Fix typos (#22125 )
  • Update link to router options (#22131 )

🏡 Chore

❤️ Contributors

Version v3.6.2

Released on July 5, 2023

3.6.2 is the next patch release, with a raft of fixes including preparations for use without --shamefully-hoist and some fixes for data fetching within nested layouts/pages.

✅ Upgrading

As usual, our recommendation for upgrading is to run:

nuxi upgrade --force

This will refresh your lockfile as well, and ensures that you pull in updates from other dependencies that Nuxt relies on, particularly in the unjs ecosystem.

👉 Changelog

compare changes

🔥 Performance

  • nuxt: Don't run island transform plugin if disabled (#21844 )
  • nuxt: Allow hmr for server components in dev mode (#21916 )
  • nuxt: Use getters when constructing reactive routes (#21957 )

🩹 Fixes

  • nuxt: Only redirect if path is not the same as initial url (#21815 )
  • cli: Resolve @nuxt/ui-templates from modulesDir (#21836 )
  • nuxt, vite: Do not use cjs utils to resolve/alias vue (#21837 )
  • nuxt: Improve default prerender behaviour (#21817 )
  • vite: Greater type-safety within runtime vite-node (#21849 )
  • nuxt: Ensure static presets equivalent to nuxi generate (#21860 )
  • nuxt: Handle injecting multiple entry ids for styles (#21864 )
  • nuxt: Stop loading indicator on navigation failure (#21751 )
  • cli: Respect nitro ssl cert/key variables (#21912 )
  • nuxt: Include external layers in tsconfig.json scope (#21917 )
  • nuxt: Support custom route name meta with typedPages (#21659 )
  • vite: Remove @vue/ scoped libraries from resolutions (#21922 )
  • nuxt: Add layers in node_modules to tsconfig include (#21929 )
  • nuxt: Regenerate imports after template (#21934 )
  • vite: Fix issue detecting shadowed keyed composables (#21891 )
  • nuxt: Use $fetch.raw in dev client mode for islands (#21904 )
  • schema: Warn if user provides vite.publicDir (#21847 )
  • nuxt: Preserve old vnode when leaving nested route (#21823 )
  • kit: Ignore telemetry startup time (as it has prompt) (#21959 )

📖 Documentation

  • Add warning about dynamic import of css (#21805 )
  • Update example links (#21811 )
  • Fix broken spaLoadingTemplate link (#21845 )
  • Update useFetch return values (#21852 )
  • Describe environment override feature (#21879 )
  • Add Daniel example for hybrid rendering and Vercel (20d59d1cf )
  • Improve hybrid rendering (3fb329cc8 )
  • rendering: Add end of sentence (565787183 )
  • Add closing bracket (#21887 )
  • Added a note about server dynamic routes limitation (#21919 )
  • Update docs for <NuxtLoadingIndicator> (#21952 )
  • Update more links to examples repo (13a892361 )
  • Add JetBrains IDEs debug configuration (#21965 )

🏡 Chore

  • Prune internal unused code and exports (#21809 )
  • Add codeflow overrides configuration (d7267663f )

✅ Tests

  • Add nuxt-vitest and composable unit tests (#21884 )

❤️ Contributors

Version v3.6.1

Released on June 26, 2023

3.6.1 is a bugfix/patch release with some significant patches merged since 3.6.0

✅ Upgrading

As usual, our recommendation for upgrading is to run:

nuxi upgrade --force

This will refresh your lockfile as well, and ensures that you pull in updates from other dependencies that Nuxt relies on, particularly in the unjs ecosystem.

👉 Changelog

compare changes

🩹 Fixes

  • nuxt: Use esbuild/acorn instead of typescript dep (#21729 )
  • nuxt: Proxy headers to islands + returned prerender hints (#21740 )
  • nuxt: Respect false to disable spa loading template (#21739 )
  • nuxt: Remove path from SPA payload (#21732 )
  • nuxt: Only remove one item from middleware (#21730 )
  • nuxt: Escape colons in page paths (#21731 )
  • nuxt: Augment nitro config within server context as well (#21724 )
  • nuxt: Inline global css with ssr: false route rule (#21763 )
  • vite: Resolve css files without importer id first (#21770 )
  • vite: Emit assets referenced in inline css (#21790 )
  • nuxt: Support importing types from #imports (#21796 )
  • nuxt: Use starting index when transforming islands (#21795 )

📖 Documentation

  • Add defineNuxtRouteMiddleware migration (#21718 )
  • Add a link to Docus layer nuxt config file (#21742 )
  • Remove outdated reference to stable version (#21785 )
  • Centre example loading spinner (#21792 )

✅ Tests

❤️ Contributors

Version v3.6.0

Released on June 23, 2023

3.6.0 is the next minor release, packed with improvements and bug fixes.

📣 Upcoming news

In the coming week you can expect two announcements:

  1. The open-sourcing of nuxt/cli by @pi0 - a new, drop-in replacement for nuxi featuring more extensibility and better DX. We are aiming to release this alongside Nuxt 3.7, but you would be very welcome to test and contribute to nuxi-ng before then!
  2. Three significant RFCs: Nuxt Font, Nuxt Assets and Nuxt Scripts. We're expecting an initial POC to take shape in the next month, and would very much appreciate community feedback on this.

👀 Highlights

This minor release contains quite a lot, and we have big plans

 SPA loading indicator

If your site is served with ssr: false or you have disabled server-rendering on some of your pages, you might be particularly interested in the new built-in SPA loading indicator .

You can now place an HTML file in ~/app/spa-loading-template.html with some HTML you would like to use to render a loading screen that will be rendered until your app is hydrated on these pages.

👉 By default an animated Nuxt icon is rendered. You can completely disable this indicator by setting spaLoadingTemplate: false in your nuxt configuration file.

⚡️ Performance improvements

The first thing that happens when your app is hydrated is that your plugins run, and so we now perform build-time optimisations on your plugins , meaning they do not need to be normalised or reordered at runtime.

We also include your error component JS in your main entrypoint, meaning that if an error occurs when a user has no connectivity, you can still handle it with your ~/error.vue. (This also should decrease your total bundle size.)

👉 Compared to Nuxt 3.5.3, the minimal client bundle has decreased by ~0.7kB. Let's keep this up!

🔥 Fully static server components

It has been possible to use server components on static pages, but until now they would increase the payload size of your application. That is no longer true. We now store rendered server components as separate files, which are preloaded before navigation .

👉 This does rely on the new, richer JSON payload format, so make sure you have not disabled this by setting experimental.renderJsonPayloads to false.

🎨 Better style inlining

If you're monitoring your metrics closely and have not turned off experimental.inlineSSRStyles, you should see more CSS inlined in your page, and a significantly external CSS file. We're now better at deduplicating global CSS , particularly added by libraries like tailwind or unocss.

🎬 Animation controls

To give you more fine-grained control over your page/layout components, for example to create custom transitions with GSAP or other libraries, we now allow you to set pageRef on <NuxtPage> and layoutRef on <NuxtLayout . These will get passed through to the underlying DOM elements.

✨ Automatic 'static' preset detection

Up to now, running nuxt generate produced the same output on every deployment provider, but with Nuxt 3.6 we now enable static provider presets automatically. That means if you are deploying a static build (produced with nuxt generate) to a supported provider (currently vercel and netlify with cloudflare and github pages coming soon) we'll prerender your pages with special support for that provider.

This means we can configure any route rules (redirects/headers/etc) that do not require a server function. So you should get the best of both worlds when deploying a site that doesn't require runtime SSR. It also unblocks use of Nuxt Image on Vercel (with more potential for automatic provider integration coming soon).

💪 Increased type safety

We now have better support for server-specific #imports and augmentations if you are using the new ~/server/tsconfig.json we shipped in Nuxt 3.5. So when importing from #imports in your server directory, you'll get IDE auto-completion for the right import locations in Nitro, and won't see Vue auto-imports like useFetch that are unavailable within your server routes.

You should now also have type support for runtime Nitro hooks .

Finally, we have removed more locations where objects had a default any type . This should improve type safety within Nuxt in a number of locations where unspecified types fell back to any:

  • RuntimeConfig
  • PageMeta
  • NuxtApp['payload'] (accessible now from NuxtPayload interface)
  • ModuleMeta

You can find out more about how to update your code if this affects you in the original PR.

⚗️ Nitro 2.5 built-in

This release ships with new Nitro 2.5, which has a whole list of exciting improvements that are worth checking out.

Of particular note is experimental support for streaming, which is also enabled by a couple of changes in Nuxt itself.

🛠️ New tools for module authors

This release brings a number of utilities for modules authors to easily add type templates and assert compatibility with a given version of another module.

In addition, this release will finally unlock a new nuxt/module-builder mode that should improve type support for module authors. If you're a module author, you might consider following these migration steps to try it out in the coming days.

✅ Upgrading

As usual, our recommendation for upgrading is to run:

nuxi upgrade --force

This will refresh your lockfile as well, and ensures that you pull in updates from other dependencies that Nuxt relies on, particularly in the unjs ecosystem.

👉 Changelog

compare changes

🚀 Enhancements

  • nuxt: Sync useCookie state between tabs (#20970 )
  • kit: Module compatibility utils (#21246 )
  • nuxt: Add renderResult to app:rendered (#18610 )
  • webpack: Allow configuring esbuild-loader options (#21436 )
  • nuxt: Add open option in navigateTo helper (#21333 )
  • webpack, schema: Add webpack experiments configuration (#21446 )
  • nuxt: Provide clearNuxtState composable (#21409 )
  • kit: addTypeTemplate helper with auto-registration (#21331 )
  • nuxt: Return status from useAsyncData (#21045 )
  • nuxt: Allow accessing NuxtPage ref via pageRef (#19403 )
  • nuxt: Allow accessing NuxtLayout ref via layoutRef (#19465 )
  • nuxt: Emit error in ssr-error event (#21547 )
  • nuxt: Start loading indicator state with middleware (#21003 )
  • kit: Allow direct function in defineNuxtModule (#20763 )
  • nuxt: Expose useNuxtApp to window for convenience (#21636 )
  • nuxt: Allow configuring spa loading indicator (#21640 )
  • nuxt: Add types for nuxt-defined nitro runtime hooks (#21666 )
  • nuxt: Update devdependency nitropack to v2.5.1 (#21696 )

🔥 Performance

  • nuxt: Mark define functions as side-effect free at source (#21434 )
  • nuxt: Import error component synchronously (#21406 )
  • nuxt: Use prerendered islands to serialise/revive payload (#21461 )
  • nuxt: Extract and apply plugin order at build time (#21611 )

🩹 Fixes

  • nuxt: Handle page rendering on different path (#21408 )
  • nuxt: Replace BigInt literal with BigInt constructor (#21427 )
  • vite: Remove resolveId workaround and update vite-node (#21423 )
  • schema: Remove obsolete terser option from webpack config (#21407 )
  • nuxt: Skip vue render when redirecting (#21412 )
  • nuxt: Avoid early returning renderer with empty response (#21439 )
  • nuxt: Add missing vue types (#21445 )
  • nuxt: Prefix server component ids to avoid collisions (#21472 )
  • schema: Add more explicit types for config schema (#21475 )
  • nuxt: Fix typo on nitro.autoImport option (#21485 )
  • nuxi,nuxt: Remove baseUrl + use relative paths in tsconfig (#21081 )
  • vite: Invalidate templates by dst not src (#21501 )
  • nuxt: Don't disable vue endpoint in dev mode (#21524 )
  • nuxt: Respect query/hash for external routes in navigateTo (#21500 )
  • nuxt: Abort navigation when updating window.location (#21521 )
  • vite: Ignore and warn if vite config file exists (#21588 )
  • nuxt: Ensure prerendered components are treated as islands (#21583 )
  • nuxt: Improve warning for invalid children of <Title> (#21613 )
  • nuxt: Replace : in rendered server components (for win) (#21645 )
  • cli: Add back default baseUrl in tsconfig.json (#21632 )
  • nuxt: Post non-proxied cookie value via BroadcastChannel (#21653 )
  • nuxt: Stop indicator when not changing page component (#21656 )
  • nuxt: Scroll to top in nested routes (#21657 )
  • nuxt: Inline css directly in root component (#21573 )
  • nuxt: Move to @typescript-eslint/typescript-estree (#21664 )
  • nuxt: Guard res.end() calls with check if event is handled (#21665 )
  • nuxt: Do not embed error path in payload (#21671 )
  • nuxt: Use static nitro build if possible (#21655 )
  • nuxt: Add aliases and augmentations for nitro context (#21680 )
  • nuxt,schema: Prefer unknown rather than any for signatures (#21700 )
  • schema: Change redirect type for NuxtPage type (#21713 )
  • nuxt: Fix error on layout switching (#21450 )

📖 Documentation

  • Add info about vue configuration (#21303 )
  • Include example for server utilities (#21337 )
  • Improved recommended gitignore list (#21451 )
  • Add info about merging strategy in app config (#21462 )
  • Avoid using render when defining rendering (#21490 )
  • Remove example of deprecated reactivity transform (#21396 )
  • Fix addTypeTemplate typos (#21520 )
  • Add warning about redirect check (#20680 )
  • Remove link to closed RFC (#21564 )
  • Info icon fix on "Standalone server" section (#21589 )
  • Add note to use nuxt with bridge if nitro is false (#21586 )
  • Add styling section (#21525 )
  • Add full stop (#21614 )
  • Reorder sfc blocks and add initial slash in link (#21618 )
  • Add info on extending the HTML template (#21615 )
  • Document parallel option on plugins (#21622 )
  • Americanize spelling + fix typos (#21627 )
  • Remove examples/ from repository (#21538 )
  • examples: Add bullet points (9df892a17 )
  • Add experimental features page (#21617 )
  • Fix typo in experimental features (#21663 )
  • Update specified Nuxt 2 version in migration guide (#21699 )
  • Added @latest to install commands (#21702 )

🏡 Chore

✅ Tests

🤖 CI

  • Move bundle skipping logic to workflow (#21448 )
  • Build project before calculating bundle size (ce096da96 )

❤️ Contributors

Version v3.5.3

Released on June 6, 2023

3.5.3 is expected to be the last patch release before our next raft of features lands in v3.6.

✅ Upgrading

As usual, our recommendation for upgrading is to run:

nuxi upgrade --force

This will refresh your lockfile as well, and ensures that you pull in updates from other dependencies that Nuxt relies on, particularly in the unjs ecosystem.

👉 Changelog

compare changes

🔥 Performance

  • nuxt: Avoid watching nested paths (#21256 )

🩹 Fixes

  • nuxt: Handle serialising empty bigint (#21257 )
  • cli: Pass --no-clear config through to vite (#21262 )
  • cli: Always use the latest devtools wizard (#21291 )
  • schema: Update vue-loader options type (#21363 )
  • schema: Add types for vue experimental features (#21364 )
  • nuxt: Display errors in client overlay with typeCheck (#21064 )
  • nuxt: Support usage of std-env in runtime code (#21372 )
  • nuxt: Key distinct pages differently for legacy asyncData (#21263 )
  • vite: Skip generating keys for locally scoped functions (#20955 )
  • kit: Temporarily inline lodash.template from lodash-es (#20892 )

📖 Documentation

  • Add index.vue to page routing example (#21240 )
  • Distinguish between $fetch and fetch composables (#21228 )
  • Adjust env property to match runtimeConfig (#21265 )
  • Fix Cloudflare capitalization (#21267 )
  • Migrate transition class names and style prop (#21281 )
  • Remove irregular spaces (#21380 )

🏡 Chore

  • Pin dev dependencies (9fb83b744 )
  • Avoid inlining deps in vitest (#21316 )
  • Rewrite crawler to remove old dependencies (#21326 )
  • Support vitest 0.30.0 peer dependency (d58d1ea1e )

✅ Tests

🤖 CI

  • Apply security best practices to workflows (#21328 )
  • Pin more action dependencies to hash (#21330 )

❤️ Contributors

Version v3.5.2

Released on May 29, 2023

3.5.2 is a patch release focusing on bug fixes.

✅ Upgrading

As usual, our recommendation for upgrading is to run:

nuxi upgrade --force

This will refresh your lockfile as well, and ensures that you pull in updates from other dependencies that Nuxt relies on, particularly in the unjs ecosystem.

👉 Changelog

compare changes

🔥 Performance

  • nuxt: Use .test and hoist regexps where possible (#21011 )

🩹 Fixes

  • nuxt: Fix useLazyFetch types (#20989 )
  • nuxt: Scan component dirs case-sensitively (#20995 )
  • schema: Remove duplicate @default jsdoc tag (#21010 )
  • nuxt: Add type support for router composables without pages/ integration (397c54c9d )
  • nuxt: Use simple incrementing id on client (#20992 )
  • nuxt: Treeshake <DevOnly> with webpack (#21013 )
  • nuxt: Await nuxt ready state before refreshNuxtData (#21008 )
  • nuxt: Show error page after fatal abortNavigation (#21047 )
  • nuxt: Normalize windows paths in granular watcher (#21066 )
  • nuxt: Omit Set-Cookie header if value is null (#21072 )
  • nuxt: Resolve modules relative to modulesDir (#21082 )
  • vite: Narrow vite-node inline pattern (#21224 )

📖 Documentation

  • Fix typo in modules directory example (#21014 )
  • Fix a typo in code example (#21057 )
  • Link to correct webpack css extraction loader (4e6369cef )
  • api: Add render:island hook (#21065 )
  • Rewrite data fetching section (#21031 )
  • Improve data fetching docs (#21197 )

🏡 Chore

✅ Tests

  • Refactor type tests into a separate fixture (#21007 )
  • Close out some missing browser contexts (3bc3aeaf6 )

❤️ Contributors

Version v3.5.1

Released on May 21, 2023

3.5.1 is a patch release, with bug fixes and performance improvements.

✅ Upgrading

As usual, our recommendation for upgrading is to run:

nuxi upgrade --force

This will refresh your lockfile as well, and ensures that you pull in updates from other dependencies that Nuxt relies on, particularly in the unjs ecosystem.

👉 Changelog

compare changes

🔥 Performance

  • nuxt: Use granular watcher to avoid crawling ignored dirs (#20836 )

🩹 Fixes

  • webpack: Analyze report path (#20878 )
  • nuxt: Allow island renders without / route (#20894 )
  • nuxt: Infer useFetch method when generic is passed (#20797 )
  • nuxt: Prioritise vue app context when available (#20910 )
  • nuxt: Don't refresh when hydrating when data is present (#20916 )
  • nuxt: Resolve layer assets in relation to layer directory (#20932 )
  • nuxt: Don't match partial component names with prefix (#20939 )
  • kit: Resolve relative module paths when installing (#20896 )
  • nuxt: Exclude plugin declaration from non-existent files (#20974 )
  • nuxt: Use default type for initial value for composables (#20968 )
  • nuxt: Skip middleware for islands components (#20924 )
  • nuxt: Use resolvePath to handle edge cases for modules (#20975 )

📖 Documentation

  • Fix defaults in custom fetch example (#20898 )
  • Fix typo (#20907 )
  • Add pnpm test command to run whole test suite (4907660ff )
  • Remove warning around experimental.renderJsonPayloads (891ba880e )
  • Add example of 'alphabetical' plugin numbering (#20930 )
  • rendering: Improve rendering modes section (244c68108 )
  • rendering: Lint fix (ef8b5b593 )
  • Sync useAsyncData and useFetch types (#20935 )
  • Update static to isr (#20964 )
  • Add advanced usage example of useState (#20249 )
  • Add link to layers from pages/ docs (#20976 )

🏡 Chore

🤖 CI

❤️ Contributors

Version v3.5.0

Released on May 16, 2023

3.5.0 is a minor (feature) release with lots of new features to play with.

👀 Highlights

⚡️ Vue 3.3 released!

Vue 3.3 has been released, with lots of exciting features, particularly around type support. This also brings a significant improvement to data fetching when navigating between nested pages (#20777 ), thanks to @antfu and @baiwusanyu-c .

  • new defineOptions macro
  • 'generic' components
  • typed slots and using external types in defineProps
  • ... and more

Read the full release announcement for more details.

🙌 Nitropack v2.4

We've been working on lots of improvements to Nitro and these have landed already in Nitro v2.4 - you may already have this upgrade, which contains a lot of bug fixes, updates to the module worker format for Cloudflare, Vercel KV support and more.

One note: if you're deploying to Vercel or Netlify and want to benefit from incremental static regeneration, you should now update your route rules:

routeRules: {
--  '/blog/**': { swr: 3000 },
++  '/blog/**': { isr: 3000 },
}

Read the full release notes .

💖 New defaults

Rich JSON payload serialisation is now enabled by default (#19205 , #20770 ). This is both faster and allows serialising complex objects in the payload passed from the Nuxt server to client (and also when extracting payload data for prerendered sites).

This now means that various rich JS types are supported out-of-the-box: regular expressions, dates, Map and Set and BigInt as well as NuxtError - and Vue-specific objects like ref, reactive, shallowRef and shallowReactive.

You can find an example in our test suite.

This is all possible due to Rich-Harris/devalue#58 . For a long time, Nuxt has been using our own fork of devalue owing to issues serialising Errors and other non-POJO objects, but we now have transitioned back to the original.

You can even register your own custom types with a new object-syntax Nuxt plugin:

plugins/custom-payload-type.ts
export default definePayloadPlugin(() => {
  definePayloadReducer('BlinkingText', data => data === '<original-blink>' && '_')
  definePayloadReviver('BlinkingText', () => '<revivified-blink>')
})

You can read more about how this works here .

🛝 Interactive server components

This feature should be considered highly experimental, but thanks to some great work from @huang-julien we now support interactive content within server components via slots (#20284 ).

You can follow the server component roadmap at #19772 .

⏰ Environment config

You can now configure fully typed, per-environment overrides in your nuxt.config:

export default defineNuxtConfig({
  $production: {
    routeRules: {
      '/**': { isr: true }
    }
  },
  $development: {
    //
  }
})

If you're authoring layers, you can also use the $meta key to provide metadata that you or the consumers of your layer might use.

Read more: #20329 .

💪 Fully typed pages

You can benefit from fully typed routing within your Nuxt app via this experimental integration with https://github.com/posva/unplugin-vue-router - thanks to some great work from @posva ! Out of the box, this will enable typed usage of navigateTo, <NuxtLink>, router.push() and more. You can even get typed params within a page by using const route = useRoute('route-name').

export default defineNuxtConfig({
  experimental: {
    typedPages: true
  }
})

🔎 'Bundler' module resolution

We now have full support within Nuxt for the bundler strategy of module resolution . We would recommend adopting this if possible. It has type support for subpath exports, for example, but more exactly matches the behaviour of build tools like Vite and Nuxt than Node16 resolution.

export default defineNuxtConfig({
  typescript: {
    tsConfig: {
      compilerOptions: {
        moduleResolution: 'bundler'
      }
    }
  }
})

This turns on TypeScript's ability to 'follow' Node subpath exports. For example, if a library has a subpath export like mylib/path that is mapped to mylib/dist/path.mjs then the types for this can be pulled in from mylib/dist/path.d.ts rather than requiring the library author to create mylib/path.d.ts.

⚗️ Separate server types

We plan to improve clarity within your IDE between the 'nitro' and 'vue' part of your app, and we've shipped the first part of this via a separate generated tsconfig.json for your ~/server directory (#20559 ). You can use by adding an additional ~/server/tsconfig.json with the following content:

{
  "extends": "../.nuxt/tsconfig.server.json"
}

Although right now these values won't be respected when type checking, you should get better type hints in your IDE.

💀 Deprecations

Although we have not typed or documented the build.extend hook from Nuxt 2, we have been calling it within the webpack builder. We are now explicitly deprecating this and will remove it in a future minor version.

✅ Upgrading

As usual, our recommendation for upgrading is to run:

nuxi upgrade --force

This will refresh your lockfile as well, and ensures that you pull in updates from other dependencies that Nuxt relies on, particularly in the unjs ecosystem.

👉 Changelog

compare changes

🚀 Enhancements

  • kit: Add prepend option to addImportsDir (#20307 )
  • nuxt: Add scoped helper for clearing error within boundary (#20508 )
  • nuxt: Auto import 'watchPostEffect' and 'watchSyncEffect' from vue (#20279 )
  • vite: Introduce vite:configResolved hook (#20411 )
  • webpack: Introduce webpack:configResolved hook (#20412 )
  • kit: Allow vite and webpack plugins to be prepended (#20403 )
  • nuxt: Add layer meta and env overrides to config types (#20329 )
  • test-utils: Add option to configure test server port (#20443 )
  • nuxt: Allow access to components within app (#20604 )
  • kit: Support passing getter to addVitePlugin and addWebpackPlugin (#20525 )
  • cli: Allow greater control of nuxi analyze from cli (#20387 )
  • nuxt: Add nuxtApp.runWithContext (#20608 )
  • deps: Upgrade to nitropack v2.4 (#20688 )
  • nuxt: Add experimental typedPages option (#20367 )
  • nuxt: Add apps to nuxt build-time instance (#20637 )
  • cli: Allow passing overrides to other nuxi commands (#20760 )
  • schema: Enable rich json payloads by default (#20770 )
  • deps: Update vue to v3.3 (#20478 )
  • nuxt: Use runWithContext within callWithNuxt (#20775 )
  • nuxt: Add useRequestURL helper (#20765 )
  • nuxt: Allow fallback production content in <DevOnly> (#20817 )
  • kit: addBuildPlugin for builder-agnostic implementation (#20587 )
  • nuxt: Allow keeping fallback for NuxtClientFallback (#20336 )
  • nuxt: Support separate server tsconfig (#20559 )
  • nuxt: Full scoped slots support for server components (#20284 )
  • nuxt: Support parallel plugins (#20460 )

🩹 Fixes

  • nuxt: Remove backwards-compatible runtimeConfig proxy (#20340 )
  • nuxt: Add @nuxt/devtools module before core modules (#20595 )
  • nuxt: Properly handle query for component wrapper (#20591 )
  • nuxt: Skip payload extraction for island context (#20590 )
  • nuxt: Remove internal <FragmentWrapper> (#20607 )
  • nuxt: Ensure useError is called with nuxt app context (#20585 )
  • nuxt: Run page meta plugin on all pages (and only pages) (#20628 )
  • nuxt, vite: Ignore nuxt_component ssr style and isVue (#20679 )
  • webpack: Warn when using deprecated build.extend hook (#20605 )
  • nuxt: Allow resolving client nuxt app to singleton (#20639 )
  • nuxt: Generate empty sourcemaps for wrappers (#20744 )
  • nuxt: Prevent treeshaking hooks with composable names (#20745 )
  • kit: Prefer esm resolution for modules to install (#20757 )
  • vite: Expand fs.allow dirs to include app files (#20755 )
  • nuxt: Deduplicate global components before registration (#20743 )
  • nuxt: Remove webstorm compatibility augmentation (0258acdc8 )
  • nuxt: Enable suspensible behaviour for nested pages (#20777 )
  • cli: Hard-reload nuxt when .env changes (#20501 )
  • nuxt: Avoid destructuring error prop (works around upstream bug) (#20795 )
  • nuxt: Always inline styles for server/island components (#20599 )
  • nuxt: Allow serialising undefined refs (#20828 )
  • nuxt: Transform client fallbacks directly on SFCs (#20835 )
  • vite: Dedupe/optimize more vue core deps (#20829 )
  • nuxt: Get fallback for <DevOnly> from parsed html (#20840 )
  • nuxt: Ensure all dir parts are present in component name (#20779 )
  • nuxt: Allow pages:extend to enable pages module (#20806 )
  • nuxt: Stop loading indicator on vue errors (#20738 )
  • nuxt: Add types for webpack/vite environments (#20749 )
  • nuxt: Pass from + savedPosition to first scrollBehavior (#20859 )

💅 Refactors

  • schema: Move runtimeCompiler option out of experimental (#20606 )
  • kit: Use esm utils for resolvePath (#20756 )

📖 Documentation

  • Fix typo (#20577 )
  • Update tailwind configuration guide (#20598 )
  • Fix fetch composable examples (#20603 )
  • Note that useCookie does not share state (#20665 )
  • Selective pre-rendering options (#20670 )
  • Ensure we guard all navigateTo examples (#20678 )
  • Add useSeoMeta and useServerSeoMeta pages (#20656 )
  • Recommend <NuxtLayout> when migrating error.vue (#20690 )
  • Add lagon to presets list (#20706 )
  • Add await before lazy composable examples (7e7e006e9 )
  • Add missing step migrating to pinia (#20778 )
  • Server directory improvements (d53cc604d )

🏡 Chore

✅ Tests

  • Test with bundler module resolution (#20629 )

🤖 CI

❤️ Contributors

Version v3.4.3

Released on April 28, 2023

3.4.3 is a patch release with the latest bug fixes. 🐞 It is expected that the next release will be v3.5, in approximately two weeks' time.

✅ Upgrading

As usual, our recommendation for upgrading is to run:

nuxi upgrade --force

This will refresh your lockfile as well, and ensures that you pull in updates from other dependencies that Nuxt relies on, particularly in the unjs ecosystem.

👉 Changelog

compare changes

🩹 Fixes

  • nuxt: Don't call timeEnd unless we're debugging (#20424 )
  • nuxt: Use key to force server component re-rendering (#19911 )
  • nuxt: Add basic typings for <ClientOnly> (f1ded44e8 )
  • nuxt: Use event.node.req in cookie utility (#20474 )
  • deps: Relax upper node version constraint (#20472 )
  • nuxi,schema: Support devServer.https: true (#20498 )
  • nuxt: Throw 404 when accessing /__nuxt_error directly (#20497 )
  • nuxt: Use callAsync for executing hooks with context (#20510 )
  • nuxt: Improved typing support for app config (#20526 )
  • nuxt: Call app:error in SSR before rendering error page (#20511 )
  • nuxt: Restrict access to single renderer outside of test/rootDir (#20543 )
  • nuxt: Throw errors when running legacy asyncData (#20535 )
  • nuxt: Transform #components imports into direct component imports (#20547 )
  • nuxt: Return RenderResponse for redirects (#20496 )

📖 Documentation

  • Fix typos on docs homepage (#20456 )
  • Update links to vue-router docs (#20454 )
  • Remove RC reference and add link to vue migration build (#20485 )
  • Add cdn proxy section (#20408 )
  • Add a next steps link to first page of migration docs (#20512 )
  • Add custom fetch composable example (#20115 )
  • Adjust wrong link after repo migration (#20536 )

✅ Tests

🤖 CI

  • Publish edge release with provenance (ec1503731 )
  • Run release script with node 18 (0d10e9734 )
  • Try releasing nuxt-edge with provenance (753c4c2a3 )
  • Run nuxt2 nightly release on node 14 again (48c034cf0 )

❤️ Contributors

Version v3.4.2

Released on April 20, 2023

3.4.2 is a patch release with the latest bug fixes and performance improvements

✨ What's new?

Apart from the normal bug fixes, we have a couple things we should call out.

  1. 🔥 We're now on Vite 4.3 (#20405 ). This was a performance-focused release and hopefully you'll be enjoying the speed improvements! Check out the release announcement for more info.
  2. 👀 It's now possible to experimentally enable @parcel/watcher for the Nuxt dev watcher (#20179 ). This may improve performance if you're on Windows. You'll probably also want to install watchman in that case.

✅ Upgrading

As usual, our recommendation for upgrading is to run:

nuxi upgrade --force

This will refresh your lockfile as well, and ensures that you pull in updates from other dependencies that Nuxt relies on, particularly in the unjs ecosystem.

👉 Changelog

compare changes

🔥 Performance

  • nuxt: Share lazy component definitions (#20259 )
  • Remove unused deps and add implicit deps (#20356 )
  • Allow using @parcel/watcher for dev watcher (#20179 )

🩹 Fixes

  • vite: Set different cache dirs for client/server (#20276 )
  • nuxt: Generate hi-res sourcemaps (#20280 )
  • nuxt: Return type directly if not picking asyncData (#20288 )
  • nuxt: Provide more helpful error when instance unavailable (#20289 )
  • nuxt: Mark useRequestHeaders keys as optional (#20286 )
  • vite: Avoid serving arbitrary file in vite-node middleware (#20345 )
  • nuxt: Swap preloads for json/js payloads (#20375 )
  • nuxt: Handle pages with no content and log warning (#20373 )
  • test-utils: Import jest functions from @jest/globals (#20360 )
  • core,kit: Ensure module transpilation paths are dirs (#20396 )
  • schema: Rely on installed telemetry types (#19640 )
  • cli: Load kit from rootDir when preparing project (#20401 )
  • nuxt: Clone app config on server (#20278 )

💅 Refactors

  • nuxt: Rework and use isJS and isVue utilities consistently (#20344 )
  • vite: Use native isFileServingAllowed util (#20414 )

📖 Documentation

  • Update links on hooks page (#20296 )
  • Add brief information on debugging a nuxt app (#20282 )
  • Fix vue-tsc link (#20350 )
  • Update lint command for the documentation (#20399 )

🏡 Chore

🤖 CI

❤️ Contributors

Version v3.4.1

Released on April 13, 2023

3.4.1 is a patch release. We've pulled it forward slightly to fix a couple of breaking bugs in 3.4.0.

👉 Changelog

compare changes

🩹 Fixes

  • nuxt: Set config on ssrContext in spa renderer (#20216 )
  • nuxt: Mark entire payload as reactive (#20218 )
  • nuxt: Add missing imports to <NuxtClientFallback> (#20237 )
  • nuxt: Improve handling of redirects within middleware (#20244 )
  • nuxt: Do not redirect when vue-router normalises url (#20247 )

📖 Documentation

  • Add a brief description of transform/pick (#20186 )

✅ Tests

  • Add js payload test suite (#20217 )

❤️ Contributors

Version v3.4.0

Released on April 11, 2023

3.4.0 is a minor (feature) release for Nuxt 3 bringing exciting new features, including support for the View Transitions API, transferring rich JavaScript payloads from server to client - and much more.

👀 Highlights

🪄 View Transitions API Support

https://user-images.githubusercontent.com/904724/231222082-6bd4aeae-3026-407e-b3be-658df6305748.mp4


You can see a demo on https://nuxt-view-transitions.surge.sh

You may have noticed that Chromium-based browsers now ship a new web platform API: the View Transitions API . This is an exciting new ability for native browser transitions which (among other things) have the ability to transition between unrelated elements on different pages.

Nuxt now ships with an experimental implementation, which will be under active development during the v3.4 release cycle. See the known issues in the linked PR .

export default defineNuxtConfig({
  experimental: {
    viewTransition: true
  }
})

✨ Payload Enhancements

We've merged a significant change to how Nuxt handles payloads (under an experimental flag). Payloads are used to send data from the server to the client when doing server-side rendering and avoid double data-fetching during the hydration phase.

nuxt.config.ts
export default defineNuxtConfig({
  experimental: {
    renderJsonPayloads: true
  }
})

With this new option enabled, this now means that various rich JS types are supported out-of-the-box: regular expressions, dates, Map and Set and BigInt as well as NuxtError - and Vue-specific objects like ref, reactive, shallowRef and shallowReactive.

You can find an example in our test suite.

This is all possible due to Rich-Harris/devalue#58 . For a long time, Nuxt has been using our own fork of devalue owing to issues serialising Errors and other non-POJO objects, but we now have transitioned back to the original.

You can even register your own custom types with a new object-syntax Nuxt plugin:

plugins/custom-payload-type.ts
export default definePayloadPlugin(() => {
  definePayloadReducer('BlinkingText', data => data === '<original-blink>' && '_')
  definePayloadReviver('BlinkingText', () => '<revivified-blink>')
})

You can read more about how this works here .

Note: this only affects payloads of the Nuxt app, that is, data stored within useState, returned from useAsyncData or manually injected via nuxtApp.payload. It does not affect data fetched from Nitro server routes via $fetch or useFetch although this is one area I am keen to explore further.

Preliminary testing shows a significant speed-up: 25% faster in total server response time for a very minimal app with a large JSON payload, but I'd urge you to run your own tests and share the results with us.

As mentioned, we're merging this behind a flag so we can test this broadly and gather feedback on the new approach. The most significant potential change is that the payload is now no longer available on window.__NUXT__ immediately. Instead, we now need to initialise the Nuxt app to parse the payload so any code that accesses __NUXT__ will need to be run in a plugin or later in the Nuxt app lifecycle. Please feel free to raise an issue if you foresee or encounter issues in your projects.

🎁 Object-syntax Nuxt plugins

We now support object-syntax Nuxt plugins for better control over plugin order and easier registration of hooks.

plugins/my-plugin.ts
export default defineNuxtPlugin({
  name: 'my-plugin',
  enforce: 'pre', // or 'post'
  async setup (nuxtApp) {
    // this is the equivalent of a normal functional plugin
  },
  hooks: {
    // You can directly register Nuxt app hooks here
    'app:created'() {
      const nuxtApp = useNuxtApp()
      // 
    }
  }
})

In future we plan to enable build optimizations based on the metadata you pass in your Nuxt plugins.

🛠️ Easier Devtools Configuration

It's even easier to enable Nuxt DevTools in your project: just set devtools: true in your nuxt.config file to enable devtools.

nuxt.config.ts
export default defineNuxtConfig({
  devtools: true
})

If it's not already installed, Nuxt will prompt to install it locally. This means you no longer need to have Nuxt DevTools enabled globally.

Note: the DevTools is still experimental and under active development, so do be prepared for occasional unexpected behaviour, and please report issues directly to https://github.com/nuxt/devtools 🙏

📚 Layers Improvements

We now support transforming ~/~~/@/@@ aliases within layers , meaning you now no longer need to use relative paths when importing within layers.

This should mean it is much easier to use a 'normal' Nuxt project as a layer without needing to specially write it as one.

🧸 Better Context Transforms

We now transform certain keys of definePageMeta and defineNuxtComponent which means you should have fewer issues with a missing Nuxt instance. This includes support accessing the Nuxt instance after an await within asyncData and setup functions for those still using the Options API. And you no longer need to wrap middleware and validate with defineNuxtRouteMiddleware when using async functions.

♻️ Ecosystem Updates

As usual, this release will pull in upstream improvements, including the new Consola v3 and Nitropack v2.3.3 (a new minor is expected shortly).

🚨 'Breaking fixes'

We've also taken the opportunity to do some cleanup in this minor release.

  1. Previously it was possible to pass the x-nuxt-no-ssr header (undocumented) to force SPA rendering. We've now disabled this behaviour by default but you can get it back by setting experimental.respectNoSSRHeader to true. Alternatively, you can set event.context.nuxt.noSSR on the server to force SPA rendering.
  2. We've removed the (deprecated) #head alias and also disabled the polyfill for @vueuse/head behaviour by default. (It can still be enabled with experimental.polyfillVueUseHead.)
  3. We've removed the (deprecated) experimental.viteNode option . It can be configured instead with vite.devBundler.
  4. We've deprecated accessing public runtime config without the public key . This was an undocument compatibility measure with Nuxt 2 and we plan to remove it entirely in v3.5.
  5. To fix a bug with our vue-router integration, we now generate a slightly different path matching syntax. If you were relying on the exact path generated, have a look at #19902 for more information.

✅ Upgrading

As usual, our recommendation for upgrading is to run:

nuxi upgrade --force

This will refresh your lockfile as well, and ensures that you pull in updates from other dependencies that Nuxt relies on, particularly in the unjs ecosystem.

With Nuxt v3.4.0, we now advise that you explicitly install the @types/node version that matches your Node version.

👉 Changelog

compare changes

🚀 Enhancements

  • nuxt: Warn in dev when useRoute is used in middleware (#20050 )
  • nuxt: Support disabling watch with useFetch (#19823 )
  • nuxt: Support ~/~~/@/@@ aliases within layers (#19986 )
  • nuxt: Respect custom dir.pages in page placeholder (#20079 )
  • nuxt: Support vue runtime compiler (#4762 )
  • test-utils: Allow mounting single component for testing (#5723 )
  • nuxt: Experimental option for rich json payloads (#19205 )
  • nuxt: Prompt to install devtools when it's enabled (#20126 )
  • Upgrade to consola v3.x prerelease (#20141 )
  • nuxt: Add experimental View Transitions API support (#20092 )
  • nuxt: Support async transform of object properties (#20182 )
  • nuxt: Support object-syntax plugins (#20003 )
  • nuxt: Add experimentalNoScripts route rule (#19805 )
  • nuxt: Add chokidar watcher debug timing (#20176 )

🔥 Performance

  • head: Disable @vueuse/head polyfill by default (#20131 )

🩹 Fixes

  • nuxt: End route param tokens manually (#19902 )
  • nuxt: Disable x-nuxt-no-ssr header by default (#20024 )
  • kit: Support calling Nuxt 2 modules with module container (#20023 )
  • nuxt: Add types for globally injected $config object (#20081 )
  • nuxt: Throw error on protocol relative path in useFetch (#20052 )
  • nuxt: Add @types/node as a peerDependency (#20025 )
  • nuxt: Test all custom app config keys for any (#20105 )
  • nuxt: Add key to .client component placeholders (#20093 )
  • nuxt: Add undefined type for useCookie return value (4f0b3c722 )
  • nuxt: Deprecate old (pre-rc) runtimeConfig (#20082 )
  • cli: Preview nitro build with custom dir config (#18882 )
  • nuxt: Default nitro autoImports to imports.autoImport (#20180 )
  • nuxi, vite: Suppress sourcemap + native fetch warnings (#20198 )
  • schema: Allow ignorePrefix to be changed (#20202 )

💅 Refactors

  • schema: Clean up experimental options (#20112 )
  • nuxt: Remove #head alias (#20111 )

📖 Documentation

  • Add interop default to dynamic vue import example (8908aa7c5 )
  • Add short note about custom imports configuration (#20073 )
  • Re-enable docs linting and update docs (#20084 )
  • Fix type of headers option for useFetch (#20148 )
  • Fix typo in @pinia/nuxt module name (#20199 )
  • Add import to server-side cookies example (#20197 )

🏡 Chore

✅ Tests

🎨 Styles

🤖 CI

❤️ Contributors

Version v3.3.3

Released on April 2, 2023

3.3.3 is your regularly scheduled bugfix/patch release.

✅ Upgrading

As usual, our recommendation for upgrading is to run:

nuxi upgrade --force

This will refresh your lockfile as well, and ensures that you pull in updates from other dependencies that Nuxt relies on, particularly in the unjs ecosystem.

👉 Changelog

compare changes

🩹 Fixes

  • schema: Prefer src to rootDir aliases (#19937 )
  • nuxt: Don't override options signature with schema (#19934 )
  • vite: Allow extending vue config per-environment (#19968 )
  • nuxt: Store payloads in cache without trailing slash (#19992 )
  • webpack: Transpile rest of nuxt runtime directories (#19936 )
  • nuxt: Suppress handled errors (#20002 )
  • vite: Remove separate rollup dependency (#20013 )
  • nuxt: Sync setResponseStatus signature with h3 (#19987 )
  • schema: Add export condition for nuxt2 support (1fd491f1a )

💅 Refactors

  • vite: Use rollup types re-exported from vite (#20011 )

📖 Documentation

🏡 Chore

✅ Tests

  • Skip bundle size test in ecosystem-ci suites (434e2013e )
  • Bump bundle size test by 100 bytes (5785908ec )

🤖 CI

❤️ Contributors

Version v3.3.2

Released on March 24, 2023

3.3.2 is a patch release with plenty of bug fixes.

✅ Upgrading

As usual, our recommendation for upgrading is to run:

nuxi upgrade --force

This will refresh your lockfile as well, and ensures that you pull in updates from other dependencies that Nuxt relies on, particularly in the unjs ecosystem.

👉 Changelog

compare changes

🔥 Performance

  • nuxt: Experimentally disable vue server renderer nitro endpoint (#19825 )

🩹 Fixes

  • kit: Provide name to performance.mark() (#19687 )
  • nuxt: Unpause DOM updates on suspense resolve (#19740 )
  • kit: Handle node 14 performance behaviour (#19733 )
  • webpack: Transpile app directory (#19773 )
  • nuxt: Unset context after app is created (#19753 )
  • cli: Watch dist and register restart hook after nuxt is ready (#19736 )
  • nuxt: Ignore falsy modules (#19684 )
  • nuxt: Use h3 utilities to set response status/code (#19713 )
  • nuxt: Add temporary augmentation for webstorm (and docs) (#19400 )
  • nuxt: Handle external navigation to api routes (#19829 )
  • nuxt: Observe slot element in custom nuxt-link (#19802 )
  • nuxt: Directly render server components (#19605 )
  • vite: Support multiple rollup entries (#19842 )
  • nuxt: Ignore schema types that eval to any (#19835 )
  • nuxt: Use prerender cache for islands (#19822 )
  • nuxt: Add missing import in islands template (#19870 )
  • kit: Check if nuxt is restarting before updating templates (#19830 )
  • test-utils: Allow overriding nitro options (#19872 )
  • kit: Add legacy entrypoints for pre v3.3 usage (#19874 )

📖 Documentation

  • Fix auto-imports example (#19520 , #19690 )
  • Update seo and meta page (#19697 )
  • introduction: First batch of improvements (98b9afa6d )
  • Update module author guide (#18551 )
  • Add 'going further' section for custom routing (#19565 )
  • Improve installation prerequisites (c570ae272 )
  • Update custom routing link (8d644903b )
  • Add backticks (#19721 )
  • Add link to layout transitions (#19770 )
  • Fix typo (#19775 )
  • Fix typo (#19779 )
  • Fix typo (#19785 )
  • Add missing comma (#19791 )
  • Update legacy server examples (#19797 )
  • Third-party state management and migration guide (#19798 )
  • Link to module request issue template (#19754 )
  • Improve swr documentation (#18743 )
  • Add another example for useAsyncData (#19225 )
  • Avoid $fetch in top-level <script setup> (#19357 )
  • Removing deprecated coming soon banner (#19817 )
  • Add serialization section to data fetching (#19336 )
  • Add protocol to superjson link (cebfcb3da )
  • Update play on X links (8c11498a5 )
  • Add missing return statement (fc7867fb0 )
  • Replace @nuxt/kit example with node built-ins (#19873 )
  • Add layers video by LearnVue (d3d09d5d3 )
  • Improve components page (340725bb0 )

🏡 Chore

✅ Tests

🤖 CI

❤️ Contributors

Version v3.3.1

Released on March 14, 2023

3.3.0 is a minor (feature) release with lots of new features to play with. 3.3.1 was a swiftly following release to patch an issue with nuxi on Windows.

👀 Highlights

✨ Local module development DX

We've landed a raft of changes to enable local modules and improve DX. We now auto-scan your ~/modules folder and register top level files there as modules in your project (#19394 ). When these files are changed, we'll automatically restart the nuxt server.

  export default defineNuxtConfig({
    modules: [
      '@nuxtjs/tailwindcss',
-     '~/modules/purge-comments'
    ]
  })

We also now expose nuxt/kit for easy access to kit composables in your local project without having to install @nuxt/kit (#19422 ).

♻️ Restarting Nuxt

You can add files to the watch array to automatically restart the server (#19530 ). This is likely to be particularly useful for module authors. You can also trigger a restart of the Nuxt server with the new restart hook (#19084 ). We also landed a couple of fixes on restarting the Nuxt server which should improve your experience when developing.

🔥 Performance improvements

We've increased static asset maxAge to 1yr as a matter of best practice (#19335 ), and support tree-shaking more of your build (#19508 ). We also now support preloading <NuxtLink>s with a route in object-syntax (#19120 ).

CleanShot 2023-03-14 at 12 19 50

We also track how long it takes each module you use to perform its setup, and warn if it takes too long. You can see all these values by running your dev server with DEBUG=1

You can also opt-in to some of Nuxt's internal optimisations by configuring composables to be treeshaken in a particular environment (#19383 ), or to have magic keys automatically injected (#19490 ) - primarily useful for module authors.

🐛 Error handling

We now handle chunk errors by default (#19086 ), meaning if your site updates with a redeploy, we automatically handle reloading it on navigation. You can disable this and handle it yourself with the new reloadNuxtApp composable. You can also set experimental.restoreState to preserve some of your app state across reloads.

We also have a new experimental error handling component: <NuxtClientFallback> (nuxt/framework#8216 ) which can capture errors rendering on server, replace them with fallback content, and granularly trigger rerendering the part with an error on the client. This can be enabled with experimental.clientFallback - feedback very welcome!

⚡️ Head improvements

We've migrated to use unhead directly (#19519 ) - and automatically tree-shake server-only head composables like useServerHead from your client build (#19576 ), meaning you can have great SEO without needing to include meta tag logic that's relevant only for crawlers in your client build.

There's also a new useHeadSafe composable that handles santising untrusted user input (#19548 ).

🪵 Better logging in browser DevTools

Working with the Chrome DevTools team, we've landed a couple of features across the unjs + Nuxt ecosystem meaning we now have first-class support for hiding Nuxt internal stack traces from logs in your (Chromium-based, for now) browser (#19243 ). We also landed a couple of improvements with stacktraces involving Nuxt hooks (unjs/hookable#69 and unjs/hookable#68 ) implementing console.createTask .

Before After
CleanShot 2023-03-14 at 11 55 00 CleanShot 2023-03-14 at 11 52 27

💪 Type improvements

Types for server API routes are now more correct - with non-serialisable types stripped out of the return type (unjs/nitro#1002 ).

We also now type more of NuxtApp and correctly type unknown injections for greater type-safety (#19643 ).

CleanShot 2023-03-14 at 11 59 58

And if you were struggling with correct types when using transform + default with Nuxt data fetching composables, fear no more - we now infer the types correctly (#19487 ).

⚗️ Nitro enhancements

This release comes with Nitro v2.3, which brings lots of improvements of its own. Check out the release for more info.

We now support useAppConfig in nitro server routes (#19489 ) - a long-awaited change. Now useAppConfig is consistently available throughout your app for non-runtime configuration from layers, modules, etc.

We've also added a nitro:build:public-assets hook to allow modifying assets output from nitro's prerender/build phase (#19638 ).

🛠️ Build changes

As part of moving towards first-class support for PNP and pnpm support without --shamefully-hoist , we've dropped support for some internal (deprecated) utilities using CJS resolve patterns (#19537 , #19608 ). We also now resolve dependencies like nuxt, @nuxt/kit and more using ESM search-paths. We'll be keeping a close eye on this.

We're also preparing the groundwork for support of new TypeScript Node16 module resolution (#19606 ), and as part of this have changed the format of our runtime output (using .js instead of .mjs extensions, providing types fields for subpath exports, and more).

🗺️ Custom config schema (advanced)

We've been testing out an experimental feature to allow modules and users to extend the Nuxt config schema (#15592 ), and we've now enabled this by default (#19172 ). We expect this will be particularly useful for module and layer/theme authors, and should result in some nicer DX for their users.

Changelog

compare changes

🚀 Enhancements

  • nuxi: Enforce consistent casing in filenames (#19088 )
  • nuxi: Reload nuxt when restart hook is called (#19084 )
  • nuxt: Scan composables with star export (#19249 )
  • nuxt: Add versions to runtime nuxtApp (#19064 )
  • vite: Add node_modules and buildDir to x_google_ignoreList (#19243 )
  • nuxi: Cli wrapper for self restart (#18641 )
  • schema: Allow adding page routes without a matching file (#19173 )
  • nuxt: Add support for nuxt/kit subpath for local use (#19422 )
  • nuxt: Auto-register modules in ~/modules (#19394 )
  • nuxt: Enable config schema by default (#19172 )
  • kit,nuxt: Add component priority to allow overriding (#19252 )
  • nuxt: Enable preloading object-syntax routes (#19120 )
  • nuxt: Support trailingSlashBehavior in defineNuxtLink (#19458 )
  • nuxt: Allow configuring treeshakeable composables (#19383 )
  • nuxi,schema: Add support for setting nuxt logLevel (#19369 )
  • nuxt: Support custom keyed composables (#19490 )
  • nuxi: Programmatically pass nuxt config overrides (to dev) (#19371 )
  • vite: Use custom logger to show vite logs (#19523 )
  • nuxt: Enable chunk error handling by default (#19086 )
  • nuxt: Add <NuxtClientFallback> component (#8216 )
  • nuxt: Add watch option and refactor dev server restarting (#19530 )
  • nuxt: Add useHeadSafe and remove layer around head imports (#19548 )
  • kit, schema: Measure module setup timings (#18648 )
  • nuxt: Support app config for server routes (#19489 )
  • nuxt: Add nitro:build:public-assets hook (#19638 )

🔥 Performance

  • nuxt: Increase static asset maxAge to 1yr (#19335 )
  • vite: Mark more core functions as side-effect free (#19508 )
  • nuxt: Drop @vueuse/head dependency (#19519 )
  • nuxt: Tree-shake server composables + prefer server head (#19576 )

🩹 Fixes

  • nuxt: Clear loading indicator on unmount (#19340 )
  • nuxt: Deprecate scanning directory index plugins (#18418 )
  • nuxt: Prevent fallthrough attributes on custom NuxtLink (#19379 )
  • schema: Update vite import.meta types (#19338 )
  • vite: Omit / from sourcemapIgnoreList for windows support (73ade185b )
  • nuxt: Pass transform options to component loader plugin (#19414 )
  • nuxi: Avoid top-level await in wrapper (44068420d )
  • nuxt: Add kit.* files to published package (#19430 )
  • nuxt: Don't print layout warning if page is not ssr (#19434 )
  • kit: Match commit hashes of other lengths (#19450 )
  • nuxi: Handle different kind of shutdown signals (#19485 )
  • nuxt: Exclude nitro output dir from type checking (#19532 )
  • vite: Allow disabling clear screen behaviour (#19531 )
  • nuxt: Only log boot errors on client-side (#19553 )
  • nuxt: Dedupe payload cache by payload url (#19563 )
  • nuxt: Provide node16-style type exports (#18431 )
  • nuxt: Avoid injecting adhoc modules in schema (#19607 )
  • nuxt: Improve types for data fetching with transform (#19487 )
  • nuxi: Resolve kit from nuxt modules dir (#19601 )
  • nuxt,schema: Merge custom and resolved app configs (#19602 )
  • nuxt: Resolve builder using esm syntax (#19608 )
  • nuxt: Exclude boolean from inline module definitions (#19621 )
  • schema: Show payloadExtraction warning only when unset (#18516 )
  • nuxt: Mark non-augmented NuxtApp properties as unknown (#19643 )
  • nuxt: Fix default injection type for plugins (#19669 )

💅 Refactors

  • nuxi: Hard restart with communication channel (#19423 )
  • kit,nuxi: Resolve module paths using node algorithm (#19537 )
  • nuxt: Let mlly handle search paths (#19635 )

📖 Documentation

  • Use consistent indentation in examples (#19342 )
  • Update esm link (c35104c76 )
  • Add frontmatter note for docs readme to remove from live preview (008426cd3 )
  • Add edge banners on versions and modules (#19448 )
  • Add local modules ordering (5977adb4d )
  • Fix link to nitro routeRules (#19455 )
  • Fix dead link to useSeoMeta guide (#19463 )
  • Update devServer.https example (#19486 )
  • Add info ~/server/utils directory in ~/utils page (#19500 )
  • Update addComponent jsdoc comment (#19503 )
  • Update cli docs for --log-level (06b9233b1 )
  • Update pr template to include jsdoc annotations (#19511 )
  • Add new release cycle info (#19509 )
  • Fix local modules (c4222b1f6 )
  • Update nitro plugins url (#19547 )
  • Ui components - pinceau migration (#19533 )
  • Update $fetch documentation (#19356 )
  • Move prerequisites into a summary (e0cb950f0 )
  • Remove note since already in code block for pnpm (d67a873c4 )
  • Add nuxt 2 to nuxt 3 workshop (2905282de )
  • Update various nitro links (#19562 )
  • Use consistent page name in example (#19583 )
  • Add missing backquotes (#19590 )
  • Remove reference to beta/rc/coming soon (4ad5c959e )
  • Warn about modules with side-effects (#19592 )
  • Mention config file name before code block (#19634 )

🏡 Chore

  • Bump edge version based on commits (#19397 )
  • Add branch to edge release script (171288586 )
  • Add chore to type of change in pr template (#19420 )
  • Mark @nuxt/test-utils package as external group (#19419 )
  • Restrict commit hash strings to 8 chars (abcd27ae0 )
  • deps: ⚠️ Update dependency fork-ts-checker-webpack-plugin to v8 (main) (#19468 )
  • Force minor bumps at most (0b82f6751 )
  • nuxt: Update to new hasProtocol options format (#19555 )
  • Improve internal type safety (#19599 )
  • Refresh lockfile (#19653 )
  • Constrain nitro to minor version (88a5f38de )
  • Bump package versions (615750614 )

✅ Tests

🤖 CI

⚠️ Breaking Changes

  • deps: ⚠️ Update dependency fork-ts-checker-webpack-plugin to v8 (main) (#19468 )

❤️ Contributors

Version v3.2.3

Released on February 28, 2023

3.2.3 is a patch release with bug fixes and performance improvements.

👉 Changelog

compare changes

🔥 Performance

  • nuxt: Don't update manifest in dev mode (#19315 )

🩹 Fixes

  • cli: Restart nuxt when distDir is unlinked (#19131 )
  • vite: Normalize path emitted by vite watcher (#19179 )
  • nuxt: Prefetch object-syntax routes with <NuxtLink> (#19144 )
  • webpack: Use default export from webpack (#19166 )
  • nuxt: Preserve (re)named imports in meta (#19192 )
  • nuxt: Log errors thrown when booting the nuxt app (#19187 )
  • nuxt: Preserve explicit rel attribute on internal link (#19309 )
  • nuxt: Compatible route object for custom external routes (#19261 )
  • vite: Handle non-iterable noExternal option (#19256 )

📖 Documentation

  • Fix components path (#19163 )
  • pages: Add example of limiting scanned routes (#19181 )
  • Update link (#19197 )
  • Clarify that app config is not available (yet) in nitro (#19200 )
  • Improved going further modules documentation (#19219 )
  • Add docs badge (3c006b33c )

🏡 Chore

🤖 CI

❤️ Contributors

Version v3.2.2

Released on February 17, 2023

3.2.1 is a patch release with (lots of) bug fixes and performance improvements since last week's minor release. 3.2.2 was a swiftly following release to patch an issue with nuxi init

👀 Highlights

As a patch release, there are mostly bug fixes and performance improvements in the changelog. (Nevertheless, it's always worth reading through!) But one point of note is an experimental reload strategy when chunk errors are encountered. We're hoping to finalise the API and land it in v3.3 (our next feature release) with #19086 , but you can test out an experimental version with the following config:

export default defineNuxtConfig({
  experimental: {
    emitRouteChunkError: 'reload'
  }
})

With this strategy, your app will hard reload on route changes if there's a chunk error. More info at #19038 .

👉 Changelog

compare changes

🚀 Enhancements

  • nuxt: Add experimental app:chunkError hook and reload strategy (#19038 )

🔥 Performance

  • nuxt: Allow tree-shaking empty meta from build (#19032 )
  • nuxt: Animate transform rather than width (#19073 )
  • nuxt: Don't include side-effects from #components (#19008 )

🩹 Fixes

  • schema: Allow type inference of arrays in runtime config (#18931 )
  • nuxt: Avoid recursive import in nitro renderer (#18948 )
  • nuxt: Expose nuxt/schema subpath for augmentation (#18922 )
  • nitro: Ensure ssr error statusCode is a number (#19001 )
  • nuxt: Prevent hyphens forming child routes & warn if dupes are detected (#18944 )
  • schema: Transpile nuxt/app by default (#19009 )
  • vite: Exclude nuxt/app from optimised deps (9e789c76c )
  • vite: Respect isCustomElement config for jsx transform (#19053 )
  • nuxt: Use parser to treeshake client-only declarations (#18951 )
  • cli: Pass through exit code from test errors (#18959 )
  • nuxt: Show client error if no page matches after validate fails (#18978 )
  • cli: Read devServer options from nuxt config (#19055 )
  • nuxt: Validate no // in path when constructing payload url (#19085 )
  • nuxt: Restore previous check on payload url (e9ff34ace )
  • nuxt: Test generated pathname (af55b9882 )
  • nuxt: Respect redirects which differ only by trailing slash (#18593 )
  • nuxt: Pass nuxt + workspace paths when importing builder (#19099 )

💅 Refactors

  • nuxt: Combine imports from same relative path (ee2f568fc )

📖 Documentation

  • Add info for nuxi devtools command (#18888 )
  • Update link to bridge repo (#18950 )
  • Fix typos (#18976 )
  • Fix typo (#18975 )
  • Fix link to ESM page (#19000 )
  • Fix spacing (#19018 )
  • Flatten top-level project in layers example (#18967 )
  • Remove reference to obsolete static property (80f73d39c )
  • Add note about nested directory order (#19061 )
  • Updated public directory explanation (#18464 )
  • Add information on when mw runs & how to skip (#19083 )
  • Add sendRedirect usage (#19070 )

📦 Build

🏡 Chore

  • Increase node 14 minor version constraint (#19111 )
  • Update nitropack and unjs dependencies (#19100 )
  • Dedupe rollup (576ce9ee3 )

✅ Tests

  • Skip vnode warning on windows dev mode (71bcd9550 )

🤖 CI

  • Run webpack/vite and dev/prod as matrices (#18905 )

❤️ Contributors

Version v3.2.0

Released on February 9, 2023

3.2.0 is the first minor release since we've started our new release schedule. We've brought it forward by a couple of weeks to include some goodies we want you to be able to play with soon.

👀 Highlights

  • ⚡️ Nuxt DevTools

    You can opt-in to Nuxt DevTools per-project by going to the project root and running:

    npx nuxi@latest devtools enable

    Restart your Nuxt server and open your app in browser. Click the Nuxt icon on the bottom (or press Alt+D) to toggle the DevTools.


    More information in the docs !
  • ✨ Better DX for overriding runtimeConfig, including inline type helpers

  • 🪄 Automatically inferred return type for useFetch and $fetch based on method.

    It'll be a type error to use the wrong method when hitting an endpoint.

    Plus, if you have multiple methods served by a single endpoint (like ~/server/api/test.get.ts and ~/server/api/test.post.ts then the response type will match the kind of response you make.

  • 🍪 useFetch is now integrated with event.$fetch, meaning cookies and context are now passed to api requests automagically within internal requests.
  • 🔥 We now treeshake client-only components out of the server build more effectively using the experimental treeshakeClientOnly feature

    This is turned on by default but if you experience any issues, you can turn this off via:

    export default defineNuxtConfig({
  experimental: {
    treeshakeClientOnly: false
  }
})
  • 🛠️ New addRouteMiddleware kit utility for module authors
  • 💪 Nitropack v2.2 has been released

    Lots of features, including runtime proxy support using route rules, nested fetch calls, binary and raw storage operations, exposed event.context.cf (cloudflare) and built-in session support.

    For full details see release notes

Changelog

compare changes

🚀 Enhancements

  • kit: Add addRouteMiddleware method (#18553 )
  • cli: Warn when prerendering routes with ssr: false (#18783 )
  • schema: Add type hints for runtime config (#18652 )
  • nuxt: Support type auto-import (#18859 )
  • nuxt: Infer useFetch return based on the method (#18526 )
  • cli: Add initial support for enabling/disabling devtools (#18864 )
  • nuxt: Upgrade to nitropack 2.2 (#18889 )

🔥 Performance

  • vite: Use stub entry in vite server build when ssr: false (#18782 )

🩹 Fixes

  • nuxt: Treeshake client-only components with placeholders (#8789 )
  • webpack: Client-side typechecking when ssr: false (#18828 )
  • vite: Exclude styles, not all assets (#18752 )
  • nuxt: Defer adding route path to preloaded record (#18862 )
  • nuxt: Don't exclude pnpm layers from nitro esbuild/imports (#9952 )
  • nuxt: Use parser to treeshake <ClientOnly> (#8713 )
  • Reorder the types field in package.json (#18880 )

💅 Refactors

  • nuxt: Within nuxt app, import directly from source file (#18902 )

📖 Documentation

  • Remove extra word (#18750 )
  • example: Fix app config link (#18760 )
  • Add useError composable (#8912 )
  • Clarify augmenting input/output app config (#8953 )
  • Add explanation of composable lifecycle (#8116 )
  • typescript: Type-checking guide (#18768 )
  • schema: Add NuxtHooks interface documentation (#18756 )
  • Resolve preloadRouteComponents page heading error (#18804 )
  • Update to nuxt 2.16.0 in bridge installation (#18836 )
  • Add link to vue hydration mismatch docs (#18842 )
  • Update auto-imports for the server part (#18848 )
  • Warn about slots in server components (#18854 )
  • Add explanation with augmented meta for new routes (#18901 )

✅ Tests

❤️ Contributors

Version v3.1.2

Released on February 3, 2023

3.1.2 is a patch release with bug fixes (particularly focusing on performance and DX).

Changelog

compare changes

🔥 Performance

  • nuxt: Simplify generated variable names (#18629 )
  • vite: Use compiled regexp for test (#18646 )
  • nuxt: Cache result of importing styles module (#18734 )

🩹 Fixes

  • nuxt: Provide fallback values for undefined runtime config (#18586 )
  • kit: Don't use default export of defu (#18589 )
  • Use named export from defu in all places (#18624 )
  • nuxt: Dedupe vue-router (#18626 )
  • test-utils: Prevent orphaned processes and use baseURL when loading (#18623 )
  • vite: Ensure __publicAssetsURL set before loading assets (#18642 )
  • kit: Avoid adding already installed modules to internal _installedModules (#18647 )
  • nuxt: Make onNuxtReady safe to run on server-side (#18706 )
  • vite, webpack: Omit magic keys when import of same name is detected (#18733 )

📖 Documentation

  • Update vue-gtag plugin example (#18528 )
  • Mention virtual file system (#18546 )
  • Mention head composable as alternative to useHead (#18552 )
  • Use defineEventHandler() to avoid warnings (#18557 )
  • Remove unnecessary JSON.stringify() (#18590 )
  • Updated unreachable docus url in documentation (#18618 )
  • Add link to pages documentation to routing (#18602 )
  • Add comment about needing to install @types/node manually (6b2bc680b )
  • Add note about directory import (d2c00dc46 )
  • Fix array syntax (f14f3815f )
  • Fix buttons width on getting started (#18643 )
  • Add .env to directory structure and improve config docs (#18594 )
  • Mention options api equivalent for head() (#18650 )
  • Fix broken link to esm section (#18716 )
  • Improve routing validate example (#18728 )

🏡 Chore

✅ Tests

  • nuxt: Exclude new internal vue assertNumber helper (aa646f065 )

🤖 CI

❤️ Contributors

Version v2.17.1

Released on July 14, 2023

2.17.1 is the next patch release for Nuxt 2.

👉 Changelog

compare changes

🩹 Fixes

  • webpack: Downgrade dev-middleware to fix peer dep issue (#21626 )
  • webpack: Pin webpack-dev-middleware to 5.0.0 (#21804 )

❤️ Contributors

Version v2.17.0

Released on June 9, 2023

2.17.0 is the next minor release for Nuxt 2.

✨ Highlights

Nuxt 2.17 comes with a few new features, including better support for new Vue 2.7 types, and supporting passing postcss config as a function.

It also includes support for Node 20+ and a fix for a dependency issue with the Babel preset that affected new installs.

👉 Changelog

compare changes

🚀 Enhancements

  • types: Support nuxt types for defineComponent (#19789 )
  • csp: Support generating nonce for scripts and links in ssr (#9621 )
  • webpack: Support passing function as postcssOptions (#19495 )

🔥 Performance

  • config: Avoid recursive md4 patching (7fab95252 )

🩹 Fixes

  • Relax node engines upper constraint (010b539ed )
  • utils: Respect patterns within paths when sorting routes (#20669 )
  • vue-app: Skip page render early on error or navigation (#20719 )
  • babel-preset-app: Add explicit dep on used babel plugin (#21488 )

🏡 Chore

✅ Tests

  • Add catchall path to route generation test (71c359516 )
  • Update windows snapshot (4ec274ae2 )
  • Update jest snapshots to remove escaped quotes (f93411c7c )

🤖 CI

  • Run tests in node 16 (#20644 )
  • Pin actions by hash and use corepack (#21356 )

❤️ Contributors

Version v2.16.3

Released on March 17, 2023

2.16.3 is a patch release with bug fixes.

👉 Changelog

compare changes

🩹 Fixes

  • types: Add return type for error() (#19044 )
  • types: Bring types from less into namespace (#19738 )
  • types: Sync vue type augmentations with Vue 2.7 (#19526 )
  • config: Move preset to inner postcssOptions (#19518 )
  • webpack: Add node-fetch-native to externals list (#19755 )

🏡 Chore

  • Release all packages with latest tag except nuxt (4e9dcddcb )
  • examples: Use 2.x version of nuxt instead of latest (#19737 )
  • Lint package files (6ca842e36 )

❤️ Contributors

Version v2.16.2

Released on March 1, 2023

2.16.2 is a patch release with bug fixes.

✨ Highlights

The main change in this patch release is that we now patch the crypto node built-in during build to allow Nuxt 2 to be used on Node versions greater than Node 16, which should ease the pressure users feel after Node 16 reaches its own EOL this year.

Warning This should not be taken for an endorsement of continuing to run with Webpack 4, which is out of date and has a number of dependencies with issues. I expect that number to continue to grow, and we will not be able to resolve all of them. I would strongly urge migrating to Nuxt 3 if possible and the team will do our best to make this possible over the course of the year ❤️

👉 Changelog

compare changes

🚀 Enhancements

  • types: Add basic types for Nuxt interface (#9772 )

🩹 Fixes

  • vue-renderer: Insert charset before title (#18998 )
  • types: Remove non-existent properties from context (#19021 )
  • Add minimum node 14.18 version constraint (#19112 )
  • config: Upgrade md4 -> md5 on node > 16 (#19108 )
  • vue-app: Handle promise rejection from asyncData (#18585 )

🏡 Chore

❤️ Contributors

Version v2.16.1

Released on February 13, 2023

Nuxt 2.16.1 is a patch release with a couple of small bugfixes to last week's 2.16.0 release.

v2.16.0...v2.16.1

🩹 Fixes

  • deps: Downgrade @types packages depending on webpack 5 (#18827 )
  • config: Let webpack merge postcss plugins (#18839 )
  • types: Import Location from vue-router (#18908 )

🏡 Chore

❤️ Contributors