@nuxt/docs-nightly 4.3.0-29356103.2f7957ac → 4.3.0-29430616.754c35a4

package/3.api/5.kit/5.components.md

@@ -1,146 +0,0 @@
----
-title: "Components"
-description: Nuxt Kit provides a set of utilities to help you work with components. You can register components globally or locally, and also add directories to be scanned for components.
-links:
-  - label: Source
-    icon: i-simple-icons-github
-    to: https://github.com/nuxt/nuxt/blob/main/packages/kit/src/components.ts
-    size: xs
----
-
-Components are the building blocks of your Nuxt application. They are reusable Vue instances that can be used to create a user interface. In Nuxt, components from the components directory are automatically imported by default. However, if you need to import components from an alternative directory or wish to selectively import them as needed, `@nuxt/kit` provides the `addComponentsDir` and `addComponent` methods. These utils allow you to customize the component configuration to better suit your needs.
-
-::tip{icon="i-lucide-video" to="https://vueschool.io/lessons/injecting-components-and-component-directories?friend=nuxt" target="_blank"}
-Watch Vue School video about injecting components.
-::
-
-## `addComponentsDir`
-
-Register a directory to be scanned for components and imported only when used. Keep in mind, that this does not register components globally, until you specify `global: true` option.
-
-### Usage
-
-```ts
-export default defineNuxtModule({
-  meta: {
-    name: '@nuxt/ui',
-    configKey: 'ui',
-  },
-  setup () {
-    addComponentsDir({
-      path: resolve('./runtime/components'),
-      prefix: 'U',
-      pathPrefix: false,
-    })
-  },
-})
-```
-
-### Type
-
-```ts
-function addComponentsDir (dir: ComponentsDir, opts: { prepend?: boolean } = {}): void
-```
-
-### Parameters
-
-`dir` An object with the following properties:
-
-| Property           | Type                         | Required | Description                                                                                                     |
-| ------------------ | ---------------------------- | -------- | --------------------------------------------------------------------------------------------------------------- |
-| `path`             | `string`                     | `true`   | Path (absolute or relative) to the directory containing your components. You can use Nuxt aliases (~ or @) to refer to directories inside project or directly use an npm package path similar to require. |
-| `pattern`          | `string \| string[]`{lang="ts"}          | `false`  | Accept Pattern that will be run against specified path.                                                         |
-| `ignore`           | `string[]`                   | `false`  | Ignore patterns that will be run against specified path.                                                        |
-| `prefix`           | `string`                     | `false`  | Prefix all matched components with this string.                                                                |
-| `pathPrefix`       | `boolean`                    | `false`  | Prefix component name by its path.                                                                              |
-| `prefetch`         | `boolean`                    | `false`  | These properties (prefetch/preload) are used in production to configure how components with Lazy prefix are handled by webpack via its magic comments. Learn more on [webpack documentation](https://webpack.js.org/api/module-methods/#magic-comments) |
-| `preload`          | `boolean`                    | `false`  | These properties (prefetch/preload) are used in production to configure how components with Lazy prefix are handled by webpack via its magic comments. Learn more on [webpack documentation](https://webpack.js.org/api/module-methods/#magic-comments) |
-| `isAsync`          | `boolean`                    | `false`  | This flag indicates, component should be loaded async (with a separate chunk) regardless of using Lazy prefix or not. |
-| `extendComponent`  | `(component: Component) => Promise<Component \| void> \| (Component \| void)`{lang="ts"} | `false`  | A function that will be called for each component found in the directory. It accepts a component object and should return a component object or a promise that resolves to a component object. |
-| `global`           | `boolean`                    | `false`  | If enabled, registers components to be globally available.                                                      |
-| `island`           | `boolean`                    | `false`  | If enabled, registers components as islands. You can read more about islands in [`<NuxtIsland/>`](/docs/4.x/api/components/nuxt-island) component description. |
-| `watch`            | `boolean`                    | `false`  | Watch specified path for changes, including file additions and file deletions.                                  |
-| `extensions`       | `string[]`                   | `false`  | Extensions supported by Nuxt builder.                                                                          |
-| `transpile`        | `'auto' \| boolean`{lang="ts"} | `false`  | Transpile specified path using build.transpile. If set to `'auto'`, it will set `transpile: true` if `node_modules/` is in path. |
-
-`opts`
-
-| Property           | Type                         | Required | Description                                                                                                     |
-| ------------------ | ---------------------------- | -------- | --------------------------------------------------------------------------------------------------------------- |
-| `prepend`          | `boolean`                    | `false`  | If set to `true`, the directory will be prepended to the array with `unshift()` instead of `push()`.            |
-
-## `addComponent`
-
-Register a component to be automatically imported.
-
-### Usage
-
-```ts
-import { addComponent, createResolver, defineNuxtModule } from '@nuxt/kit'
-
-export default defineNuxtModule({
-  meta: {
-    name: '@nuxt/image',
-    configKey: 'image',
-  },
-  setup () {
-    const resolver = createResolver(import.meta.url)
-
-    addComponent({
-      name: 'NuxtImg',
-      filePath: resolver.resolve('./runtime/components/NuxtImg.vue'),
-    })
-
-    addComponent({
-      name: 'NuxtPicture',
-      filePath: resolver.resolve('./runtime/components/NuxtPicture.vue'),
-    })
-  },
-})
-```
-
-### Type
-
-```ts
-function addComponent (options: AddComponentOptions): void
-```
-
-### Parameters
-
-`options`: An object with the following properties:
-
-| Property           | Type                         | Required | Description                                                                                                     |
-| ------------------ | ---------------------------- | -------- | --------------------------------------------------------------------------------------------------------------- |  
-| `name`             | `string`                     | `true`   | Component name.                                                                                                 |
-| `filePath`         | `string`                     | `true`   | Path to the component.                                                                                          |
-| `declarationPath`  | `string`                     | `false`  | Path to component's declaration file. It is used to generate components' [type templates](/docs/4.x/api/kit/templates#addtypetemplate); if not provided, `filePath` is used instead. |
-| `pascalName`       | `string`                     | `false`  | Pascal case component name. If not provided, it will be generated from the component name.                      |
-| `kebabName`        | `string`                     | `false`  | Kebab case component name. If not provided, it will be generated from the component name.                       |
-| `export`           | `string`                     | `false`  | Specify named or default export. If not provided, it will be set to `'default'`.                                 |
-| `shortPath`        | `string`                     | `false`  | Short path to the component. If not provided, it will be generated from the component path.                      |
-| `chunkName`        | `string`                     | `false`  | Chunk name for the component. If not provided, it will be generated from the component name.                     |
-| `prefetch`         | `boolean`                    | `false`  | These properties (prefetch/preload) are used in production to configure how components with Lazy prefix are handled by webpack via its magic comments. Learn more on [webpack documentation](https://webpack.js.org/api/module-methods/#magic-comments) |  
-| `preload`          | `boolean`                    | `false`  | These properties (prefetch/preload) are used in production to configure how components with Lazy prefix are handled by webpack via its magic comments. Learn more on [webpack documentation](https://webpack.js.org/api/module-methods/#magic-comments) |
-| `global`           | `boolean`                    | `false`  | If enabled, registers component to be globally available.                                                        |
-| `island`           | `boolean`                    | `false`  | If enabled, registers component as island. You can read more about islands in [`<NuxtIsland/>`](/docs/4.x/api/components/nuxt-island) component description. |
-| `mode`             | `'client' \| 'server' \| 'all'`{lang="ts"} | `false`  | This options indicates if component should render on client, server or both. By default, it will render on both client and server. |
-| `priority`         | `number`                     | `false`  | Priority of the component, if multiple components have the same name, the one with the highest priority will be used. |
-
-### Examples
-
-If you want to auto-import a component from an npm package, and the component is a named export (rather than the default), you can use the `export` option to specify it.
-
-```ts
-import { addComponent, defineNuxtModule } from '@nuxt/kit'
-
-export default defineNuxtModule({
-  setup () {
-    // import { MyComponent as MyAutoImportedComponent } from 'my-npm-package'
-    addComponent({
-      name: 'MyAutoImportedComponent',
-      export: 'MyComponent',
-      filePath: 'my-npm-package',
-    })
-  },
-})
-```

package/3.api/6.advanced/1.hooks.md

@@ -1,105 +0,0 @@
----
-title: 'Lifecycle Hooks'
-description: Nuxt provides a powerful hooking system to expand almost every aspect using hooks.
----
-
-:read-more{to="/docs/4.x/guide/going-further/hooks"}
-
-## App Hooks (runtime)
-
-Check the [app source code](https://github.com/nuxt/nuxt/blob/main/packages/nuxt/src/app/nuxt.ts#L37) for all available hooks.
-
-Hook                   | Arguments           | Environment     | Description
------------------------|---------------------|-----------------|-------------
-`app:created`          | `vueApp`            | Server & Client | Called when initial `vueApp` instance is created.
-`app:error`            | `err`               | Server & Client | Called when a fatal error occurs.
-`app:error:cleared`    | `{ redirect? }`     | Server & Client | Called when a fatal error occurs.
-`vue:setup`            | -                   | Server & Client | Called when the setup of Nuxt root is initialized. This callback must be synchronous.
-`vue:error`            | `err, target, info` | Server & Client | Called when a vue error propagates to the root component. [Learn More](https://vuejs.org/api/composition-api-lifecycle.html#onerrorcaptured).
-`app:rendered`         | `renderContext`     | Server          | Called when SSR rendering is done.
-`app:redirected`       | -                   | Server          | Called before SSR redirection.
-`app:beforeMount`      | `vueApp`            | Client          | Called before mounting the app, called only on client side.
-`app:mounted`          | `vueApp`            | Client          | Called when Vue app is initialized and mounted in browser.
-`app:suspense:resolve` | `appComponent`      | Client          | On [Suspense](https://vuejs.org/guide/built-ins/suspense.html#suspense) resolved event.
-`app:manifest:update`  | `{ id, timestamp }` | Client          | Called when there is a newer version of your app detected.
-`app:data:refresh`     | `keys?`             | Client          | Called when `refreshNuxtData` is called.
-`link:prefetch`        | `to`                | Client          | Called when a `<NuxtLink>` is observed to be prefetched.
-`page:start`           | `pageComponent?`    | Client          | Called on [Suspense](https://vuejs.org/guide/built-ins/suspense.html#suspense) inside of `NuxtPage` pending event.
-`page:finish`          | `pageComponent?`    | Client          | Called on [Suspense](https://vuejs.org/guide/built-ins/suspense.html#suspense) inside of `NuxtPage` resolved event.
-`page:loading:start`   | -                   | Client          | Called when the `setup()` of the new page is running.
-`page:loading:end`     | -                   | Client          | Called after `page:finish`
-`page:transition:finish`| `pageComponent?`    | Client          | After page transition [onAfterLeave](https://vuejs.org/guide/built-ins/transition.html#javascript-hooks) event.
-`dev:ssr-logs`         | `logs`              | Client          | Called with an array of server-side logs that have been passed to the client (if `features.devLogs` is enabled).
-`page:view-transition:start` | `transition`        | Client          | Called after `document.startViewTransition` is called when [experimental viewTransition support is enabled](/docs/4.x/getting-started/transitions#view-transitions-api-experimental).
-
-## Nuxt Hooks (build time)
-
-Check the [schema source code](https://github.com/nuxt/nuxt/blob/main/packages/schema/src/types/hooks.ts#L83) for all available hooks.
-
-Hook                     | Arguments                  | Description
--------------------------|----------------------------|-------------
-`kit:compatibility`      | `compatibility, issues`    | Allows extending compatibility checks.
-`ready`                  | `nuxt`                     | Called after Nuxt initialization, when the Nuxt instance is ready to work.
-`close`                  | `nuxt`                     | Called when Nuxt instance is gracefully closing.
-`restart`                | `{ hard?: boolean }`       | To be called to restart the current Nuxt instance.
-`modules:before`         | -                          | Called during Nuxt initialization, before installing user modules.
-`modules:done`           | -                          | Called during Nuxt initialization, after installing user modules.
-`app:resolve`            | `app`                      | Called after resolving the `app` instance.
-`app:templates`          | `app`                      | Called during `NuxtApp` generation, to allow customizing, modifying or adding new files to the build directory (either virtually or to written to `.nuxt`).
-`app:templatesGenerated` | `app`                      | Called after templates are compiled into the [virtual file system](/docs/4.x/guide/directory-structure/nuxt) (vfs).
-`build:before`           | -                          | Called before Nuxt bundle builder.
-`build:done`             | -                          | Called after Nuxt bundle builder is complete.
-`build:manifest`         | `manifest`                 | Called during the manifest build by Vite and webpack. This allows customizing the manifest that Nitro will use to render `<script>` and `<link>` tags in the final HTML.
-`builder:generateApp`    | `options`                  | Called before generating the app.
-`builder:watch`          | `event, path`              | Called at build time in development when the watcher spots a change to a file or directory in the project.
-`pages:extend`           | `pages`                    | Called after page routes are scanned from the file system.
-`pages:resolved`         | `pages`                    | Called after page routes have been augmented with scanned metadata.
-`pages:routerOptions`   | `{ files: Array<{ path: string, optional?: boolean }> }` | Called when resolving `router.options` files. Later items in the array override earlier ones.
-`server:devHandler`      | `handler`                  | Called when the dev middleware is being registered on the Nitro dev server.
-`imports:sources`        | `presets`                  | Called at setup allowing modules to extend sources.
-`imports:extend`         | `imports`                  | Called at setup allowing modules to extend imports.
-`imports:context`        | `context`                  | Called when the [unimport](https://github.com/unjs/unimport) context is created.
-`imports:dirs`           | `dirs`                     | Allows extending import directories.
-`components:dirs`        | `dirs`                     | Called within `app:resolve` allowing to extend the directories that are scanned for auto-importable components.
-`components:extend`      | `components`               | Allows extending new components.
-`nitro:config`           | `nitroConfig`              | Called before initializing Nitro, allowing customization of Nitro's configuration.
-`nitro:init`             | `nitro`                    | Called after Nitro is initialized, which allows registering Nitro hooks and interacting directly with Nitro.
-`nitro:build:before`     | `nitro`                    | Called before building the Nitro instance.
-`nitro:build:public-assets`     | `nitro`                    | Called after copying public assets. Allows modifying public assets before Nitro server is built.
-`prerender:routes`       | `ctx`                      | Allows extending the routes to be pre-rendered.
-`build:error`            | `error`                    | Called when an error occurs at build time.
-`prepare:types`          | `options`                  | Called before `@nuxt/cli` writes TypeScript configuration files (`.nuxt/tsconfig.app.json`, `.nuxt/tsconfig.server.json`, etc.) and `.nuxt/nuxt.d.ts`, allowing addition of custom references and declarations in `nuxt.d.ts`, or directly modifying the options in generated configurations
-`listen`                 | `listenerServer, listener` | Called when the dev server is loading.
-`schema:extend`          | `schemas`                  | Allows extending default schemas.
-`schema:resolved`        | `schema`                   | Allows extending resolved schema.
-`schema:beforeWrite`     | `schema`                   | Called before writing the given schema.
-`schema:written`         | -                          | Called after the schema is written.
-`vite:extend`            | `viteBuildContext`         | Allows extending Vite default context.
-`vite:extendConfig`      | `viteInlineConfig, env`    | Allows extending Vite default config. **Deprecated in Nuxt 5+.** In Nuxt 5, this operates on a shared configuration rather than separate client/server configs.
-`vite:configResolved`    | `viteInlineConfig, env`    | Allows reading the resolved Vite config. **Deprecated in Nuxt 5+.** In Nuxt 5, this operates on a shared configuration rather than separate client/server configs.
-`vite:serverCreated`     | `viteServer, env`          | Called when the Vite server is created.
-`vite:compiled`          | -                          | Called after Vite server is compiled.
-`webpack:config`         | `webpackConfigs`           | Called before configuring the webpack compiler.
-`webpack:configResolved` | `webpackConfigs`           | Allows reading the resolved webpack config.
-`webpack:compile`        | `options`                  | Called right before compilation.
-`webpack:compiled`       | `options`                  | Called after resources are loaded.
-`webpack:change`         | `shortPath`                | Called on `change` on WebpackBar.
-`webpack:error`          | -                          | Called on `done` if has errors on WebpackBar.
-`webpack:done`           | -                          | Called on `allDone` on WebpackBar.
-`webpack:progress`       | `statesArray`              | Called on `progress` on WebpackBar.
-
-## Nitro App Hooks (runtime, server-side)
-
-See [Nitro](https://nitro.build/guide/plugins#available-hooks) for all available hooks.
-
-Hook                   | Arguments             | Description                          | Types
------------------------|-----------------------|--------------------------------------|------------------
-`dev:ssr-logs`         | `{ path, logs }`      | Server                               | Called at the end of a request cycle with an array of server-side logs.
-`render:response`      | `response, { event }` | Called before sending the response.  | [response](https://github.com/nuxt/nuxt/blob/71ef8bd3ff207fd51c2ca18d5a8c7140476780c7/packages/nuxt/src/core/runtime/nitro/renderer.ts#L24), [event](https://github.com/h3js/h3/blob/f6ceb5581043dc4d8b6eab91e9be4531e0c30f8e/src/types.ts#L38)
-`render:html`          | `html, { event }`     | Called before constructing the HTML. | [html](https://github.com/nuxt/nuxt/blob/71ef8bd3ff207fd51c2ca18d5a8c7140476780c7/packages/nuxt/src/core/runtime/nitro/renderer.ts#L15), [event](https://github.com/h3js/h3/blob/f6ceb5581043dc4d8b6eab91e9be4531e0c30f8e/src/types.ts#L38)
-`render:island`        | `islandResponse, { event, islandContext }` | Called before constructing the island HTML. | [islandResponse](https://github.com/nuxt/nuxt/blob/e50cabfed1984c341af0d0c056a325a8aec26980/packages/nuxt/src/core/runtime/nitro/renderer.ts#L28), [event](https://github.com/h3js/h3/blob/f6ceb5581043dc4d8b6eab91e9be4531e0c30f8e/src/types.ts#L38), [islandContext](https://github.com/nuxt/nuxt/blob/e50cabfed1984c341af0d0c056a325a8aec26980/packages/nuxt/src/core/runtime/nitro/renderer.ts#L38)
-`close`               | -                | Called when Nitro is closed. | -
-`error`               | `error, { event? }`          | Called when an error occurs. | [error](https://github.com/nitrojs/nitro/blob/d20ffcbd16fc4003b774445e1a01e698c2bb078a/src/types/runtime/nitro.ts#L48), [event](https://github.com/h3js/h3/blob/f6ceb5581043dc4d8b6eab91e9be4531e0c30f8e/src/types.ts#L38)
-`request`             | `event`        | Called when a request is received. | [event](https://github.com/h3js/h3/blob/f6ceb5581043dc4d8b6eab91e9be4531e0c30f8e/src/types.ts#L38)
-`beforeResponse`      | `event, { body }`        | Called before sending the response. | [event](https://github.com/h3js/h3/blob/f6ceb5581043dc4d8b6eab91e9be4531e0c30f8e/src/types.ts#L38), unknown
-`afterResponse`       | `event, { body }`        | Called after sending the response. | [event](https://github.com/h3js/h3/blob/f6ceb5581043dc4d8b6eab91e9be4531e0c30f8e/src/types.ts#L38), unknown