mirror of
https://github.com/nuxt/nuxt.git
synced 2024-11-26 23:52:06 +00:00
353 lines
8.5 KiB
Markdown
353 lines
8.5 KiB
Markdown
---
|
|
title: "Experimental Features"
|
|
description: "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](/docs/api/configuration/nuxt-config#experimental) or the [source code](https://github.com/nuxt/nuxt/blob/main/packages/schema/src/config/experimental.ts) for more information.
|
|
|
|
::callout
|
|
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.
|
|
|
|
```ts [nuxt.config.ts]
|
|
export defineNuxtConfig({
|
|
experimental: {
|
|
asyncContext: true
|
|
}
|
|
})
|
|
```
|
|
|
|
::read-more{icon="i-simple-icons-github" color="gray" to="https://github.com/nuxt/nuxt/pull/20918" target="_blank"}
|
|
See full explanation on the GitHub pull-request.
|
|
::
|
|
|
|
## asyncEntry
|
|
|
|
Enables generation of an async entry point for the Vue bundle, aiding module federation support.
|
|
|
|
```ts [nuxt.config.ts]
|
|
export defineNuxtConfig({
|
|
experimental: {
|
|
asyncEntry: true
|
|
}
|
|
})
|
|
```
|
|
|
|
## externalVue
|
|
|
|
Externalizes `vue`, `@vue/*` and `vue-router` when building.
|
|
|
|
*Enabled by default.*
|
|
|
|
```ts [nuxt.config.ts]
|
|
export defineNuxtConfig({
|
|
experimental: {
|
|
externalVue: true
|
|
}
|
|
})
|
|
```
|
|
|
|
::callout{color="amber" icon="i-ph-warning-duotone"}
|
|
This feature will likely be removed in a near future.
|
|
::
|
|
|
|
## treeshakeClientOnly
|
|
|
|
Tree shakes contents of client-only components from server bundle.
|
|
|
|
*Enabled by default.*
|
|
|
|
```ts [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`.
|
|
|
|
```ts [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()`](/docs/api/utils/reload-nuxt-app) 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.
|
|
|
|
::callout{color="amber" icon="i-ph-warning-duotone"}
|
|
Consider carefully before enabling this as it can cause unexpected behavior,
|
|
and consider providing explicit keys to [`useState`](/docs/api/composables/use-state) as auto-generated keys may not match across builds.
|
|
::
|
|
|
|
```ts [nuxt.config.ts]
|
|
export defineNuxtConfig({
|
|
experimental: {
|
|
restoreState: true
|
|
}
|
|
})
|
|
```
|
|
|
|
## inlineRouteRules
|
|
|
|
Define route rules at the page level using [`defineRouteRules`](/docs/api/utils/define-route-rules).
|
|
|
|
```ts [nuxt.config.ts]
|
|
export defineNuxtConfig({
|
|
experimental: {
|
|
inlineRouteRules: true
|
|
}
|
|
})
|
|
```
|
|
|
|
Matching route rules will be created, based on the page's `path`.
|
|
|
|
::read-more{to="/docs/api/utils/define-route-rules" icon="i-ph-function-duotone"}
|
|
Read more in `defineRouteRules` utility.
|
|
::
|
|
|
|
:read-more{to="/docs/guide/concepts/rendering#hybrid-rendering" icon="i-ph-medal-duotone"}
|
|
|
|
## 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.
|
|
|
|
```ts [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`.
|
|
|
|
```ts [nuxt.config.ts]
|
|
export defineNuxtConfig({
|
|
experimental: {
|
|
noScripts: true
|
|
}
|
|
})
|
|
```
|
|
|
|
## renderJsonPayloads
|
|
|
|
Allows rendering of JSON payloads with support for revivifying complex types.
|
|
|
|
*Enabled by default.*
|
|
|
|
```ts [nuxt.config.ts]
|
|
export defineNuxtConfig({
|
|
experimental: {
|
|
renderJsonPayloads: true
|
|
}
|
|
})
|
|
```
|
|
|
|
## noVueServer
|
|
|
|
Disables Vue server renderer endpoint within Nitro.
|
|
|
|
```ts [nuxt.config.ts]
|
|
export defineNuxtConfig({
|
|
experimental: {
|
|
noVueServer: true
|
|
}
|
|
})
|
|
```
|
|
|
|
## payloadExtraction
|
|
|
|
Enables extraction of payloads of pages generated with `nuxt generate`.
|
|
|
|
```ts [nuxt.config.ts]
|
|
export defineNuxtConfig({
|
|
experimental: {
|
|
payloadExtraction: true
|
|
}
|
|
})
|
|
```
|
|
|
|
## clientFallback
|
|
|
|
Enables the experimental [`<NuxtClientFallback>`](/docs/api/components/nuxt-client-fallback) component for rendering content on the client if there's an error in SSR.
|
|
|
|
```ts [nuxt.config.ts]
|
|
export defineNuxtConfig({
|
|
experimental: {
|
|
clientFallback: true
|
|
}
|
|
})
|
|
```
|
|
|
|
## crossOriginPrefetch
|
|
|
|
Enables cross-origin prefetch using the Speculation Rules API.
|
|
|
|
```ts [nuxt.config.ts]
|
|
export defineNuxtConfig({
|
|
experimental: {
|
|
crossOriginPrefetch: true
|
|
}
|
|
})
|
|
```
|
|
|
|
::read-more{icon="i-simple-icons-w3c" color="gray" to="https://wicg.github.io/nav-speculation/prefetch.html" target="_blank"}
|
|
Read more about the **Speculation Rules API**.
|
|
::
|
|
|
|
## viewTransition
|
|
|
|
Enables View Transition API integration with client-side router.
|
|
|
|
```ts [nuxt.config.ts]
|
|
export defineNuxtConfig({
|
|
experimental: {
|
|
viewTransition: true
|
|
}
|
|
})
|
|
```
|
|
|
|
:link-example{to="https://stackblitz.com/edit/nuxt-view-transitions?file=app.vue" target="_blank"}
|
|
|
|
::read-more{icon="i-simple-icons-mdnwebdocs" color="gray" to="https://developer.mozilla.org/en-US/docs/Web/API/View_Transitions_API" target="_blank"}
|
|
Read more about the **View Transition API**.
|
|
::
|
|
|
|
## writeEarlyHints
|
|
|
|
Enables writing of early hints when using node server.
|
|
|
|
```ts [nuxt.config.ts]
|
|
export defineNuxtConfig({
|
|
experimental: {
|
|
writeEarlyHints: true
|
|
}
|
|
})
|
|
```
|
|
|
|
## componentIslands
|
|
|
|
Enables experimental component islands support with [`<NuxtIsland>`](/docs/api/components/nuxt-island) and `.island.vue` files.
|
|
|
|
```ts [nuxt.config.ts]
|
|
export defineNuxtConfig({
|
|
experimental: {
|
|
componentIslands: true // false or 'local+remote'
|
|
}
|
|
})
|
|
```
|
|
|
|
:read-more{to="/docs/guide/directory-structure/components#server-components"}
|
|
|
|
::read-more{icon="i-simple-icons-github" color="gray" to="https://github.com/nuxt/nuxt/issues/19772" target="_blank"}
|
|
You can follow the server components roadmap on GitHub.
|
|
::
|
|
|
|
## configSchema
|
|
|
|
Enables config schema support.
|
|
|
|
*Enabled by default.*
|
|
|
|
```ts [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.
|
|
|
|
```ts [nuxt.config.ts]
|
|
export defineNuxtConfig({
|
|
experimental: {
|
|
polyfillVueUseHead: false
|
|
}
|
|
})
|
|
```
|
|
|
|
## respectNoSSRHeader
|
|
|
|
Allow disabling Nuxt SSR responses by setting the `x-nuxt-no-ssr` header.
|
|
|
|
```ts [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.*
|
|
|
|
```ts [nuxt.config.ts]
|
|
export defineNuxtConfig({
|
|
experimental: {
|
|
localLayerAliases: true
|
|
}
|
|
})
|
|
```
|
|
|
|
## typedPages
|
|
|
|
Enable the new experimental typed router using [`unplugin-vue-router`](https://github.com/posva/unplugin-vue-router).
|
|
|
|
```ts [nuxt.config.ts]
|
|
export defineNuxtConfig({
|
|
experimental: {
|
|
typedPages: true
|
|
}
|
|
})
|
|
```
|
|
|
|
Out of the box, this will enable typed usage of [`navigateTo`](/docs/api/utils/navigate-to), [`<NuxtLink>`](/docs/api/components/nuxt-link), [`router.push()`](/docs/api/composables/use-router) 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.
|
|
|
|
```ts [nuxt.config.ts]
|
|
export defineNuxtConfig({
|
|
experimental: {
|
|
watcher: 'chokidar-granular' // 'chokidar' or 'parcel' are also options
|
|
}
|
|
})
|
|
```
|