@nuxt/docs 4.2.2 → 4.3.0

package/4.api/5.kit/1.modules.md

@@ -64,7 +64,7 @@ export function defineNuxtModule<TOptions extends ModuleOptions> (): {
 | `hooks`              | `Partial<NuxtHooks>`{lang="ts"}                                                                                   | `false`  | Hooks to be installed for the module. If provided, the module will install the hooks.                                                                                                                              |
 | `moduleDependencies` | `Record<string, ModuleDependency> \| ((nuxt: Nuxt) => Record<string, ModuleDependency>)`{lang="ts"}               | `false`  | Dependencies on other modules with version constraints and configuration. Can be an object or a function that receives the Nuxt instance. See [example](/docs/4.x/api/kit/modules#specifying-module-dependencies). |
 | `onInstall`          | `(nuxt: Nuxt) => Awaitable<void>`{lang="ts"}                                                                      | `false`  | Lifecycle hook called when the module is first installed. Requires `meta.name` and `meta.version` to be defined.                                                                                                   |
-| `onUpgrade`          | `(options: T, nuxt: Nuxt, previousVersion: string) => Awaitable<void>`{lang="ts"}                                 | `false`  | Lifecycle hook called when the module is upgraded to a newer version. Requires `meta.name` and `meta.version` to be defined.                                                                                       |
+| `onUpgrade`          | `(nuxt: Nuxt, options: T, previousVersion: string) => Awaitable<void>`{lang="ts"}                                 | `false`  | Lifecycle hook called when the module is upgraded to a newer version. Requires `meta.name` and `meta.version` to be defined.                                                                                       |
 | `setup`              | `(this: void, resolvedOptions: T, nuxt: Nuxt) => Awaitable<void \| false \| ModuleSetupInstallResult>`{lang="ts"} | `false`  | Setup function for the module. If provided, the module will call the setup function.                                                                                                                               |
 
 ### Examples
@@ -103,6 +103,19 @@ export default defineNuxtConfig({
 })
 ```
 
+Users can also completely disable a module by setting the config key to `false`. This prevents the module's setup function from running while still generating types for module options.
+
+```ts
+export default defineNuxtConfig({
+  // Disable the module entirely
+  myModule: false,
+})
+```
+
+::tip
+This is particularly useful when you want to disable modules inherited from [Nuxt layers](/docs/4.x/guide/going-further/layers#disabling-modules-from-layers).
+::
+
 #### Defining Module Compatibility Requirements
 
 If you're developing a Nuxt module and using APIs that are only supported in specific Nuxt versions, it's highly recommended to include `compatibility.nuxt`.
@@ -216,7 +229,7 @@ export default defineNuxtModule({
     // - Perform initial data migration
   },
 
-  onUpgrade (options, nuxt, previousVersion) {
+  onUpgrade (nuxt, options, previousVersion) {
     // This runs when the module is upgraded to a newer version
     console.log(`Upgrading my-awesome-module from ${previousVersion} to 1.2.0`)
 

package/4.api/5.kit/14.builder.md

@@ -207,7 +207,19 @@ See [Vite website](https://vite.dev/guide/api-plugin) for more information about
 
 ### Parameters
 
-**`pluginOrGetter`**: A Vite plugin instance or an array of Vite plugin instances. If a function is provided, it must return a Vite plugin instance or an array of Vite plugin instances.
+**`pluginOrGetter`**: A Vite plugin instance or an array of Vite plugin instances. If a function is provided, it must return a Vite plugin instance or an array of Vite plugin instances. The function can also be async or return a Promise, which is useful for lazy-loading plugins:
+
+```ts twoslash
+// @errors: 2307
+import { addVitePlugin, defineNuxtModule } from '@nuxt/kit'
+
+export default defineNuxtModule({
+  setup () {
+    // Lazy load the plugin - only imported when the build actually runs
+    addVitePlugin(() => import('my-vite-plugin').then(r => r.default()))
+  },
+})
+```
 
 **`options`**: Options to pass to the callback function. This object can have the following properties:
 
@@ -266,7 +278,7 @@ See [webpack website](https://webpack.js.org/concepts/plugins/) for more informa
 
 ### Parameters
 
-**`pluginOrGetter`**: A webpack plugin instance or an array of webpack plugin instances. If a function is provided, it must return a webpack plugin instance or an array of webpack plugin instances.
+**`pluginOrGetter`**: A webpack plugin instance or an array of webpack plugin instances. If a function is provided, it must return a webpack plugin instance or an array of webpack plugin instances. The function can also be async or return a Promise, enabling lazy-loading of plugins.
 
 **`options`**: Options to pass to the callback function. This object can have the following properties:
 

package/4.api/6.nuxt-config.md

@@ -210,7 +210,7 @@ Default values for layout transitions.
 
 This can be overridden with `definePageMeta` on an individual page. Only JSON-serializable values are allowed.
 
-- **Type**: `boolean`
+- **Type**: `boolean | TransitionProps`
 - **Default:** `false`
 
 **See**: [Vue Transition docs](https://vuejs.org/api/built-in-components#transition)
@@ -221,7 +221,7 @@ Default values for page transitions.
 
 This can be overridden with `definePageMeta` on an individual page. Only JSON-serializable values are allowed.
 
-- **Type**: `boolean`
+- **Type**: `boolean | TransitionProps`
 - **Default:** `false`
 
 **See**: [Vue Transition docs](https://vuejs.org/api/built-in-components#transition)

package/5.community/4.contribution.md

@@ -11,7 +11,7 @@ There is a range of different ways you might be able to contribute to the Nuxt e
 The Nuxt ecosystem includes many different projects and organizations:
 
 * [nuxt/](https://github.com/nuxt) - core repositories for the Nuxt framework itself. [**nuxt/nuxt**](https://github.com/nuxt/nuxt) contains the Nuxt framework (both versions 2 and 3).
-* [nuxt-modules/](https://github.com/nuxt-modules) - community-contributed and maintained modules and libraries. There is a [process to migrate a module](/docs/4.x/guide/going-further/modules/#joining-nuxt-modules-and-nuxtjs) to `nuxt-modules`. While these modules have individual maintainers, they are not dependent on a single person.
+* [nuxt-modules/](https://github.com/nuxt-modules) - community-contributed and maintained modules and libraries. There is a [process to migrate a module](/docs/4.x/guide/modules/ecosystem) to `nuxt-modules`. While these modules have individual maintainers, they are not dependent on a single person.
 * [unjs/](https://github.com/unjs) - many of these libraries are used throughout the Nuxt ecosystem. They are designed to be universal libraries that are framework- and environment-agnostic. We welcome contributions and usage by other frameworks and projects.
 
 ## How To Contribute
@@ -100,7 +100,7 @@ Our aim is ensuring quality and maintaining the joy of collaborating and communi
 
 ### Create a Module
 
-If you've built something with Nuxt that's cool, why not [extract it into a module](/docs/4.x/guide/going-further/modules), so it can be shared with others? We have [many excellent modules already](/modules), but there's always room for more.
+If you've built something with Nuxt that's cool, why not [extract it into a module](/docs/4.x/guide/modules), so it can be shared with others? We have [many excellent modules already](/modules), but there's always room for more.
 
 If you need help while building it, feel free to [check in with us](/docs/4.x/community/getting-help).
 
@@ -126,7 +126,7 @@ The following conventions are _required_ within the `nuxt/` organization and rec
 
 #### Module Conventions
 
-Modules should follow the [Nuxt module template](https://github.com/nuxt/starter/tree/module). See [module guide](/docs/4.x/guide/going-further/modules) for more information.
+Modules should follow the [Nuxt module template](https://github.com/nuxt/starter/tree/module). See [module guide](/docs/4.x/guide/modules) for more information.
 
 #### Use Core `unjs/` Libraries
 
@@ -134,7 +134,7 @@ We recommend the following libraries which are used throughout the ecosystem:
 
 * [pathe](https://github.com/unjs/pathe) - universal path utilities (replacement for node `path`)
 * [ufo](https://github.com/unjs/ufo) - URL parsing and joining utilities
-* [unbuild](https://github.com/unjs/unbuild) - rollup-powered build system
+* [obuild](https://github.com/unjs/obuild) - rolldown-powered build system
 * ... check out the rest of the [unjs/](https://github.com/unjs) organization for many more!
 
 #### Use ESM Syntax and Default to `type: module`
@@ -172,7 +172,7 @@ We recommend using [VS Code](https://code.visualstudio.com) along with the [ESLi
 
 #### No Prettier
 
-Since ESLint is already configured to format the code, there is no need to duplicate the functionality with Prettier. To format the code, you can run `yarn lint --fix`, `pnpm lint --fix`, or `bun run lint --fix` or referring the [ESLint section](/docs/4.x/community/contribution#use-eslint) for IDE Setup.
+Since ESLint is already configured to format the code, there is no need to duplicate the functionality with Prettier. To format the code, you can run `yarn lint --fix`, `pnpm lint --fix`, `bun run lint --fix`, or `deno run lint --fix` or referring the [ESLint section](/docs/4.x/community/contribution#use-eslint) for IDE Setup.
 
 If you have Prettier installed in your editor, we recommend you disable it when working on the project to avoid conflict.
 

package/5.community/5.framework-contribution.md

@@ -8,7 +8,7 @@ Once you've read the [general contribution guide](/docs/4.x/community/contributi
 
 ## Monorepo Guide
 
-- `packages/kit`: Toolkit for authoring Nuxt Modules, published as [`@nuxt/kit`](https://www.npmjs.com/package/@nuxt/kit).
+- `packages/kit`: Toolkit for authoring Nuxt modules, published as [`@nuxt/kit`](https://www.npmjs.com/package/@nuxt/kit).
 - `packages/nuxt`: The core of Nuxt, published as [`nuxt`](https://www.npmjs.com/package/nuxt).
 - `packages/schema`: Cross-version Nuxt typedefs and defaults, published as [`@nuxt/schema`](https://www.npmjs.com/package/@nuxt/schema).
 - `packages/rspack`: The [Rspack](https://rspack.rs) bundler for Nuxt, published as [`@nuxt/rspack-builder`](https://www.npmjs.com/package/@nuxt/rspack-builder).

package/5.community/6.roadmap.md

@@ -42,7 +42,7 @@ In addition to the Nuxt framework, there are modules that are vital for the ecos
 |----------------------------------------|--------------|--------------|-------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | [Scripts](https://scripts.nuxt.com)    | Public Beta  | 3.x, 4.x     | [nuxt/scripts](https://github.com/nuxt/scripts) | Easy 3rd party script management.                                                                                                                                    |
 | Auth Utils                             | Planned      | 4.x, 5.x     | `nuxt/auth-utils` to be announced               | The temporary repository [atinux/nuxt-auth-utils](https://github.com/atinux/nuxt-auth-utils) is available while awaiting its official integration into Nuxt via RFC. |
-| A11y                                   | Planned      | 4.x, 5.x     | `nuxt/a11y` to be announced                     | Accessibility hinting and utilities [nuxt/nuxt#23255](https://github.com/nuxt/nuxt/issues/23255)                                                                     |
+| [a11y](https://github.com/nuxt/a11y)   | Public Alpha | 3.x, 4.x     | [nuxt/a11y](https://github.com/nuxt/a11y).      | Real-time accessibility feedback and automated testing in your browser during development (see [nuxt/nuxt#23255](https://github.com/nuxt/nuxt/issues/23255)).        |
 | [Hints](https://github.com/nuxt/hints) | Public Alpha | 4.x, 5.x     | [nuxt/hints](https://github.com/nuxt/hints)     | Guidance and suggestions for enhancing development practices.                                                                                                        |
 
 ## Release Cycle

package/5.community/7.changelog.md

@@ -28,6 +28,16 @@ navigation.icon: i-lucide-bell-dot
   ::card
   ---
   icon: i-simple-icons-github
+  title: nuxt/a11y
+  to: https://github.com/nuxt/a11y/releases
+  target: _blank
+  ui.icon.base: text-black dark:text-white
+  ---
+  Nuxt A11y releases.
+  ::
+  ::card
+  ---
+  icon: i-simple-icons-github
   title: nuxt/content
   to: https://github.com/nuxt/content/releases
   target: _blank

package/6.bridge/1.overview.md

@@ -46,6 +46,10 @@ pnpm install
 bun install
 ```
 
+```bash [deno]
+deno install
+```
+
 ::
 
 ::note
@@ -74,6 +78,10 @@ pnpm add -D @nuxt/bridge nuxi
 bun add -D @nuxt/bridge nuxi
 ```
 
+```bash [deno]
+deno add -D npm:@nuxt/bridge npm:nuxi
+```
+
 ::
 
 ### Update `nuxt.config`

package/6.bridge/4.plugins-and-middleware.md

@@ -46,7 +46,7 @@ Use of `defineNuxtRouteMiddleware` is not supported outside of the `app/middlewa
 
 You can also use [`definePageMeta`](/docs/4.x/api/utils/define-page-meta) in Nuxt Bridge.
 
-You can be enabled with the `macros.pageMeta` option in your configuration file
+It can be enabled with the `macros.pageMeta` option in your configuration file
 
 ```ts [nuxt.config.ts]
 import { defineNuxtConfig } from '@nuxt/bridge'

package/6.bridge/8.nitro.md

@@ -45,6 +45,10 @@ pnpm add -D nuxi
 bun add -D nuxi
 ```
 
+```bash [deno]
+deno add -D npm:nuxi
+```
+
 ::
 
 ### Nuxi

package/7.migration/2.configuration.md

@@ -115,7 +115,7 @@ Nuxt has built-in support for loading `.env` files. Avoid directly importing it
 
 ## Modules
 
-Nuxt and Nuxt Modules are now build-time-only.
+Nuxt and Nuxt modules are now build-time-only.
 
 ### Migration
 
@@ -133,7 +133,7 @@ Nuxt and Nuxt Modules are now build-time-only.
 ```
 
 ::tip
-If you are a module author, you can check out [more information about module compatibility](/docs/4.x/migration/module-authors) and [our module author guide](/docs/4.x/guide/going-further/modules).
+If you are a module author, you can check out [more information about module compatibility](/docs/4.x/migration/module-authors) and [our module author guide](/docs/4.x/guide/modules).
 ::
 
 ## Directory Changes

package/7.migration/20.module-authors.md

@@ -7,7 +7,7 @@ description: 'Learn how to migrate from Nuxt 2 to Nuxt 3 modules.'
 
 Nuxt 3 has a basic backward compatibility layer for Nuxt 2 modules using `@nuxt/kit` auto wrappers. But there are usually steps to follow to make modules compatible with Nuxt 3 and sometimes, using Nuxt Bridge is required for cross-version compatibility.
 
-We have prepared a [Dedicated Guide](/docs/4.x/guide/going-further/modules) for authoring Nuxt 3 ready modules using `@nuxt/kit`. Currently best migration path is to follow it and rewrite your modules. Rest of this guide includes preparation steps if you prefer to avoid a full rewrite yet making modules compatible with Nuxt 3.
+We have prepared a [Dedicated Guide](/docs/4.x/guide/modules) for authoring Nuxt 3 ready modules using `@nuxt/kit`. Currently best migration path is to follow it and rewrite your modules. Rest of this guide includes preparation steps if you prefer to avoid a full rewrite yet making modules compatible with Nuxt 3.
 
 ::tip{icon="i-lucide-puzzle" to="/modules"}
 Explore Nuxt 3 compatible modules.
@@ -78,7 +78,7 @@ Your module should work even if it's only added to [`buildModules`](/docs/4.x/ap
 (*) Unless it is for `nuxt dev` purpose only and guarded with `if (nuxt.options.dev) { }`.
 
 ::tip
-Continue reading about Nuxt 3 modules in the [Modules Author Guide](/docs/4.x/guide/going-further/modules).
+Continue reading about Nuxt 3 modules in the [Modules Author Guide](/docs/4.x/guide/modules).
 ::
 
 ### Use TypeScript (Optional)

package/7.migration/7.component-options.md

@@ -124,7 +124,7 @@ Similar to `key`, specify it within the [`definePageMeta`](/docs/4.x/api/utils/d
 
 ## `validate`
 
-The validate hook in Nuxt 3 only accepts a single argument, the `route`. Just as in Nuxt 2, you can return a boolean value. If you return false and another match can't be found, this will mean a 404. You can also directly return an object with `statusCode`/`statusMessage` to respond immediately with an error (other matches will not be checked).
+The validate hook in Nuxt 3 only accepts a single argument, the `route`. Just as in Nuxt 2, you can return a boolean value. If you return false and another match can't be found, this will mean a 404. You can also directly return an object with `status`/`statusText` to respond immediately with an error (other matches will not be checked).
 
 ```diff [app/pages/users/[id\\].vue]
 - <script>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nuxt/docs",
-  "version": "4.2.2",
+  "version": "4.3.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/nuxt/nuxt.git",