Skip to content

v3.10.0
Compare
Choose a tag to compare
@danielroe danielroe released this 30 Jan 15:32
· 461 commits to main since this release
v3.10.0
da3c502
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Learn about vigilant mode.

3.10.0 is the next minor/feature release.

👀 Highlights

v3.10 comes quite close on the heels of v3.9, but it's packed with features and fixes. Here are a few highlights.

✨ Experimental shared asyncData when prerendering

When prerendering routes, we can end up refetching the same data over and over again. In Nuxt 2 it was possible to create a 'payload' which could be fetched once and then accessed in every page (and this is of course possible to do manually in Nuxt 3 - see this article).

With #24894, we are now able to do this automatically for you when prerendering. Your useAsyncData and useFetch calls will be deduplicated and cached between renders of your site.

export defineNuxtConfig({ 
  experimental: { 
    sharedPrerenderData: true
  } 
})

Important

It is particularly important to make sure that any unique key of your data is always resolvable to the same data. For example, if you are using useAsyncData to fetch data related to a particular page, you should provide a key that uniquely matches that data. (useFetch should do this automatically.)

👉 See full documentation.

🆔 SSR-safe accessible unique ID creation

We now ship a useId composable for generating SSR-safe unique IDs (#23368). This allows creating more accessible interfaces in your app. For example:

<script setup>
const emailId = useId()
const passwordId = useId()
</script>

<template>
  <form>
    <label :for="emailId">Email</label>
    <input
      :id="emailId"
      name="email"
      type="email"
    >
    <label :for="passwordId">Password</label>
    <input
      :id="passwordId"
      name="password"
      type="password"
    >
  </form>
</template>

✍️ Extending app/router.options

It's now possible for module authors to inject their own router.options files (#24922). The new pages:routerOptions hook allows module authors to do things like add custom scrollBehavior or add runtime augmenting of routes.

👉 See full documentation.

Client-side Node.js support

We now support (experimentally) polyfilling key Node.js built-ins (#25028), just as we already do via Nitro on the server when deploying to non-Node environments.

That means that, within your client-side code, you can import directly from Node built-ins (node: and node imports are supported). However, nothing is globally injected for you, to avoid increasing your bundle size unnecessarily. You can either import them where needed.

import { Buffer } from 'node:buffer'
import process from 'node:process'

Or provide your own polyfill, for example, inside a Nuxt plugin.

// ~/plugins/node.client.ts
import { Buffer } from 'node:buffer'
import process from 'node:process'

globalThis.Buffer = Buffer
globalThis.process = process

export default defineNuxtPlugin({})

This should make life easier for users who are working with libraries without proper browser support. However, because of the risk in increasing your bundle unnecessarily, we would strongly urge users to choose other alternatives if at all possible.

🍪 Better cookie reactivity

We now allow you to opt-in to using the CookieStore. If browser support is present, this will then be used instead of a BroadcastChannel to update useCookie values reactively when the cookies are updated (#25198).

This also comes paired with a new composable, refreshCookie which allows manually refreshing cookie values, such as after performing a request. See full documentation.

🏥 Detecting anti-patterns

In this release, we've also shipped a range of features to detect potential bugs and performance problems.

  • We now will throw an error if setInterval is used on server (#25259).
  • We warn (in development only) if data fetch composables are used wrongly (#25071), such as outside of a plugin or setup context.
  • We warn (in development only) if you are not using <NuxtPage /> but have the vue-router integration enabled (#25490). (<RouterView /> should not be used on its own.)

🧂 Granular view transitions support

It's now possible to control view transitions support on a per-page basis, using definePageMeta (#25264).

You need to have experimental view transitions support enabled first:

export default defineNuxtConfig({
  experimental: {
    viewTransition: true
  },
  app: {
    // you can disable them globally if necessary (they are enabled by default)
    viewTransition: false
  }
})

And you can opt in/out granularly:

// ~/pages/index.vue
<script setup lang="ts">
definePageMeta({
  viewTransition: false
})
</script>

Finally, Nuxt will not apply View Transitions if the user's browser matches prefers-reduced-motion: reduce (#22292). You can set viewTransition: 'always'; it will then be up to you to respect the user's preference.

🏗️ Build-time route metadata

It's now possible to access routing metadata defined in definePageMeta at build-time, allowing modules and hooks to modify and change these values (#25210).

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

Please, experiment with this and let us know how it works for you. We hope to improve performance and enable this by default in a future release so modules like @nuxtjs/i18n and others can provide a deeper integration with routing options set in definePageMeta.

📦 Bundler module resolution

With #24837, we are now opting in to the TypeScript bundler resolution which should more closely resemble the actual way that we resolve subpath imports for modules in Nuxt projects.

'Bundler' module resolution is recommended by Vue and by Vite, but unfortunately there are still many packages that do not have the correct entries in their package.json.

As part of this, we opened 85 PRs across the ecosystem to test switching the default, and identified and fixed some issues.

If you need to switch off this behaviour, you can do so. However, please consider raising an issue (feel free to tag me in it) in the library or module's repo so it can be resolved at source.

export default defineNuxtConfig({
  future: {
    typescriptBundlerResolution: false
  }
})

✅ 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: tryUseNuxtApp composable (#25031)
  • nuxt: Add experimental sharedPrerenderData option (#24894)
  • schema: Default to bundler module resolution (#24837)
  • nuxt: Warn if data fetch composables are used wrongly (#25071)
  • nuxt: Add pages:routerOptions hook (#24922)
  • Experimental client-side Node.js compatibility (#25028)
  • nuxt: Throw error if setInterval is used on server (#25259)
  • nuxt: refreshCookie + experimental CookieStore support (#25198)
  • nuxt: Allow controlling view transitions in page meta (#25264)
  • nuxt: Slow down loading indicator when approaching 100% (#25119)
  • nuxt: Experimentally extract route metadata at build time (#25210)
  • nuxt: useId composable (#23368)

🔥 Performance

  • vite: Avoid endsWith when checking for whitespace (#24746)

🩹 Fixes

  • nuxt: Disable View Transitions if prefers-reduced-motion (#22292)
  • nuxt: Add declaration file with correct node16 imports (#25266)
  • nuxt: Allow omitting fallback in island response (#25296)
  • schema: Remove defineModel option as it is now stable (#25306)
  • nuxt: Overwrite island payload instead of merging (#25299)
  • vite: Pass hidden sourcemap values to vite (#25329)
  • nuxt: Use named import for lazy components (#25286)
  • nuxt: Deprecate boolean values for dedupe (#25334)
  • nuxt: Use default export for raw components (#25282)
  • nuxt: Handle plugin dependencies with mixed load state (#25318)
  • nuxt: Preserve instance.attrs in client-only components (#25381)
  • nuxt: Stop tracking suspense when error hydrating page (#25389)
  • nuxt: Add router.options files in definite order (#25397)
  • nuxt: Do not rerun synchronous callOnce callbacks (#25431)
  • nuxt: Remove dynamic nuxt-client within template code (#25464)
  • nuxt: Add runtime check to filter plugins in dependsOn (#25409)
  • nuxt: Improve global/payload error type with NuxtError (#25398)
  • vite: Extract styles for shared chunks (#25455)
  • nuxt: Avoid vue-router warning with routeRule redirect (#25391)
  • nuxt: Improve return type of useRequestEvent (#25480)
  • nuxt: Match nitro + nuxt useRuntimeConfig signatures (#25440)
  • nuxt: Prevent initial scroll jump when loading page (#25483)
  • nuxt: Prioritise later items in pages:routerOptions hook (#25509)

💅 Refactors

  • nuxt: Remove currentRoute non-ref warning (#25337)

📖 Documentation

  • Explain how to auto-install git layer deps (#24250)
  • Fix eslint link (87641c867)
  • Fix typo (#25326)
  • nuxt: Add @since annotations to exported composables (#25086)
  • Add emphasis to useAsyncData explanation (#25392)
  • Add separate docs page for error.vue (#25320)
  • Add explanation about layout usage in error.vue (#25396)
  • Use .cjs extension for ecosystem.config (#25459)
  • Add fuller explanation in routeRules example of swr/isr (#25436)
  • Warn that island client components don't support slots (#25454)
  • Updated addPluginTemplate example to add filename property (#25468)
  • Update link to vercel edge network overview (e01fb7ac3)
  • Remove unnecessary warning on sharedPrerenderData (b0f50bec1)
  • Add more documentation for pages:routerOptions (46b533671)

🏡 Chore

  • Fix typo in warning log (#25265)
  • nuxt: Warn if NuxtPage is not used when pages enabled (#25490)
  • Remove extra 'not' in warning message (b96fe1ece)

✅ Tests

  • nuxt: Add test for data-island-uid replacement (#25346)
  • Remove miswritten test (#25347)
  • Avoid explicit timeouts (#25395)

🤖 CI

  • Only release from main repo (#25354)
  • Label pull request based on type in title (#25404)
  • Wrap PR base label in quotes (#25432)
  • Update extracting PR labels' names (#25437)
  • Skip adding PR labels if there are none to add (#25475)
  • Update changelog with github tags/handles of users (60ab5deb0)
  • Import $fetch (a1fb399eb)

❤️ Contributors

Contributors

manniL, Atinux, and 22 other contributors
Assets 2