@nuxt/docs 3.19.2 → 3.19.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/1.getting-started/01.introduction.md +2 -2
- package/1.getting-started/02.installation.md +1 -0
- package/1.getting-started/03.configuration.md +29 -29
- package/1.getting-started/04.views.md +7 -7
- package/1.getting-started/05.assets.md +15 -9
- package/1.getting-started/06.styling.md +55 -45
- package/1.getting-started/07.routing.md +12 -12
- package/1.getting-started/08.seo-meta.md +55 -42
- package/1.getting-started/09.transitions.md +47 -42
- package/1.getting-started/10.data-fetching.md +90 -67
- package/1.getting-started/11.state-management.md +22 -15
- package/1.getting-started/12.error-handling.md +11 -9
- package/1.getting-started/13.server.md +3 -3
- package/1.getting-started/14.layers.md +21 -15
- package/1.getting-started/15.prerendering.md +28 -28
- package/1.getting-started/16.deployment.md +9 -9
- package/1.getting-started/17.testing.md +43 -43
- package/1.getting-started/18.upgrade.md +58 -57
- package/2.guide/0.index.md +3 -3
- package/2.guide/{2.directory-structure → 1.directory-structure}/.navigation.yml +1 -1
- package/2.guide/{2.directory-structure → 1.directory-structure}/0.nuxt.md +3 -3
- package/2.guide/{2.directory-structure → 1.directory-structure}/0.output.md +3 -3
- package/2.guide/{2.directory-structure → 1.directory-structure}/1.assets.md +3 -3
- package/2.guide/{2.directory-structure → 1.directory-structure}/1.components.md +41 -24
- package/2.guide/{2.directory-structure → 1.directory-structure}/1.composables.md +11 -11
- package/2.guide/{2.directory-structure → 1.directory-structure}/1.content.md +7 -4
- package/2.guide/{2.directory-structure → 1.directory-structure}/1.layouts.md +16 -12
- package/2.guide/{2.directory-structure → 1.directory-structure}/1.middleware.md +28 -22
- package/2.guide/{2.directory-structure → 1.directory-structure}/1.modules.md +6 -6
- package/2.guide/{2.directory-structure → 1.directory-structure}/1.node_modules.md +2 -2
- package/2.guide/{2.directory-structure → 1.directory-structure}/1.pages.md +33 -31
- package/2.guide/{2.directory-structure → 1.directory-structure}/1.plugins.md +25 -25
- package/2.guide/{2.directory-structure → 1.directory-structure}/1.public.md +2 -2
- package/2.guide/{2.directory-structure → 1.directory-structure}/1.server.md +34 -34
- package/2.guide/{2.directory-structure → 1.directory-structure}/1.shared.md +6 -6
- package/2.guide/{2.directory-structure → 1.directory-structure}/1.utils.md +5 -5
- package/2.guide/{2.directory-structure → 1.directory-structure}/2.env.md +5 -5
- package/2.guide/{2.directory-structure → 1.directory-structure}/2.gitignore.md +1 -1
- package/2.guide/{2.directory-structure → 1.directory-structure}/2.nuxtignore.md +4 -4
- package/2.guide/{2.directory-structure → 1.directory-structure}/2.nuxtrc.md +3 -3
- package/2.guide/{2.directory-structure → 1.directory-structure}/3.app-config.md +12 -12
- package/2.guide/{2.directory-structure → 1.directory-structure}/3.app.md +4 -4
- package/2.guide/{2.directory-structure → 1.directory-structure}/3.error.md +6 -6
- package/2.guide/{2.directory-structure → 1.directory-structure}/3.nuxt-config.md +2 -2
- package/2.guide/{2.directory-structure → 1.directory-structure}/3.package.md +1 -1
- package/2.guide/{2.directory-structure → 1.directory-structure}/3.tsconfig.md +3 -3
- package/2.guide/{1.concepts → 2.concepts}/1.auto-imports.md +18 -18
- package/2.guide/{1.concepts → 2.concepts}/10.nuxt-lifecycle.md +10 -10
- package/2.guide/{1.concepts → 2.concepts}/2.vuejs-development.md +9 -9
- package/2.guide/{1.concepts → 2.concepts}/3.rendering.md +21 -19
- package/2.guide/{1.concepts → 2.concepts}/4.server-engine.md +5 -5
- package/2.guide/{1.concepts → 2.concepts}/5.modules.md +4 -4
- package/2.guide/{1.concepts → 2.concepts}/7.esm.md +15 -13
- package/2.guide/{1.concepts → 2.concepts}/8.typescript.md +11 -11
- package/2.guide/3.going-further/1.events.md +2 -2
- package/2.guide/3.going-further/1.experimental-features.md +80 -80
- package/2.guide/3.going-further/1.features.md +15 -15
- package/2.guide/3.going-further/1.internals.md +25 -25
- package/2.guide/3.going-further/10.runtime-config.md +11 -11
- package/2.guide/3.going-further/2.hooks.md +11 -11
- package/2.guide/3.going-further/3.modules.md +89 -87
- package/2.guide/3.going-further/4.kit.md +5 -5
- package/2.guide/3.going-further/6.nuxt-app.md +5 -5
- package/2.guide/3.going-further/7.layers.md +61 -52
- package/2.guide/3.going-further/9.debugging.md +2 -2
- package/2.guide/4.recipes/1.custom-routing.md +31 -31
- package/2.guide/4.recipes/2.vite-plugin.md +4 -4
- package/2.guide/4.recipes/3.custom-usefetch.md +12 -12
- package/2.guide/4.recipes/4.sessions-and-authentication.md +34 -20
- package/2.guide/5.best-practices/hydration.md +4 -4
- package/2.guide/5.best-practices/performance.md +12 -12
- package/3.api/1.components/1.client-only.md +6 -3
- package/3.api/1.components/1.nuxt-client-fallback.md +9 -6
- package/3.api/1.components/10.nuxt-picture.md +1 -1
- package/3.api/1.components/11.teleports.md +4 -1
- package/3.api/1.components/12.nuxt-route-announcer.md +9 -9
- package/3.api/1.components/13.nuxt-time.md +44 -17
- package/3.api/1.components/2.nuxt-page.md +4 -4
- package/3.api/1.components/3.nuxt-layout.md +11 -6
- package/3.api/1.components/4.nuxt-link.md +40 -20
- package/3.api/1.components/5.nuxt-loading-indicator.md +2 -2
- package/3.api/1.components/6.nuxt-error-boundary.md +11 -9
- package/3.api/2.composables/on-prehydrate.md +2 -2
- package/3.api/2.composables/use-async-data.md +17 -17
- package/3.api/2.composables/use-cookie.md +28 -20
- package/3.api/2.composables/use-error.md +1 -1
- package/3.api/2.composables/use-fetch.md +55 -29
- package/3.api/2.composables/use-head-safe.md +7 -7
- package/3.api/2.composables/use-head.md +4 -4
- package/3.api/2.composables/use-hydration.md +6 -6
- package/3.api/2.composables/use-lazy-async-data.md +2 -2
- package/3.api/2.composables/use-lazy-fetch.md +2 -2
- package/3.api/2.composables/use-loading-indicator.md +12 -12
- package/3.api/2.composables/use-nuxt-app.md +19 -19
- package/3.api/2.composables/use-nuxt-data.md +8 -8
- package/3.api/2.composables/use-preview-mode.md +15 -18
- package/3.api/2.composables/use-request-event.md +1 -1
- package/3.api/2.composables/use-request-fetch.md +3 -3
- package/3.api/2.composables/use-request-header.md +1 -1
- package/3.api/2.composables/use-request-headers.md +4 -4
- package/3.api/2.composables/use-request-url.md +1 -1
- package/3.api/2.composables/use-response-header.md +9 -10
- package/3.api/2.composables/use-route-announcer.md +4 -4
- package/3.api/2.composables/use-route.md +1 -1
- package/3.api/2.composables/use-router.md +9 -7
- package/3.api/2.composables/use-runtime-config.md +6 -6
- package/3.api/2.composables/use-runtime-hook.md +2 -2
- package/3.api/2.composables/use-seo-meta.md +2 -2
- package/3.api/2.composables/use-server-seo-meta.md +4 -4
- package/3.api/2.composables/use-state.md +4 -4
- package/3.api/3.utils/$fetch.md +9 -7
- package/3.api/3.utils/abort-navigation.md +3 -3
- package/3.api/3.utils/add-route-middleware.md +5 -5
- package/3.api/3.utils/call-once.md +4 -4
- package/3.api/3.utils/clear-error.md +2 -2
- package/3.api/3.utils/clear-nuxt-data.md +3 -3
- package/3.api/3.utils/clear-nuxt-state.md +3 -3
- package/3.api/3.utils/create-error.md +1 -1
- package/3.api/3.utils/define-lazy-hydration-component.md +13 -13
- package/3.api/3.utils/define-nuxt-component.md +5 -5
- package/3.api/3.utils/define-nuxt-plugin.md +12 -12
- package/3.api/3.utils/define-nuxt-route-middleware.md +5 -5
- package/3.api/3.utils/define-page-meta.md +21 -21
- package/3.api/3.utils/define-route-rules.md +5 -5
- package/3.api/3.utils/navigate-to.md +10 -10
- package/3.api/3.utils/prefetch-components.md +1 -1
- package/3.api/3.utils/preload-components.md +1 -1
- package/3.api/3.utils/prerender-routes.md +3 -3
- package/3.api/3.utils/refresh-cookie.md +3 -3
- package/3.api/3.utils/refresh-nuxt-data.md +11 -6
- package/3.api/3.utils/reload-nuxt-app.md +2 -2
- package/3.api/3.utils/set-page-layout.md +1 -1
- package/3.api/3.utils/set-response-status.md +2 -2
- package/3.api/3.utils/show-error.md +4 -4
- package/3.api/3.utils/update-app-config.md +3 -2
- package/3.api/4.commands/add.md +1 -1
- package/3.api/4.commands/analyze.md +2 -1
- package/3.api/4.commands/build.md +2 -1
- package/3.api/4.commands/dev.md +5 -4
- package/3.api/4.commands/generate.md +2 -1
- package/3.api/4.commands/init.md +3 -2
- package/3.api/4.commands/module.md +4 -4
- package/3.api/4.commands/prepare.md +7 -2
- package/3.api/4.commands/preview.md +5 -4
- package/3.api/4.commands/test.md +40 -0
- package/3.api/4.commands/typecheck.md +4 -2
- package/3.api/4.commands/upgrade.md +3 -3
- package/3.api/5.kit/1.modules.md +36 -36
- package/3.api/5.kit/10.runtime-config.md +1 -1
- package/3.api/5.kit/10.templates.md +8 -6
- package/3.api/5.kit/11.nitro.md +62 -62
- package/3.api/5.kit/12.resolving.md +2 -2
- package/3.api/5.kit/14.builder.md +1 -0
- package/3.api/5.kit/15.examples.md +2 -2
- package/3.api/5.kit/16.layers.md +26 -26
- package/3.api/5.kit/3.compatibility.md +12 -12
- package/3.api/5.kit/4.autoimports.md +13 -13
- package/3.api/5.kit/5.components.md +7 -7
- package/3.api/5.kit/6.context.md +3 -3
- package/3.api/5.kit/7.pages.md +7 -7
- package/3.api/5.kit/8.layout.md +2 -2
- package/3.api/5.kit/9.plugins.md +6 -5
- package/3.api/6.advanced/1.hooks.md +2 -2
- package/3.api/6.advanced/2.import-meta.md +3 -3
- package/5.community/2.getting-help.md +1 -1
- package/5.community/3.reporting-bugs.md +1 -1
- package/5.community/4.contribution.md +6 -6
- package/5.community/5.framework-contribution.md +3 -3
- package/5.community/6.roadmap.md +1 -1
- package/6.bridge/1.overview.md +13 -13
- package/6.bridge/10.configuration.md +2 -1
- package/6.bridge/2.typescript.md +2 -2
- package/6.bridge/3.bridge-composition-api.md +6 -6
- package/6.bridge/4.plugins-and-middleware.md +9 -9
- package/6.bridge/5.nuxt3-compatible-api.md +19 -16
- package/6.bridge/6.meta.md +20 -19
- package/6.bridge/7.runtime-config.md +1 -1
- package/6.bridge/8.nitro.md +3 -3
- package/6.bridge/9.vite.md +4 -4
- package/7.migration/1.overview.md +2 -2
- package/7.migration/2.configuration.md +22 -20
- package/7.migration/20.module-authors.md +6 -6
- package/7.migration/3.auto-imports.md +3 -3
- package/7.migration/4.meta.md +20 -17
- package/7.migration/5.plugins-and-middleware.md +5 -5
- package/7.migration/6.pages-and-layouts.md +23 -19
- package/7.migration/7.component-options.md +14 -14
- package/7.migration/8.runtime-config.md +6 -6
- package/package.json +1 -1
- /package/2.guide/{1.concepts → 2.concepts}/.navigation.yml +0 -0
- /package/2.guide/{1.concepts → 2.concepts}/9.code-style.md +0 -0
|
@@ -15,7 +15,7 @@ With Nuxt Kit you can also add your own auto-imports. `addImports` and `addImpor
|
|
|
15
15
|
These utilities are powered by [`unimport`](https://github.com/unjs/unimport), which provides the underlying auto-import mechanism used in Nuxt.
|
|
16
16
|
|
|
17
17
|
::note
|
|
18
|
-
These functions are designed for registering your own utils, composables and Vue APIs. For pages, components and plugins, please refer to the specific sections: [Pages](/docs/api/kit/pages), [Components](/docs/api/kit/components), [Plugins](/docs/api/kit/plugins).
|
|
18
|
+
These functions are designed for registering your own utils, composables and Vue APIs. For pages, components and plugins, please refer to the specific sections: [Pages](/docs/3.x/api/kit/pages), [Components](/docs/3.x/api/kit/components), [Plugins](/docs/3.x/api/kit/plugins).
|
|
19
19
|
::
|
|
20
20
|
|
|
21
21
|
::tip{icon="i-lucide-video" to="https://vueschool.io/lessons/expanding-nuxt-s-auto-imports?friend=nuxt" target="_blank"}
|
|
@@ -29,22 +29,22 @@ Add imports to the Nuxt application. It makes your imports available in the Nuxt
|
|
|
29
29
|
### Usage
|
|
30
30
|
|
|
31
31
|
```ts twoslash
|
|
32
|
-
import {
|
|
32
|
+
import { addImports, defineNuxtModule } from '@nuxt/kit'
|
|
33
33
|
|
|
34
34
|
export default defineNuxtModule({
|
|
35
|
-
setup(options, nuxt) {
|
|
35
|
+
setup (options, nuxt) {
|
|
36
36
|
const names = [
|
|
37
37
|
'useStoryblok',
|
|
38
38
|
'useStoryblokApi',
|
|
39
39
|
'useStoryblokBridge',
|
|
40
40
|
'renderRichText',
|
|
41
|
-
'RichTextSchema'
|
|
41
|
+
'RichTextSchema',
|
|
42
42
|
]
|
|
43
43
|
|
|
44
|
-
names.forEach(
|
|
45
|
-
addImports({ name, as: name, from: '@storyblok/vue' })
|
|
44
|
+
names.forEach(name =>
|
|
45
|
+
addImports({ name, as: name, from: '@storyblok/vue' }),
|
|
46
46
|
)
|
|
47
|
-
}
|
|
47
|
+
},
|
|
48
48
|
})
|
|
49
49
|
```
|
|
50
50
|
|
|
@@ -76,14 +76,14 @@ Add imports from a directory to the Nuxt application. It will automatically impo
|
|
|
76
76
|
### Usage
|
|
77
77
|
|
|
78
78
|
```ts twoslash
|
|
79
|
-
import {
|
|
79
|
+
import { addImportsDir, createResolver, defineNuxtModule } from '@nuxt/kit'
|
|
80
80
|
|
|
81
81
|
export default defineNuxtModule({
|
|
82
82
|
meta: {
|
|
83
83
|
name: '@vueuse/motion',
|
|
84
84
|
configKey: 'motion',
|
|
85
85
|
},
|
|
86
|
-
setup(options, nuxt) {
|
|
86
|
+
setup (options, nuxt) {
|
|
87
87
|
const resolver = createResolver(import.meta.url)
|
|
88
88
|
addImportsDir(resolver.resolve('./runtime/composables'))
|
|
89
89
|
},
|
|
@@ -110,10 +110,10 @@ Add listed imports to the Nuxt application.
|
|
|
110
110
|
### Usage
|
|
111
111
|
|
|
112
112
|
```ts twoslash
|
|
113
|
-
import {
|
|
113
|
+
import { addImportsSources, defineNuxtModule } from '@nuxt/kit'
|
|
114
114
|
|
|
115
115
|
export default defineNuxtModule({
|
|
116
|
-
setup() {
|
|
116
|
+
setup () {
|
|
117
117
|
addImportsSources({
|
|
118
118
|
from: 'h3',
|
|
119
119
|
imports: [
|
|
@@ -121,10 +121,10 @@ export default defineNuxtModule({
|
|
|
121
121
|
'getQuery',
|
|
122
122
|
'getRouterParams',
|
|
123
123
|
'readBody',
|
|
124
|
-
'sendRedirect'
|
|
124
|
+
'sendRedirect',
|
|
125
125
|
],
|
|
126
126
|
})
|
|
127
|
-
}
|
|
127
|
+
},
|
|
128
128
|
})
|
|
129
129
|
```
|
|
130
130
|
|
|
@@ -26,13 +26,13 @@ export default defineNuxtModule({
|
|
|
26
26
|
name: '@nuxt/ui',
|
|
27
27
|
configKey: 'ui',
|
|
28
28
|
},
|
|
29
|
-
setup() {
|
|
29
|
+
setup () {
|
|
30
30
|
addComponentsDir({
|
|
31
31
|
path: resolve('./runtime/components'),
|
|
32
32
|
prefix: 'U',
|
|
33
|
-
pathPrefix: false
|
|
33
|
+
pathPrefix: false,
|
|
34
34
|
})
|
|
35
|
-
}
|
|
35
|
+
},
|
|
36
36
|
})
|
|
37
37
|
```
|
|
38
38
|
|
|
@@ -58,7 +58,7 @@ function addComponentsDir (dir: ComponentsDir, opts: { prepend?: boolean } = {})
|
|
|
58
58
|
| `isAsync` | `boolean` | `false` | This flag indicates, component should be loaded async (with a separate chunk) regardless of using Lazy prefix or not. |
|
|
59
59
|
| `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. |
|
|
60
60
|
| `global` | `boolean` | `false` | If enabled, registers components to be globally available. |
|
|
61
|
-
| `island` | `boolean` | `false` | If enabled, registers components as islands. You can read more about islands in [`<NuxtIsland/>`](/docs/api/components/nuxt-island#nuxtisland) component description. |
|
|
61
|
+
| `island` | `boolean` | `false` | If enabled, registers components as islands. You can read more about islands in [`<NuxtIsland/>`](/docs/3.x/api/components/nuxt-island#nuxtisland) component description. |
|
|
62
62
|
| `watch` | `boolean` | `false` | Watch specified path for changes, including file additions and file deletions. |
|
|
63
63
|
| `extensions` | `string[]` | `false` | Extensions supported by Nuxt builder. |
|
|
64
64
|
| `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. |
|
|
@@ -76,14 +76,14 @@ Register a component to be automatically imported.
|
|
|
76
76
|
### Usage
|
|
77
77
|
|
|
78
78
|
```ts
|
|
79
|
-
import {
|
|
79
|
+
import { addComponent, createResolver, defineNuxtModule } from '@nuxt/kit'
|
|
80
80
|
|
|
81
81
|
export default defineNuxtModule({
|
|
82
82
|
meta: {
|
|
83
83
|
name: '@nuxt/image',
|
|
84
84
|
configKey: 'image',
|
|
85
85
|
},
|
|
86
|
-
|
|
86
|
+
setup () {
|
|
87
87
|
const resolver = createResolver(import.meta.url)
|
|
88
88
|
|
|
89
89
|
addComponent({
|
|
@@ -121,7 +121,7 @@ function addComponent (options: AddComponentOptions): void
|
|
|
121
121
|
| `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) |
|
|
122
122
|
| `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) |
|
|
123
123
|
| `global` | `boolean` | `false` | If enabled, registers component to be globally available. |
|
|
124
|
-
| `island` | `boolean` | `false` | If enabled, registers component as island. You can read more about islands in [`<NuxtIsland/>`](/docs/api/components/nuxt-island#nuxtisland) component description. |
|
|
124
|
+
| `island` | `boolean` | `false` | If enabled, registers component as island. You can read more about islands in [`<NuxtIsland/>`](/docs/3.x/api/components/nuxt-island#nuxtisland) component description. |
|
|
125
125
|
| `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. |
|
|
126
126
|
| `priority` | `number` | `false` | Priority of the component, if multiple components have the same name, the one with the highest priority will be used. |
|
|
127
127
|
|
package/3.api/5.kit/6.context.md
CHANGED
|
@@ -37,7 +37,7 @@ const setupSomeFeature = () => {
|
|
|
37
37
|
// @errors: 2391
|
|
38
38
|
import type { Nuxt } from '@nuxt/schema'
|
|
39
39
|
// ---cut---
|
|
40
|
-
function useNuxt(): Nuxt
|
|
40
|
+
function useNuxt (): Nuxt
|
|
41
41
|
```
|
|
42
42
|
|
|
43
43
|
### Return Value
|
|
@@ -114,7 +114,7 @@ function setupSomething () {
|
|
|
114
114
|
// @errors: 2391
|
|
115
115
|
import type { Nuxt } from '@nuxt/schema'
|
|
116
116
|
// ---cut---
|
|
117
|
-
function tryUseNuxt(): Nuxt | null
|
|
117
|
+
function tryUseNuxt (): Nuxt | null
|
|
118
118
|
```
|
|
119
119
|
|
|
120
120
|
### Return Value
|
|
@@ -156,7 +156,7 @@ interface SiteConfig {
|
|
|
156
156
|
title?: string
|
|
157
157
|
}
|
|
158
158
|
export const requireSiteConfig = (): SiteConfig => {
|
|
159
|
-
|
|
159
|
+
return {}
|
|
160
160
|
}
|
|
161
161
|
// @filename: module.ts
|
|
162
162
|
// ---cut---
|
package/3.api/5.kit/7.pages.md
CHANGED
|
@@ -39,7 +39,7 @@ export default defineNuxtModule({
|
|
|
39
39
|
### Type
|
|
40
40
|
|
|
41
41
|
```ts
|
|
42
|
-
function extendPages(callback: (pages: NuxtPage[]) => void): void
|
|
42
|
+
function extendPages (callback: (pages: NuxtPage[]) => void): void
|
|
43
43
|
```
|
|
44
44
|
|
|
45
45
|
### Parameters
|
|
@@ -104,7 +104,7 @@ export default defineNuxtModule({
|
|
|
104
104
|
### Type
|
|
105
105
|
|
|
106
106
|
```ts
|
|
107
|
-
function extendRouteRules(route: string, rule: NitroRouteConfig, options?: ExtendRouteRulesOptions): void
|
|
107
|
+
function extendRouteRules (route: string, rule: NitroRouteConfig, options?: ExtendRouteRulesOptions): void
|
|
108
108
|
```
|
|
109
109
|
|
|
110
110
|
### Parameters
|
|
@@ -113,7 +113,7 @@ function extendRouteRules(route: string, rule: NitroRouteConfig, options?: Exten
|
|
|
113
113
|
**rule**: A route rule configuration to apply to the matched route.
|
|
114
114
|
|
|
115
115
|
::tip
|
|
116
|
-
About route rules configurations, you can get more detail in [Hybrid Rendering > Route Rules](/docs/guide/concepts/rendering#route-rules).
|
|
116
|
+
About route rules configurations, you can get more detail in [Hybrid Rendering > Route Rules](/docs/3.x/guide/concepts/rendering#route-rules).
|
|
117
117
|
::
|
|
118
118
|
|
|
119
119
|
**options**: A object to pass to the route configuration. If `override` is set to `true`, it will override the existing route configuration.
|
|
@@ -126,10 +126,10 @@ About route rules configurations, you can get more detail in [Hybrid Rendering >
|
|
|
126
126
|
|
|
127
127
|
Registers route middlewares to be available for all routes or for specific routes.
|
|
128
128
|
|
|
129
|
-
Route middlewares can be also defined in plugins via [`addRouteMiddleware`](/docs/api/utils/add-route-middleware) composable.
|
|
129
|
+
Route middlewares can be also defined in plugins via [`addRouteMiddleware`](/docs/3.x/api/utils/add-route-middleware) composable.
|
|
130
130
|
|
|
131
131
|
::tip
|
|
132
|
-
Read more about route middlewares in the [Route middleware documentation](/docs/getting-started/routing#route-middleware).
|
|
132
|
+
Read more about route middlewares in the [Route middleware documentation](/docs/3.x/getting-started/routing#route-middleware).
|
|
133
133
|
::
|
|
134
134
|
|
|
135
135
|
::tip{icon="i-lucide-video" to="https://vueschool.io/lessons/adding-route-rules-and-route-middlewares?friend=nuxt" target="_blank"}
|
|
@@ -157,7 +157,7 @@ export default defineNuxtModule({
|
|
|
157
157
|
```
|
|
158
158
|
|
|
159
159
|
```ts twoslash [runtime/auth.ts]
|
|
160
|
-
function isAuthenticated(): boolean { return false }
|
|
160
|
+
function isAuthenticated (): boolean { return false }
|
|
161
161
|
// ---cut---
|
|
162
162
|
export default defineNuxtRouteMiddleware((to, from) => {
|
|
163
163
|
// isAuthenticated() is an example method verifying if a user is authenticated
|
|
@@ -172,7 +172,7 @@ export default defineNuxtRouteMiddleware((to, from) => {
|
|
|
172
172
|
### Type
|
|
173
173
|
|
|
174
174
|
```ts
|
|
175
|
-
function addRouteMiddleware(input: NuxtMiddleware | NuxtMiddleware[], options?: AddRouteMiddlewareOptions): void
|
|
175
|
+
function addRouteMiddleware (input: NuxtMiddleware | NuxtMiddleware[], options?: AddRouteMiddlewareOptions): void
|
|
176
176
|
```
|
|
177
177
|
|
|
178
178
|
### Parameters
|
package/3.api/5.kit/8.layout.md
CHANGED
|
@@ -15,7 +15,7 @@ Layouts is used to be a wrapper around your pages. It can be used to wrap your p
|
|
|
15
15
|
Register template as layout and add it to the layouts.
|
|
16
16
|
|
|
17
17
|
::note
|
|
18
|
-
In Nuxt 2 `error` layout can also be registered using this utility. In Nuxt 3+ `error` layout [replaced](/docs/getting-started/error-handling#rendering-an-error-page) with `error.vue` page in project root.
|
|
18
|
+
In Nuxt 2 `error` layout can also be registered using this utility. In Nuxt 3+ `error` layout [replaced](/docs/3.x/getting-started/error-handling#rendering-an-error-page) with `error.vue` page in project root.
|
|
19
19
|
::
|
|
20
20
|
|
|
21
21
|
### Usage
|
|
@@ -38,7 +38,7 @@ export default defineNuxtModule({
|
|
|
38
38
|
### Type
|
|
39
39
|
|
|
40
40
|
```ts
|
|
41
|
-
function addLayout(layout: NuxtTemplate | string, name: string): void
|
|
41
|
+
function addLayout (layout: NuxtTemplate | string, name: string): void
|
|
42
42
|
```
|
|
43
43
|
|
|
44
44
|
### Parameters
|
package/3.api/5.kit/9.plugins.md
CHANGED
|
@@ -38,7 +38,7 @@ export default defineNuxtModule({
|
|
|
38
38
|
### Type
|
|
39
39
|
|
|
40
40
|
```ts
|
|
41
|
-
function addPlugin(plugin: NuxtPlugin | string, options?: AddPluginOptions): NuxtPlugin
|
|
41
|
+
function addPlugin (plugin: NuxtPlugin | string, options?: AddPluginOptions): NuxtPlugin
|
|
42
42
|
```
|
|
43
43
|
|
|
44
44
|
### Parameters
|
|
@@ -128,7 +128,7 @@ export default defineNuxtPlugin({
|
|
|
128
128
|
### Type
|
|
129
129
|
|
|
130
130
|
```ts
|
|
131
|
-
function addPluginTemplate(pluginOptions: NuxtPluginTemplate, options?: AddPluginOptions): NuxtPlugin
|
|
131
|
+
function addPluginTemplate (pluginOptions: NuxtPluginTemplate, options?: AddPluginOptions): NuxtPlugin
|
|
132
132
|
```
|
|
133
133
|
|
|
134
134
|
### Parameters
|
|
@@ -204,12 +204,13 @@ export default defineNuxtConfig({
|
|
|
204
204
|
|
|
205
205
|
```ts [#build/vue-app-config.mjs]
|
|
206
206
|
import { defineNuxtPlugin } from '#app/nuxt'
|
|
207
|
+
|
|
207
208
|
export default defineNuxtPlugin({
|
|
208
209
|
name: 'nuxt:vue-app-config',
|
|
209
210
|
enforce: 'pre',
|
|
210
211
|
setup (nuxtApp) {
|
|
211
|
-
nuxtApp.vueApp.config
|
|
212
|
-
}
|
|
212
|
+
nuxtApp.vueApp.config.idPrefix = 'nuxt'
|
|
213
|
+
},
|
|
213
214
|
})
|
|
214
215
|
```
|
|
215
216
|
|
|
@@ -239,7 +240,7 @@ export default defineNuxtModule({
|
|
|
239
240
|
})
|
|
240
241
|
```
|
|
241
242
|
|
|
242
|
-
```
|
|
243
|
+
```ejs [templates/plugin.ejs]
|
|
243
244
|
import { VueFire, useSSRInitialState } from 'vuefire'
|
|
244
245
|
import { defineNuxtPlugin } from '#imports'
|
|
245
246
|
|
|
@@ -30,7 +30,7 @@ Hook | Arguments | Environment | Description
|
|
|
30
30
|
`page:loading:end` | - | Client | Called after `page:finish`
|
|
31
31
|
`page:transition:finish`| `pageComponent?` | Client | After page transition [onAfterLeave](https://vuejs.org/guide/built-ins/transition.html#javascript-hooks) event.
|
|
32
32
|
`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).
|
|
33
|
-
`page:view-transition:start` | `transition` | Client | Called after `document.startViewTransition` is called when [experimental viewTransition support is enabled](/docs/getting-started/transitions#view-transitions-api-experimental).
|
|
33
|
+
`page:view-transition:start` | `transition` | Client | Called after `document.startViewTransition` is called when [experimental viewTransition support is enabled](/docs/3.x/getting-started/transitions#view-transitions-api-experimental).
|
|
34
34
|
|
|
35
35
|
## Nuxt Hooks (build time)
|
|
36
36
|
|
|
@@ -46,7 +46,7 @@ Hook | Arguments | Description
|
|
|
46
46
|
`modules:done` | - | Called during Nuxt initialization, after installing user modules.
|
|
47
47
|
`app:resolve` | `app` | Called after resolving the `app` instance.
|
|
48
48
|
`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`).
|
|
49
|
-
`app:templatesGenerated` | `app` | Called after templates are compiled into the [virtual file system](/docs/guide/directory-structure/nuxt#virtual-file-system) (vfs).
|
|
49
|
+
`app:templatesGenerated` | `app` | Called after templates are compiled into the [virtual file system](/docs/3.x/guide/directory-structure/nuxt#virtual-file-system) (vfs).
|
|
50
50
|
`build:before` | - | Called before Nuxt bundle builder.
|
|
51
51
|
`build:done` | - | Called after Nuxt bundle builder is complete.
|
|
52
52
|
`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.
|
|
@@ -49,12 +49,12 @@ const resolver = createResolver(import.meta.url)
|
|
|
49
49
|
|
|
50
50
|
export default defineNuxtModule({
|
|
51
51
|
meta: { name: 'myModule' },
|
|
52
|
-
setup() {
|
|
52
|
+
setup () {
|
|
53
53
|
addComponent({
|
|
54
54
|
name: 'MyModuleComponent',
|
|
55
55
|
// Resolves to '/modules/my-module/components/MyModuleComponent.vue'
|
|
56
|
-
filePath: resolver.resolve('./components/MyModuleComponent.vue')
|
|
56
|
+
filePath: resolver.resolve('./components/MyModuleComponent.vue'),
|
|
57
57
|
})
|
|
58
|
-
}
|
|
58
|
+
},
|
|
59
59
|
})
|
|
60
60
|
```
|
|
@@ -37,7 +37,7 @@ And finally, just ask the question! There's no need to [ask permission to ask a
|
|
|
37
37
|
|
|
38
38
|
Something isn't working the way that the docs say that it should. You're not sure if it's a bug. You've searched through the [open issues](https://github.com/nuxt/nuxt/issues) and [discussions](https://github.com/nuxt/nuxt/discussions) but you can't find anything. (if there is a closed issue, please create a new one)
|
|
39
39
|
|
|
40
|
-
We recommend taking a look at [how to report bugs](/docs/community/reporting-bugs). Nuxt is still in active development, and every issue helps make it better.
|
|
40
|
+
We recommend taking a look at [how to report bugs](/docs/3.x/community/reporting-bugs). Nuxt is still in active development, and every issue helps make it better.
|
|
41
41
|
|
|
42
42
|
## "I need professional help"
|
|
43
43
|
|
|
@@ -12,7 +12,7 @@ Here are a few key steps.
|
|
|
12
12
|
|
|
13
13
|
## Is It Really a Bug?
|
|
14
14
|
|
|
15
|
-
Consider if you're looking to get help with something, or whether you think there's a bug with Nuxt itself. If it's the former, we'd love to help you - but the best way to do that is through [asking for help](/docs/community/getting-help) rather than reporting a bug.
|
|
15
|
+
Consider if you're looking to get help with something, or whether you think there's a bug with Nuxt itself. If it's the former, we'd love to help you - but the best way to do that is through [asking for help](/docs/3.x/community/getting-help) rather than reporting a bug.
|
|
16
16
|
|
|
17
17
|
## Search the Issues
|
|
18
18
|
|
|
@@ -11,7 +11,7 @@ There is a range of different ways you might be able to contribute to the Nuxt e
|
|
|
11
11
|
The Nuxt ecosystem includes many different projects and organizations:
|
|
12
12
|
|
|
13
13
|
* [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).
|
|
14
|
-
* [nuxt-modules/](https://github.com/nuxt-modules) - community-contributed and maintained modules and libraries. There is a [process to migrate a module](/docs/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.
|
|
14
|
+
* [nuxt-modules/](https://github.com/nuxt-modules) - community-contributed and maintained modules and libraries. There is a [process to migrate a module](/docs/3.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.
|
|
15
15
|
* [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.
|
|
16
16
|
|
|
17
17
|
## How To Contribute
|
|
@@ -24,7 +24,7 @@ Check out the issues and discussions for the project you want to help. For examp
|
|
|
24
24
|
|
|
25
25
|
Thank you for taking the time to create an issue! ❤️
|
|
26
26
|
|
|
27
|
-
* **Reporting bugs**: Check out [our guide](/docs/community/reporting-bugs) for some things to do before opening an issue.
|
|
27
|
+
* **Reporting bugs**: Check out [our guide](/docs/3.x/community/reporting-bugs) for some things to do before opening an issue.
|
|
28
28
|
|
|
29
29
|
* **Feature requests**: Check that there is not an existing issue or discussion covering the scope of the feature you have in mind. If the feature is to another part of the Nuxt ecosystem (such as a module), please consider raising a feature request there first. If the feature you have in mind is general or the API is not entirely clear, consider opening a discussion in the **Ideas** section to discuss with the community first.
|
|
30
30
|
|
|
@@ -100,9 +100,9 @@ Our aim is ensuring quality and maintaining the joy of collaborating and communi
|
|
|
100
100
|
|
|
101
101
|
### Create a Module
|
|
102
102
|
|
|
103
|
-
If you've built something with Nuxt that's cool, why not [extract it into a module](/docs/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.
|
|
103
|
+
If you've built something with Nuxt that's cool, why not [extract it into a module](/docs/3.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.
|
|
104
104
|
|
|
105
|
-
If you need help while building it, feel free to [check in with us](/docs/community/getting-help).
|
|
105
|
+
If you need help while building it, feel free to [check in with us](/docs/3.x/community/getting-help).
|
|
106
106
|
|
|
107
107
|
### Make an RFC
|
|
108
108
|
|
|
@@ -126,7 +126,7 @@ The following conventions are _required_ within the `nuxt/` organization and rec
|
|
|
126
126
|
|
|
127
127
|
#### Module Conventions
|
|
128
128
|
|
|
129
|
-
Modules should follow the [Nuxt module template](https://github.com/nuxt/starter/tree/module). See [module guide](/docs/guide/going-further/modules) for more information.
|
|
129
|
+
Modules should follow the [Nuxt module template](https://github.com/nuxt/starter/tree/module). See [module guide](/docs/3.x/guide/going-further/modules) for more information.
|
|
130
130
|
|
|
131
131
|
#### Use Core `unjs/` Libraries
|
|
132
132
|
|
|
@@ -139,7 +139,7 @@ We recommend the following libraries which are used throughout the ecosystem:
|
|
|
139
139
|
|
|
140
140
|
#### Use ESM Syntax and Default to `type: module`
|
|
141
141
|
|
|
142
|
-
Most of the Nuxt ecosystem can consume ESM directly. In general we advocate that you avoid using CJS-specific code, such as `__dirname` and `require` statements. You can [read more about ESM](/docs/guide/concepts/esm).
|
|
142
|
+
Most of the Nuxt ecosystem can consume ESM directly. In general we advocate that you avoid using CJS-specific code, such as `__dirname` and `require` statements. You can [read more about ESM](/docs/3.x/guide/concepts/esm).
|
|
143
143
|
|
|
144
144
|
#### What's Corepack
|
|
145
145
|
|
|
@@ -4,7 +4,7 @@ navigation.icon: i-lucide-github
|
|
|
4
4
|
description: Some specific points about contributions to the framework repository.
|
|
5
5
|
---
|
|
6
6
|
|
|
7
|
-
Once you've read the [general contribution guide](/docs/community/contribution), here are some specific points to make about contributions to the [`nuxt/nuxt`](https://github.com/nuxt/nuxt) repository.
|
|
7
|
+
Once you've read the [general contribution guide](/docs/3.x/community/contribution), here are some specific points to make about contributions to the [`nuxt/nuxt`](https://github.com/nuxt/nuxt) repository.
|
|
8
8
|
|
|
9
9
|
## Monorepo Guide
|
|
10
10
|
|
|
@@ -88,7 +88,7 @@ If there are still errors left, you must correct them manually.
|
|
|
88
88
|
If you are adding a new feature or refactoring or changing the behavior of Nuxt in any other manner, you'll likely want to document the changes. Please include any changes to the docs in the same PR. You don't have to write documentation up on the first commit (but please do so as soon as your pull request is mature enough).
|
|
89
89
|
|
|
90
90
|
::important
|
|
91
|
-
Make sure to make changes according to the [Documentation Style Guide](/docs/community/contribution#documentation-style-guide).
|
|
91
|
+
Make sure to make changes according to the [Documentation Style Guide](/docs/3.x/community/contribution#documentation-style-guide).
|
|
92
92
|
::
|
|
93
93
|
|
|
94
94
|
### Final Checklist
|
|
@@ -100,7 +100,7 @@ When submitting your PR, there is a simple template that you have to fill out. P
|
|
|
100
100
|
If you spot an area where we can improve documentation or error messages, please do open a PR - even if it's just to fix a typo!
|
|
101
101
|
|
|
102
102
|
::important
|
|
103
|
-
Make sure to make changes according to the [Documentation Style Guide](/docs/community/contribution#documentation-style-guide).
|
|
103
|
+
Make sure to make changes according to the [Documentation Style Guide](/docs/3.x/community/contribution#documentation-style-guide).
|
|
104
104
|
::
|
|
105
105
|
|
|
106
106
|
### Quick Edits
|
package/5.community/6.roadmap.md
CHANGED
|
@@ -63,7 +63,7 @@ The current active version of [Nuxt](https://nuxt.com) is **v4** which is availa
|
|
|
63
63
|
|
|
64
64
|
Nuxt 3 will continue to receive maintenance updates (both bug fixes and backports of features from Nuxt 4) until the end of January 2026.
|
|
65
65
|
|
|
66
|
-
Each active version has its own nightly releases which are generated automatically. For more about enabling the Nuxt nightly release channel, see [the nightly release channel docs](/docs/guide/going-further/nightly-release-channel).
|
|
66
|
+
Each active version has its own nightly releases which are generated automatically. For more about enabling the Nuxt nightly release channel, see [the nightly release channel docs](/docs/3.x/guide/going-further/nightly-release-channel).
|
|
67
67
|
|
|
68
68
|
Release | | Initial release | End Of Life | Docs
|
|
69
69
|
-------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- | ---------------------------- | ---------------------------------------
|
package/6.bridge/1.overview.md
CHANGED
|
@@ -4,11 +4,11 @@ description: Reduce the differences with Nuxt 3 and reduce the burden of migrati
|
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
::note
|
|
7
|
-
If you're starting a fresh Nuxt 3 project, please skip this section and go to [Nuxt 3 Installation](/docs/getting-started/introduction).
|
|
7
|
+
If you're starting a fresh Nuxt 3 project, please skip this section and go to [Nuxt 3 Installation](/docs/3.x/getting-started/introduction).
|
|
8
8
|
::
|
|
9
9
|
|
|
10
10
|
::warning
|
|
11
|
-
Nuxt Bridge provides identical features to Nuxt 3 ([docs](/docs/guide/concepts/auto-imports)) but there are some limitations, notably that [`useAsyncData`](/docs/api/composables/use-async-data) and [`useFetch`](/docs/api/composables/use-fetch) composables are not available. Please read the rest of this page for details.
|
|
11
|
+
Nuxt Bridge provides identical features to Nuxt 3 ([docs](/docs/3.x/guide/concepts/auto-imports)) but there are some limitations, notably that [`useAsyncData`](/docs/3.x/api/composables/use-async-data) and [`useFetch`](/docs/3.x/api/composables/use-fetch) composables are not available. Please read the rest of this page for details.
|
|
12
12
|
::
|
|
13
13
|
|
|
14
14
|
Bridge is a forward-compatibility layer that allows you to experience many of the new Nuxt 3 features by simply installing and enabling a Nuxt module.
|
|
@@ -80,13 +80,13 @@ bun add -D @nuxt/bridge nuxi
|
|
|
80
80
|
|
|
81
81
|
Please make sure to avoid any CommonJS syntax such as `module.exports`, `require` or `require.resolve` in your config file. It will soon be deprecated and unsupported.
|
|
82
82
|
|
|
83
|
-
You can use static `import`, dynamic `import()` and `export default` instead. Using TypeScript by renaming to [`nuxt.config.ts`](/docs/guide/directory-structure/nuxt-config) is also possible and recommended.
|
|
83
|
+
You can use static `import`, dynamic `import()` and `export default` instead. Using TypeScript by renaming to [`nuxt.config.ts`](/docs/3.x/guide/directory-structure/nuxt-config) is also possible and recommended.
|
|
84
84
|
|
|
85
85
|
```ts [nuxt.config.ts]
|
|
86
86
|
import { defineNuxtConfig } from '@nuxt/bridge'
|
|
87
87
|
|
|
88
88
|
export default defineNuxtConfig({
|
|
89
|
-
bridge: false
|
|
89
|
+
bridge: false,
|
|
90
90
|
})
|
|
91
91
|
```
|
|
92
92
|
|
|
@@ -116,22 +116,22 @@ Try running `nuxt2` once here. You will see that the application works as before
|
|
|
116
116
|
With Nuxt Bridge, the migration to Nuxt 3 can proceed in steps.
|
|
117
117
|
The below `Upgrade Steps` does not need to be done all at once.
|
|
118
118
|
|
|
119
|
-
- [TypeScript](/docs/bridge/typescript)
|
|
119
|
+
- [TypeScript](/docs/3.x/bridge/typescript)
|
|
120
120
|
|
|
121
|
-
- [Migrate Legacy Composition API](/docs/bridge/bridge-composition-api)
|
|
121
|
+
- [Migrate Legacy Composition API](/docs/3.x/bridge/bridge-composition-api)
|
|
122
122
|
|
|
123
|
-
- [Plugins and Middleware](/docs/bridge/plugins-and-middleware)
|
|
123
|
+
- [Plugins and Middleware](/docs/3.x/bridge/plugins-and-middleware)
|
|
124
124
|
|
|
125
|
-
- [Migrate New Composition API](/docs/bridge/nuxt3-compatible-api)
|
|
125
|
+
- [Migrate New Composition API](/docs/3.x/bridge/nuxt3-compatible-api)
|
|
126
126
|
|
|
127
|
-
- [Meta Tags](/docs/bridge/meta)
|
|
127
|
+
- [Meta Tags](/docs/3.x/bridge/meta)
|
|
128
128
|
|
|
129
|
-
- [Runtime Config](/docs/bridge/runtime-config)
|
|
129
|
+
- [Runtime Config](/docs/3.x/bridge/runtime-config)
|
|
130
130
|
|
|
131
|
-
- [Nitro](/docs/bridge/nitro)
|
|
131
|
+
- [Nitro](/docs/3.x/bridge/nitro)
|
|
132
132
|
|
|
133
|
-
- [Vite](/docs/bridge/vite)
|
|
133
|
+
- [Vite](/docs/3.x/bridge/vite)
|
|
134
134
|
|
|
135
135
|
## Migrate from CommonJS to ESM
|
|
136
136
|
|
|
137
|
-
Nuxt 3 natively supports TypeScript and ECMAScript Modules. Please check [Native ES Modules](/docs/guide/concepts/esm) for more info and upgrading.
|
|
137
|
+
Nuxt 3 natively supports TypeScript and ECMAScript Modules. Please check [Native ES Modules](/docs/3.x/guide/concepts/esm) for more info and upgrading.
|
|
@@ -11,6 +11,7 @@ You can check [bridge/src/module.ts](https://github.com/nuxt/bridge/blob/main/pa
|
|
|
11
11
|
|
|
12
12
|
```ts [nuxt.config.ts]
|
|
13
13
|
import { defineNuxtConfig } from '@nuxt/bridge'
|
|
14
|
+
|
|
14
15
|
export default defineNuxtConfig({
|
|
15
16
|
bridge: {
|
|
16
17
|
|
|
@@ -63,7 +64,7 @@ export default defineNuxtConfig({
|
|
|
63
64
|
|
|
64
65
|
vite: {
|
|
65
66
|
// Config for Vite
|
|
66
|
-
}
|
|
67
|
+
},
|
|
67
68
|
})
|
|
68
69
|
```
|
|
69
70
|
|
package/6.bridge/2.typescript.md
CHANGED
|
@@ -16,8 +16,8 @@ import { defineNuxtConfig } from '@nuxt/bridge'
|
|
|
16
16
|
export default defineNuxtConfig({
|
|
17
17
|
bridge: {
|
|
18
18
|
typescript: true,
|
|
19
|
-
nitro: false // If migration to Nitro is complete, set to true
|
|
20
|
-
}
|
|
19
|
+
nitro: false, // If migration to Nitro is complete, set to true
|
|
20
|
+
},
|
|
21
21
|
})
|
|
22
22
|
```
|
|
23
23
|
|
|
@@ -35,9 +35,9 @@ Because some composables have been removed and don't yet have a replacement, thi
|
|
|
35
35
|
|
|
36
36
|
You don't have to immediately update your imports yet - Nuxt Bridge will automatically provide a 'shim' for most imports you currently have, to give you time to migrate to the new, Nuxt 3-compatible composables, with the following exceptions:
|
|
37
37
|
|
|
38
|
-
- `withContext` has been removed. See [below](/docs/bridge/nuxt3-compatible-api#usecontext-and-withcontext).
|
|
38
|
+
- `withContext` has been removed. See [below](/docs/3.x/bridge/nuxt3-compatible-api#usecontext-and-withcontext).
|
|
39
39
|
- `useStatic` has been removed. There is no current replacement. Feel free to raise a discussion if you have a use case for this.
|
|
40
|
-
- `reqRef` and `reqSsrRef`, which were deprecated, have now been removed entirely. Follow the instructions below regarding [ssrRef](/docs/bridge/nuxt3-compatible-api#ssrref-and-shallowssrref) to replace this.
|
|
40
|
+
- `reqRef` and `reqSsrRef`, which were deprecated, have now been removed entirely. Follow the instructions below regarding [ssrRef](/docs/3.x/bridge/nuxt3-compatible-api#ssrref-and-shallowssrref) to replace this.
|
|
41
41
|
|
|
42
42
|
### Set `bridge.capi`
|
|
43
43
|
|
|
@@ -47,8 +47,8 @@ import { defineNuxtConfig } from '@nuxt/bridge'
|
|
|
47
47
|
export default defineNuxtConfig({
|
|
48
48
|
bridge: {
|
|
49
49
|
capi: true,
|
|
50
|
-
nitro: false // If migration to Nitro is complete, set to true
|
|
51
|
-
}
|
|
50
|
+
nitro: false, // If migration to Nitro is complete, set to true
|
|
51
|
+
},
|
|
52
52
|
})
|
|
53
53
|
```
|
|
54
54
|
|
|
@@ -117,9 +117,9 @@ While this example is valid, Nuxt 3 introduces a new defineNuxtPlugin function t
|
|
|
117
117
|
|
|
118
118
|
### `useRouter` and `useRoute`
|
|
119
119
|
|
|
120
|
-
Nuxt Bridge provides direct replacements for these composables via [`useRouter`](/docs/api/composables/use-router) and `useRoute`.
|
|
120
|
+
Nuxt Bridge provides direct replacements for these composables via [`useRouter`](/docs/3.x/api/composables/use-router) and `useRoute`.
|
|
121
121
|
|
|
122
|
-
The only key difference is that [`useRoute`](/docs/api/composables/use-route) no longer returns a computed property.
|
|
122
|
+
The only key difference is that [`useRoute`](/docs/3.x/api/composables/use-route) no longer returns a computed property.
|
|
123
123
|
|
|
124
124
|
```diff
|
|
125
125
|
- import { useRouter, useRoute } from '@nuxtjs/composition-api'
|
|
@@ -7,17 +7,17 @@ description: 'Learn how to migrate from Nuxt 2 to Nuxt Bridge new plugins and mi
|
|
|
7
7
|
|
|
8
8
|
You can now migrate to the Nuxt 3 plugins API, which is slightly different in format from Nuxt 2.
|
|
9
9
|
|
|
10
|
-
Plugins now take only one argument (`nuxtApp`). You can find out more in [the docs](/docs/guide/directory-structure/plugins).
|
|
10
|
+
Plugins now take only one argument (`nuxtApp`). You can find out more in [the docs](/docs/3.x/guide/directory-structure/plugins).
|
|
11
11
|
|
|
12
|
-
```
|
|
13
|
-
export default defineNuxtPlugin(nuxtApp => {
|
|
12
|
+
```ts [plugins/hello.ts]
|
|
13
|
+
export default defineNuxtPlugin((nuxtApp) => {
|
|
14
14
|
nuxtApp.provide('injected', () => 'my injected function')
|
|
15
15
|
// now available on `nuxtApp.$injected`
|
|
16
16
|
})
|
|
17
17
|
```
|
|
18
18
|
|
|
19
19
|
::note
|
|
20
|
-
If you want to use the new Nuxt composables (such as [`useNuxtApp`](/docs/api/composables/use-nuxt-app) or `useRuntimeConfig`) within your plugins, you will need to use the `defineNuxtPlugin` helper for those plugins.
|
|
20
|
+
If you want to use the new Nuxt composables (such as [`useNuxtApp`](/docs/3.x/api/composables/use-nuxt-app) or `useRuntimeConfig`) within your plugins, you will need to use the `defineNuxtPlugin` helper for those plugins.
|
|
21
21
|
::
|
|
22
22
|
|
|
23
23
|
::warning
|
|
@@ -28,7 +28,7 @@ Although a compatibility interface is provided via `nuxtApp.vueApp` you should a
|
|
|
28
28
|
|
|
29
29
|
You can now migrate to the Nuxt 3 middleware API, which is slightly different in format from Nuxt 2.
|
|
30
30
|
|
|
31
|
-
Middleware now take only two argument (`to`, `from`). You can find out more in [the docs](/docs/guide/directory-structure/middleware).
|
|
31
|
+
Middleware now take only two argument (`to`, `from`). You can find out more in [the docs](/docs/3.x/guide/directory-structure/middleware).
|
|
32
32
|
|
|
33
33
|
```ts twoslash
|
|
34
34
|
export default defineNuxtRouteMiddleware((to) => {
|
|
@@ -44,7 +44,7 @@ Use of `defineNuxtRouteMiddleware` is not supported outside of the middleware di
|
|
|
44
44
|
|
|
45
45
|
## definePageMeta
|
|
46
46
|
|
|
47
|
-
You can also use [`definePageMeta`](/docs/api/utils/define-page-meta) in Nuxt Bridge.
|
|
47
|
+
You can also use [`definePageMeta`](/docs/3.x/api/utils/define-page-meta) in Nuxt Bridge.
|
|
48
48
|
|
|
49
49
|
You can be enabled with the `macros.pageMeta` option in your configuration file
|
|
50
50
|
|
|
@@ -54,9 +54,9 @@ import { defineNuxtConfig } from '@nuxt/bridge'
|
|
|
54
54
|
export default defineNuxtConfig({
|
|
55
55
|
bridge: {
|
|
56
56
|
macros: {
|
|
57
|
-
pageMeta: true
|
|
58
|
-
}
|
|
59
|
-
}
|
|
57
|
+
pageMeta: true,
|
|
58
|
+
},
|
|
59
|
+
},
|
|
60
60
|
})
|
|
61
61
|
```
|
|
62
62
|
|