Experimental Features · Nuxt Advanced

Guide
Going Further
Experimental Features

Enable Nuxt experimental features to unlock new possibilities.

The Nuxt experimental features can be enabled in the Nuxt configuration file.

Internally, Nuxt uses @nuxt/schema to define these experimental features. You can refer to the API documentation or the source code for more information.

Note that these features are experimental and could be removed or modified in the future.
asyncContext

Enable native async context to be accessible for nested composables in Nuxt and in Nitro. This opens the possibility to use composables inside async composables and reduce the chance to get the Nuxt instance is unavailable error.

nuxt.config.ts
export defineNuxtConfig({

  experimental: {

    asyncContext: true

  }

})

See full explanation on the GitHub pull-request.
asyncEntry

Enables generation of an async entry point for the Vue bundle, aiding module federation support.

nuxt.config.ts
export defineNuxtConfig({

  experimental: {

    asyncEntry: true

  }

})

externalVue

Externalizes vue, @vue/* and vue-router when building.

Enabled by default.

nuxt.config.ts
export defineNuxtConfig({

  experimental: {

    externalVue: true

  }

})

This feature will likely be removed in a near future.
treeshakeClientOnly

Tree shakes contents of client-only components from server bundle.

Enabled by default.

nuxt.config.ts
export defineNuxtConfig({

  experimental: {

    treeshakeClientOnly: true

  }

})

emitRouteChunkError

Emits app:chunkError hook when there is an error loading vite/webpack chunks. Default behavior is to perform a hard reload of the new route when a chunk fails to load.

You can disable automatic handling by setting this to false, or handle chunk errors manually by setting it to manual.

nuxt.config.ts
export defineNuxtConfig({

  experimental: {

    emitRouteChunkError: 'automatic' // or 'manual' or false

  }

})

restoreState

Allows Nuxt app state to be restored from sessionStorage when reloading the page after a chunk error or manual reloadNuxtApp() call.

To avoid hydration errors, it will be applied only after the Vue app has been mounted, meaning there may be a flicker on initial load.

Consider carefully before enabling this as it can cause unexpected behavior, and consider providing explicit keys to useState as auto-generated keys may not match across builds.
nuxt.config.ts
export defineNuxtConfig({

  experimental: {

    restoreState: true

  }

})

inlineRouteRules

Define route rules at the page level using defineRouteRules.

nuxt.config.ts
export defineNuxtConfig({

  experimental: {

    inlineRouteRules: true

  }

})


Matching route rules will be created, based on the page's path.

Read more in defineRouteRules utility.
 Read more in Docs > Guide > Concepts > Rendering #hybrid Rendering.
inlineSSRStyles

Inlines styles when rendering HTML. This is currently available only when using Vite. You can also pass a function that receives the path of a Vue component and returns a boolean indicating whether to inline the styles for that component.

nuxt.config.ts
export defineNuxtConfig({

  experimental: {

    inlineSSRStyles: true // or a function to determine inlining

  }

})

noScripts

Disables rendering of Nuxt scripts and JS resource hints. Can also be configured granularly within routeRules.

nuxt.config.ts
export defineNuxtConfig({

  experimental: {

    noScripts: true

  }

})

renderJsonPayloads

Allows rendering of JSON payloads with support for revivifying complex types.

Enabled by default.

nuxt.config.ts
export defineNuxtConfig({

  experimental: {

    renderJsonPayloads: true

  }

})

noVueServer

Disables Vue server renderer endpoint within Nitro.

nuxt.config.ts
export defineNuxtConfig({

  experimental: {

    noVueServer: true

  }

})

payloadExtraction

Enables extraction of payloads of pages generated with nuxt generate.

nuxt.config.ts
export defineNuxtConfig({

  experimental: {

    payloadExtraction: true

  }

})

clientFallback

Enables the experimental <NuxtClientFallback> component for rendering content on the client if there's an error in SSR.

nuxt.config.ts
export defineNuxtConfig({

  experimental: {

    clientFallback: true

  }

})

crossOriginPrefetch

Enables cross-origin prefetch using the Speculation Rules API.

nuxt.config.ts
export defineNuxtConfig({

  experimental: {

    crossOriginPrefetch: true

  }

})

Read more about the Speculation Rules API.
viewTransition

Enables View Transition API integration with client-side router.

nuxt.config.ts
export defineNuxtConfig({

  experimental: {

    viewTransition: true

  }

})

 Read and edit a live example in https://stackblitz.com/edit/nuxt-view-transitions?file=app.vue.
Read more about the View Transition API.
writeEarlyHints

Enables writing of early hints when using node server.

nuxt.config.ts
export defineNuxtConfig({

  experimental: {

    writeEarlyHints: true

  }

})

componentIslands

Enables experimental component islands support with <NuxtIsland> and .island.vue files.

nuxt.config.ts
export defineNuxtConfig({

  experimental: {

    componentIslands: true // false or 'local+remote'

  }

})

 Read more in Docs > Guide > Directory Structure > Components #server Components.
You can follow the server components roadmap on GitHub.
configSchema

Enables config schema support.

Enabled by default.

nuxt.config.ts
export defineNuxtConfig({

  experimental: {

    configSchema: true

  }

})

polyfillVueUseHead

Adds a compatibility layer for modules, plugins, or user code relying on the old @vueuse/head API.

nuxt.config.ts
export defineNuxtConfig({

  experimental: {

    polyfillVueUseHead: false

  }

})

respectNoSSRHeader

Allow disabling Nuxt SSR responses by setting the x-nuxt-no-ssr header.

nuxt.config.ts
export defineNuxtConfig({

  experimental: {

    respectNoSSRHeader: false

  }

})

localLayerAliases

Resolve ~, ~~, @ and @@ aliases located within layers with respect to their layer source and root directories.

Enabled by default.

nuxt.config.ts
export defineNuxtConfig({

  experimental: {

    localLayerAliases: true

  }

})

typedPages

Enable the new experimental typed router using unplugin-vue-router.

nuxt.config.ts
export defineNuxtConfig({

  experimental: {

    typedPages: true

  }

})


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').

watcher

Set an alternative watcher that will be used as the watching service for Nuxt.

Nuxt uses chokidar-granular by default, which will ignore top-level directories (like node_modules and .git) that are excluded from watching.

You can set this instead to parcel to use @parcel/watcher, which may improve performance in large projects or on Windows platforms.

You can also set this to chokidar to watch all files in your source directory.

nuxt.config.ts
export defineNuxtConfig({ 

  experimental: { 

      watcher: 'chokidar-granular' // 'chokidar' or 'parcel' are also options

  } 

})


tsconfig.json

Nuxt generates a .nuxt/tsconfig.json file with sensible defaults and your aliases.

How Nuxt Works?

Nuxt is a minimal but highly customizable framework to build web applications.