@nuxt/docs-nightly 4.2.1-29360927.606ef13e → 4.2.1-29360990.b3040970
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/02.installation.md +2 -2
- package/1.getting-started/03.configuration.md +4 -4
- package/1.getting-started/04.views.md +2 -2
- package/1.getting-started/05.assets.md +1 -1
- package/1.getting-started/06.styling.md +11 -11
- package/1.getting-started/09.transitions.md +6 -6
- package/1.getting-started/10.data-fetching.md +2 -2
- package/1.getting-started/11.state-management.md +2 -2
- package/1.getting-started/12.error-handling.md +4 -4
- package/1.getting-started/13.server.md +4 -4
- package/1.getting-started/14.layers.md +1 -1
- package/1.getting-started/17.testing.md +3 -3
- package/1.getting-started/18.upgrade.md +3 -3
- package/2.guide/1.directory-structure/1.app/1.components.md +4 -4
- package/2.guide/1.directory-structure/1.app/1.composables.md +1 -1
- package/2.guide/1.directory-structure/1.app/1.layouts.md +2 -2
- package/2.guide/1.directory-structure/1.app/1.middleware.md +4 -4
- package/2.guide/1.directory-structure/1.app/1.pages.md +13 -13
- package/2.guide/1.directory-structure/1.app/1.plugins.md +1 -1
- package/2.guide/1.directory-structure/1.node_modules.md +1 -1
- package/2.guide/1.directory-structure/1.public.md +1 -1
- package/2.guide/1.directory-structure/1.server.md +2 -2
- package/2.guide/1.directory-structure/2.env.md +1 -1
- package/2.guide/2.concepts/1.auto-imports.md +2 -2
- package/2.guide/2.concepts/10.nuxt-lifecycle.md +3 -3
- package/2.guide/2.concepts/2.vuejs-development.md +3 -3
- package/2.guide/2.concepts/3.rendering.md +4 -4
- package/2.guide/2.concepts/7.esm.md +2 -2
- package/2.guide/2.concepts/9.code-style.md +1 -1
- package/2.guide/3.going-further/1.experimental-features.md +2 -2
- package/2.guide/3.going-further/1.features.md +1 -1
- package/2.guide/3.going-further/1.internals.md +2 -2
- package/2.guide/3.going-further/2.hooks.md +1 -1
- package/2.guide/3.going-further/3.modules.md +2 -2
- package/2.guide/3.going-further/6.nuxt-app.md +5 -5
- package/2.guide/3.going-further/7.layers.md +2 -2
- package/2.guide/3.going-further/9.debugging.md +1 -1
- package/2.guide/4.recipes/1.custom-routing.md +4 -4
- package/2.guide/4.recipes/3.custom-usefetch.md +1 -1
- package/2.guide/5.best-practices/hydration.md +1 -1
- package/3.api/1.components/10.nuxt-picture.md +1 -1
- package/3.api/1.components/11.teleports.md +1 -1
- package/3.api/1.components/12.nuxt-route-announcer.md +1 -1
- package/3.api/1.components/2.nuxt-page.md +1 -1
- package/3.api/1.components/4.nuxt-link.md +11 -11
- package/3.api/1.components/5.nuxt-loading-indicator.md +1 -1
- package/3.api/1.components/6.nuxt-error-boundary.md +1 -1
- package/3.api/2.composables/use-app-config.md +1 -1
- package/3.api/2.composables/use-cookie.md +6 -6
- package/3.api/2.composables/use-fetch.md +1 -1
- package/3.api/2.composables/use-nuxt-app.md +6 -6
- package/3.api/2.composables/use-route.md +1 -1
- package/3.api/2.composables/use-router.md +15 -15
- package/3.api/2.composables/use-state.md +1 -1
- package/3.api/3.utils/abort-navigation.md +2 -2
- package/3.api/3.utils/define-lazy-hydration-component.md +4 -4
- package/3.api/3.utils/define-nuxt-component.md +1 -1
- package/3.api/3.utils/define-nuxt-plugin.md +1 -1
- package/3.api/3.utils/define-nuxt-route-middleware.md +1 -1
- package/3.api/3.utils/define-page-meta.md +8 -8
- package/3.api/3.utils/navigate-to.md +4 -4
- package/3.api/3.utils/on-before-route-leave.md +1 -1
- package/3.api/3.utils/on-before-route-update.md +1 -1
- package/3.api/3.utils/update-app-config.md +2 -2
- package/3.api/5.kit/1.modules.md +2 -2
- package/3.api/5.kit/14.builder.md +6 -6
- package/3.api/6.advanced/1.hooks.md +5 -5
- package/3.api/6.nuxt-config.md +24 -24
- package/5.community/4.contribution.md +1 -1
- package/5.community/5.framework-contribution.md +8 -8
- package/5.community/6.roadmap.md +3 -3
- package/6.bridge/4.plugins-and-middleware.md +1 -1
- package/7.migration/2.configuration.md +2 -2
- package/7.migration/20.module-authors.md +1 -1
- package/7.migration/5.plugins-and-middleware.md +1 -1
- package/7.migration/6.pages-and-layouts.md +2 -2
- package/README.md +1 -1
- package/package.json +1 -1
|
@@ -26,17 +26,17 @@ If you only need the router instance within your template, use `$router`:
|
|
|
26
26
|
|
|
27
27
|
If you have a `app/pages/` directory, `useRouter` is identical in behavior to the one provided by `vue-router`.
|
|
28
28
|
|
|
29
|
-
::read-more{icon="i-simple-icons-vuedotjs" to="https://router.vuejs.org/api/interfaces/
|
|
29
|
+
::read-more{icon="i-simple-icons-vuedotjs" to="https://router.vuejs.org/api/interfaces/router#Properties-currentRoute-" target="_blank"}
|
|
30
30
|
Read `vue-router` documentation about the `Router` interface.
|
|
31
31
|
::
|
|
32
32
|
|
|
33
33
|
## Basic Manipulation
|
|
34
34
|
|
|
35
|
-
- [`addRoute()`](https://router.vuejs.org/api/interfaces/
|
|
36
|
-
- [`removeRoute()`](https://router.vuejs.org/api/interfaces/
|
|
37
|
-
- [`getRoutes()`](https://router.vuejs.org/api/interfaces/
|
|
38
|
-
- [`hasRoute()`](https://router.vuejs.org/api/interfaces/
|
|
39
|
-
- [`resolve()`](https://router.vuejs.org/api/interfaces/
|
|
35
|
+
- [`addRoute()`](https://router.vuejs.org/api/interfaces/router#addRoute-): Add a new route to the router instance. `parentName` can be provided to add new route as the child of an existing route.
|
|
36
|
+
- [`removeRoute()`](https://router.vuejs.org/api/interfaces/router#removeRoute-): Remove an existing route by its name.
|
|
37
|
+
- [`getRoutes()`](https://router.vuejs.org/api/interfaces/router#getRoutes-): Get a full list of all the route records.
|
|
38
|
+
- [`hasRoute()`](https://router.vuejs.org/api/interfaces/router#hasRoute-): Checks if a route with a given name exists.
|
|
39
|
+
- [`resolve()`](https://router.vuejs.org/api/interfaces/router#resolve-): Returns the normalized version of a route location. Also includes an `href` property that includes any existing base.
|
|
40
40
|
|
|
41
41
|
```ts [Example]
|
|
42
42
|
const router = useRouter()
|
|
@@ -49,16 +49,16 @@ router.resolve({ name: 'home' })
|
|
|
49
49
|
```
|
|
50
50
|
|
|
51
51
|
::note
|
|
52
|
-
`router.addRoute()` adds route details into an array of routes and it is useful while building [Nuxt plugins](/docs/4.x/guide/directory-structure/plugins) while `router.push()` on the other hand, triggers a new navigation immediately and it is useful in pages, Vue components and composable.
|
|
52
|
+
`router.addRoute()` adds route details into an array of routes and it is useful while building [Nuxt plugins](/docs/4.x/guide/directory-structure/app/plugins) while `router.push()` on the other hand, triggers a new navigation immediately and it is useful in pages, Vue components and composable.
|
|
53
53
|
::
|
|
54
54
|
|
|
55
55
|
## Based on History API
|
|
56
56
|
|
|
57
|
-
- [`back()`](https://router.vuejs.org/api/interfaces/
|
|
58
|
-
- [`forward()`](https://router.vuejs.org/api/interfaces/
|
|
59
|
-
- [`go()`](https://router.vuejs.org/api/interfaces/
|
|
60
|
-
- [`push()`](https://router.vuejs.org/api/interfaces/
|
|
61
|
-
- [`replace()`](https://router.vuejs.org/api/interfaces/
|
|
57
|
+
- [`back()`](https://router.vuejs.org/api/interfaces/router#back-): Go back in history if possible, same as `router.go(-1)`.
|
|
58
|
+
- [`forward()`](https://router.vuejs.org/api/interfaces/router#forward-): Go forward in history if possible, same as `router.go(1)`.
|
|
59
|
+
- [`go()`](https://router.vuejs.org/api/interfaces/router#go-): Move forward or backward through the history without the hierarchical restrictions enforced in `router.back()` and `router.forward()`.
|
|
60
|
+
- [`push()`](https://router.vuejs.org/api/interfaces/router#push-): Programmatically navigate to a new URL by pushing an entry in the history stack. **It is recommended to use [`navigateTo`](/docs/4.x/api/utils/navigate-to) instead.**
|
|
61
|
+
- [`replace()`](https://router.vuejs.org/api/interfaces/router#replace-): Programmatically navigate to a new URL by replacing the current entry in the routes history stack. **It is recommended to use [`navigateTo`](/docs/4.x/api/utils/navigate-to) instead.**
|
|
62
62
|
|
|
63
63
|
```ts [Example]
|
|
64
64
|
const router = useRouter()
|
|
@@ -84,10 +84,10 @@ However, Nuxt has a concept of **route middleware** that simplifies the implemen
|
|
|
84
84
|
|
|
85
85
|
## Promise and Error Handling
|
|
86
86
|
|
|
87
|
-
- [`isReady()`](https://router.vuejs.org/api/interfaces/
|
|
88
|
-
- [`onError`](https://router.vuejs.org/api/interfaces/
|
|
87
|
+
- [`isReady()`](https://router.vuejs.org/api/interfaces/router#isReady-): Returns a Promise that resolves when the router has completed the initial navigation.
|
|
88
|
+
- [`onError`](https://router.vuejs.org/api/interfaces/router#onError-): Adds an error handler that is called every time a non caught error happens during navigation.
|
|
89
89
|
|
|
90
|
-
:read-more{icon="i-simple-icons-vuedotjs" to="https://router.vuejs.org/api/interfaces/
|
|
90
|
+
:read-more{icon="i-simple-icons-vuedotjs" to="https://router.vuejs.org/api/interfaces/router#Methods-" title="Vue Router Docs" target="_blank"}
|
|
91
91
|
|
|
92
92
|
## Universal Router Instance
|
|
93
93
|
|
|
@@ -29,7 +29,7 @@ Because the data inside `useState` will be serialized to JSON, it is important t
|
|
|
29
29
|
|
|
30
30
|
## Using `shallowRef`
|
|
31
31
|
|
|
32
|
-
If you don't need your state to be deeply reactive, you can combine `useState` with [`shallowRef`](https://vuejs.org/api/reactivity-advanced
|
|
32
|
+
If you don't need your state to be deeply reactive, you can combine `useState` with [`shallowRef`](https://vuejs.org/api/reactivity-advanced#shallowref). This can improve performance when your state contains large objects and arrays.
|
|
33
33
|
|
|
34
34
|
```ts
|
|
35
35
|
const state = useState('my-shallow-state', () => shallowRef({ deep: 'not reactive' }))
|
|
@@ -22,7 +22,7 @@ export function abortNavigation (err?: Error | string): false
|
|
|
22
22
|
|
|
23
23
|
### `err`
|
|
24
24
|
|
|
25
|
-
- **Type**: [`Error`](https://developer.mozilla.org/
|
|
25
|
+
- **Type**: [`Error`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) | `string`
|
|
26
26
|
|
|
27
27
|
Optional error to be thrown by `abortNavigation`.
|
|
28
28
|
|
|
@@ -60,7 +60,7 @@ export default defineNuxtRouteMiddleware((to, from) => {
|
|
|
60
60
|
|
|
61
61
|
### `err` as an Error Object
|
|
62
62
|
|
|
63
|
-
You can pass the error as an [`Error`](https://developer.mozilla.org/
|
|
63
|
+
You can pass the error as an [`Error`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) object, e.g. caught by the `catch`-block:
|
|
64
64
|
|
|
65
65
|
```ts [app/middleware/auth.ts]
|
|
66
66
|
export default defineNuxtRouteMiddleware((to, from) => {
|
|
@@ -42,7 +42,7 @@ Read more about the options for `hydrate-on-visible`.
|
|
|
42
42
|
::
|
|
43
43
|
|
|
44
44
|
::note
|
|
45
|
-
Under the hood, this uses Vue's built-in [`hydrateOnVisible` strategy](https://vuejs.org/guide/components/async
|
|
45
|
+
Under the hood, this uses Vue's built-in [`hydrateOnVisible` strategy](https://vuejs.org/guide/components/async#hydrate-on-visible).
|
|
46
46
|
::
|
|
47
47
|
|
|
48
48
|
### Idle Strategy
|
|
@@ -70,7 +70,7 @@ The `hydrateOnIdle` prop is optional. You can pass a positive number to specify
|
|
|
70
70
|
Idle strategy is for components that can be hydrated when the browser is idle.
|
|
71
71
|
|
|
72
72
|
::note
|
|
73
|
-
Under the hood, this uses Vue's built-in [`hydrateOnIdle` strategy](https://vuejs.org/guide/components/async
|
|
73
|
+
Under the hood, this uses Vue's built-in [`hydrateOnIdle` strategy](https://vuejs.org/guide/components/async#hydrate-on-idle).
|
|
74
74
|
::
|
|
75
75
|
|
|
76
76
|
### Interaction Strategy
|
|
@@ -99,7 +99,7 @@ const LazyHydrationMyComponent = defineLazyHydrationComponent(
|
|
|
99
99
|
The `hydrateOnInteraction` prop is optional. If you do not pass an event or a list of events, it defaults to hydrating on `pointerenter`, `click`, and `focus`.
|
|
100
100
|
|
|
101
101
|
::note
|
|
102
|
-
Under the hood, this uses Vue's built-in [`hydrateOnInteraction` strategy](https://vuejs.org/guide/components/async
|
|
102
|
+
Under the hood, this uses Vue's built-in [`hydrateOnInteraction` strategy](https://vuejs.org/guide/components/async#hydrate-on-interaction).
|
|
103
103
|
::
|
|
104
104
|
|
|
105
105
|
### Media Query Strategy
|
|
@@ -126,7 +126,7 @@ const LazyHydrationMyComponent = defineLazyHydrationComponent(
|
|
|
126
126
|
```
|
|
127
127
|
|
|
128
128
|
::note
|
|
129
|
-
Under the hood, this uses Vue's built-in [`hydrateOnMediaQuery` strategy](https://vuejs.org/guide/components/async
|
|
129
|
+
Under the hood, this uses Vue's built-in [`hydrateOnMediaQuery` strategy](https://vuejs.org/guide/components/async#hydrate-on-media-query).
|
|
130
130
|
::
|
|
131
131
|
|
|
132
132
|
### Time Strategy
|
|
@@ -9,7 +9,7 @@ links:
|
|
|
9
9
|
---
|
|
10
10
|
|
|
11
11
|
::note
|
|
12
|
-
`defineNuxtComponent()` is a helper function for defining type safe Vue components using options API similar to [`defineComponent()`](https://vuejs.org/api/general
|
|
12
|
+
`defineNuxtComponent()` is a helper function for defining type safe Vue components using options API similar to [`defineComponent()`](https://vuejs.org/api/general#definecomponent). `defineNuxtComponent()` wrapper also adds support for `asyncData` and `head` component options.
|
|
13
13
|
::
|
|
14
14
|
|
|
15
15
|
::note
|
|
@@ -42,7 +42,7 @@ interface ObjectPlugin<T> {
|
|
|
42
42
|
## Parameters
|
|
43
43
|
|
|
44
44
|
**plugin**: A plugin can be defined in two ways:
|
|
45
|
-
1. **Function Plugin**: A function that receives the [`NuxtApp`](/docs/4.x/guide/going-further/internals#the-nuxtapp-interface) instance and can return a promise with
|
|
45
|
+
1. **Function Plugin**: A function that receives the [`NuxtApp`](/docs/4.x/guide/going-further/internals#the-nuxtapp-interface) instance and can return a promise with a potential object with a [`provide`](/docs/4.x/guide/directory-structure/app/plugins#providing-helpers) property if you want to provide a helper on [`NuxtApp`](/docs/4.x/guide/going-further/internals#the-nuxtapp-interface) instance.
|
|
46
46
|
2. **Object Plugin**: An object that can include various properties to configure the plugin's behavior, such as `name`, `enforce`, `dependsOn`, `order`, `parallel`, `setup`, `hooks`, and `env`.
|
|
47
47
|
|
|
48
48
|
| Property | Type | Required | Description |
|
|
@@ -28,7 +28,7 @@ interface RouteMiddleware {
|
|
|
28
28
|
|
|
29
29
|
A function that takes two Vue Router's route location objects as parameters: the next route `to` as the first, and the current route `from` as the second.
|
|
30
30
|
|
|
31
|
-
Learn more about available properties of `RouteLocationNormalized` in the **[Vue Router docs](https://router.vuejs.org/api/type-aliases/
|
|
31
|
+
Learn more about available properties of `RouteLocationNormalized` in the **[Vue Router docs](https://router.vuejs.org/api/type-aliases/routelocationnormalized)**.
|
|
32
32
|
|
|
33
33
|
## Examples
|
|
34
34
|
|
|
@@ -62,7 +62,7 @@ interface PageMeta {
|
|
|
62
62
|
|
|
63
63
|
- **Type**: `string`
|
|
64
64
|
|
|
65
|
-
You may define a [custom regular expression](/docs/4.x/api/
|
|
65
|
+
You may define a [custom regular expression](/docs/4.x/api/utils/define-page-meta#using-a-custom-regular-expression) if you have a more complex pattern than can be expressed with the file name.
|
|
66
66
|
|
|
67
67
|
**`props`**
|
|
68
68
|
|
|
@@ -78,9 +78,9 @@ interface PageMeta {
|
|
|
78
78
|
|
|
79
79
|
**`keepalive`**
|
|
80
80
|
|
|
81
|
-
- **Type**: `boolean` | [`KeepAliveProps`](https://vuejs.org/api/built-in-components
|
|
81
|
+
- **Type**: `boolean` | [`KeepAliveProps`](https://vuejs.org/api/built-in-components#keepalive)
|
|
82
82
|
|
|
83
|
-
Set to `true` when you want to preserve page state across route changes or use the [`KeepAliveProps`](https://vuejs.org/api/built-in-components
|
|
83
|
+
Set to `true` when you want to preserve page state across route changes or use the [`KeepAliveProps`](https://vuejs.org/api/built-in-components#keepalive) for a fine-grained control.
|
|
84
84
|
|
|
85
85
|
**`key`**
|
|
86
86
|
|
|
@@ -96,19 +96,19 @@ interface PageMeta {
|
|
|
96
96
|
|
|
97
97
|
**`layoutTransition`**
|
|
98
98
|
|
|
99
|
-
- **Type**: `boolean` | [`TransitionProps`](https://vuejs.org/api/built-in-components
|
|
99
|
+
- **Type**: `boolean` | [`TransitionProps`](https://vuejs.org/api/built-in-components#transition)
|
|
100
100
|
|
|
101
101
|
Set name of the transition to apply for current layout. You can also set this value to `false` to disable the layout transition.
|
|
102
102
|
|
|
103
103
|
**`middleware`**
|
|
104
104
|
|
|
105
|
-
- **Type**: `MiddlewareKey` | [`NavigationGuard`](https://router.vuejs.org/api/interfaces/
|
|
105
|
+
- **Type**: `MiddlewareKey` | [`NavigationGuard`](https://router.vuejs.org/api/interfaces/navigationguard) | `Array<MiddlewareKey | NavigationGuard>`
|
|
106
106
|
|
|
107
107
|
Define anonymous or named middleware directly within `definePageMeta`. Learn more about [route middleware](/docs/4.x/guide/directory-structure/app/middleware).
|
|
108
108
|
|
|
109
109
|
**`pageTransition`**
|
|
110
110
|
|
|
111
|
-
- **Type**: `boolean` | [`TransitionProps`](https://vuejs.org/api/built-in-components
|
|
111
|
+
- **Type**: `boolean` | [`TransitionProps`](https://vuejs.org/api/built-in-components#transition)
|
|
112
112
|
|
|
113
113
|
Set name of the transition to apply for current page. You can also set this value to `false` to disable the page transition.
|
|
114
114
|
|
|
@@ -122,7 +122,7 @@ interface PageMeta {
|
|
|
122
122
|
|
|
123
123
|
**`redirect`**
|
|
124
124
|
|
|
125
|
-
- **Type**: [`RouteRecordRedirectOption`](https://router.vuejs.org/guide/essentials/redirect-and-alias
|
|
125
|
+
- **Type**: [`RouteRecordRedirectOption`](https://router.vuejs.org/guide/essentials/redirect-and-alias)
|
|
126
126
|
|
|
127
127
|
Where to redirect if the route is directly matched. The redirection happens before any navigation guard and triggers a new navigation with the new target location.
|
|
128
128
|
|
|
@@ -215,7 +215,7 @@ definePageMeta({
|
|
|
215
215
|
</script>
|
|
216
216
|
```
|
|
217
217
|
|
|
218
|
-
For more examples see [Vue Router's Matching Syntax](https://router.vuejs.org/guide/essentials/route-matching-syntax
|
|
218
|
+
For more examples see [Vue Router's Matching Syntax](https://router.vuejs.org/guide/essentials/route-matching-syntax).
|
|
219
219
|
|
|
220
220
|
### Defining Layout
|
|
221
221
|
|
|
@@ -17,7 +17,7 @@ Make sure to always use `await` or `return` on result of `navigateTo` when calli
|
|
|
17
17
|
::
|
|
18
18
|
|
|
19
19
|
::note
|
|
20
|
-
`navigateTo` cannot be used within Nitro routes. To perform a server-side redirect in Nitro routes, use [`sendRedirect`](https://h3.dev/utils/response#
|
|
20
|
+
`navigateTo` cannot be used within Nitro routes. To perform a server-side redirect in Nitro routes, use [`sendRedirect`](https://h3.dev/utils/response#redirectlocation-status-statustext) instead.
|
|
21
21
|
::
|
|
22
22
|
|
|
23
23
|
### Within a Vue Component
|
|
@@ -148,7 +148,7 @@ type OpenWindowFeatures = {
|
|
|
148
148
|
|
|
149
149
|
### `to`
|
|
150
150
|
|
|
151
|
-
**Type**: [`RouteLocationRaw`](https://router.vuejs.org/api/interfaces/
|
|
151
|
+
**Type**: [`RouteLocationRaw`](https://router.vuejs.org/api/interfaces/routelocationoptions) | `undefined` | `null`
|
|
152
152
|
|
|
153
153
|
**Default**: `'/'`
|
|
154
154
|
|
|
@@ -186,9 +186,9 @@ An object accepting the following properties:
|
|
|
186
186
|
- **Type**: `number`
|
|
187
187
|
- **Default**: `302`
|
|
188
188
|
|
|
189
|
-
- `navigateTo` redirects to the given path and sets the redirect code to [`302 Found`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/302) by default when the redirection takes place on the server side.
|
|
189
|
+
- `navigateTo` redirects to the given path and sets the redirect code to [`302 Found`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status/302) by default when the redirection takes place on the server side.
|
|
190
190
|
|
|
191
|
-
This default behavior can be modified by providing different `redirectCode`. Commonly, [`301 Moved Permanently`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/301) can be used for permanent redirections.
|
|
191
|
+
This default behavior can be modified by providing different `redirectCode`. Commonly, [`301 Moved Permanently`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status/301) can be used for permanent redirections.
|
|
192
192
|
|
|
193
193
|
- `external`
|
|
194
194
|
|
|
@@ -8,4 +8,4 @@ links:
|
|
|
8
8
|
size: xs
|
|
9
9
|
---
|
|
10
10
|
|
|
11
|
-
:read-more{icon="i-simple-icons-vuedotjs" to="https://router.vuejs.org/api/functions/
|
|
11
|
+
:read-more{icon="i-simple-icons-vuedotjs" to="https://router.vuejs.org/api/functions/onbeforerouteleave" title="Vue Router Docs" target="_blank"}
|
|
@@ -8,4 +8,4 @@ links:
|
|
|
8
8
|
size: xs
|
|
9
9
|
---
|
|
10
10
|
|
|
11
|
-
:read-more{icon="i-simple-icons-vuedotjs" to="https://router.vuejs.org/api/functions/
|
|
11
|
+
:read-more{icon="i-simple-icons-vuedotjs" to="https://router.vuejs.org/api/functions/onbeforerouteupdate" title="Vue Router Docs" target="_blank"}
|
|
@@ -9,7 +9,7 @@ links:
|
|
|
9
9
|
---
|
|
10
10
|
|
|
11
11
|
::note
|
|
12
|
-
Updates the [`app.config`](/docs/4.x/guide/directory-structure/app-config) using deep assignment. Existing (nested) properties will be preserved.
|
|
12
|
+
Updates the [`app.config`](/docs/4.x/guide/directory-structure/app/app-config) using deep assignment. Existing (nested) properties will be preserved.
|
|
13
13
|
::
|
|
14
14
|
|
|
15
15
|
## Usage
|
|
@@ -25,4 +25,4 @@ updateAppConfig(newAppConfig)
|
|
|
25
25
|
console.log(appConfig) // { foo: 'baz' }
|
|
26
26
|
```
|
|
27
27
|
|
|
28
|
-
:read-more{to="/docs/4.x/guide/directory-structure/app-config"}
|
|
28
|
+
:read-more{to="/docs/4.x/guide/directory-structure/app/app-config"}
|
package/3.api/5.kit/1.modules.md
CHANGED
|
@@ -62,7 +62,7 @@ export function defineNuxtModule<TOptions extends ModuleOptions> (): {
|
|
|
62
62
|
| `defaults` | `T \| ((nuxt: Nuxt) => T)`{lang="ts"} | `false` | Default options for the module. If a function is provided, it will be called with the Nuxt instance as the first argument. |
|
|
63
63
|
| `schema` | `T` | `false` | Schema for the module options. If provided, options will be applied to the schema. |
|
|
64
64
|
| `hooks` | `Partial<NuxtHooks>`{lang="ts"} | `false` | Hooks to be installed for the module. If provided, the module will install the hooks. |
|
|
65
|
-
| `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](#specifying-module-dependencies). |
|
|
65
|
+
| `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). |
|
|
66
66
|
| `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. |
|
|
67
67
|
| `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. |
|
|
68
68
|
| `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. |
|
|
@@ -324,7 +324,7 @@ export default defineNuxtModule({
|
|
|
324
324
|
## `installModule`
|
|
325
325
|
|
|
326
326
|
::callout{type="warning"}
|
|
327
|
-
**Deprecated:** Use the [`moduleDependencies`](#specifying-module-dependencies) option in `defineNuxtModule` instead. The `installModule` function will be removed (or may become non-blocking) in a future version.
|
|
327
|
+
**Deprecated:** Use the [`moduleDependencies`](/docs/4.x/api/kit/modules#specifying-module-dependencies) option in `defineNuxtModule` instead. The `installModule` function will be removed (or may become non-blocking) in a future version.
|
|
328
328
|
::
|
|
329
329
|
|
|
330
330
|
Install specified Nuxt module programmatically. This is helpful when your module depends on other modules. You can pass the module options as an object to `inlineOptions` and they will be passed to the module's `setup` function.
|
|
@@ -83,8 +83,8 @@ import type { ExtendViteConfigOptions } from '@nuxt/kit'
|
|
|
83
83
|
function extendViteConfig (callback: ((config: ViteConfig) => void), options?: ExtendViteConfigOptions): void
|
|
84
84
|
```
|
|
85
85
|
|
|
86
|
-
::read-more{to="https://vite.dev/config" target="_blank" icon="i-simple-icons-vite"}
|
|
87
|
-
|
|
86
|
+
::read-more{to="https://vite.dev/config/" target="_blank" icon="i-simple-icons-vite"}
|
|
87
|
+
Check out the Vite website for more information about its configuration.
|
|
88
88
|
::
|
|
89
89
|
|
|
90
90
|
### Parameters
|
|
@@ -132,8 +132,8 @@ import type { ExtendWebpackConfigOptions } from '@nuxt/kit'
|
|
|
132
132
|
function extendWebpackConfig (callback: ((config: WebpackConfig) => void), options?: ExtendWebpackConfigOptions): void
|
|
133
133
|
```
|
|
134
134
|
|
|
135
|
-
::read-more{to="https://webpack.js.org/configuration" target="_blank" icon="i-simple-icons-webpack"}
|
|
136
|
-
|
|
135
|
+
::read-more{to="https://webpack.js.org/configuration/" target="_blank" icon="i-simple-icons-webpack"}
|
|
136
|
+
Check out webpack website for more information about its configuration.
|
|
137
137
|
::
|
|
138
138
|
|
|
139
139
|
### Parameters
|
|
@@ -202,7 +202,7 @@ function addVitePlugin (pluginOrGetter: VitePlugin | VitePlugin[] | (() => ViteP
|
|
|
202
202
|
```
|
|
203
203
|
|
|
204
204
|
::tip
|
|
205
|
-
See [Vite website](https://vite.dev/guide/api-plugin
|
|
205
|
+
See [Vite website](https://vite.dev/guide/api-plugin) for more information about Vite plugins. You can also use [this repository](https://github.com/vitejs/awesome-vite#plugins) to find a plugin that suits your needs.
|
|
206
206
|
::
|
|
207
207
|
|
|
208
208
|
### Parameters
|
|
@@ -261,7 +261,7 @@ function addWebpackPlugin (pluginOrGetter: WebpackPluginInstance | WebpackPlugin
|
|
|
261
261
|
```
|
|
262
262
|
|
|
263
263
|
::tip
|
|
264
|
-
See [webpack website](https://webpack.js.org/concepts/plugins) for more information about webpack plugins. You can also use [this collection](https://webpack.js.org/awesome-webpack/#webpack-plugins) to find a plugin that suits your needs.
|
|
264
|
+
See [webpack website](https://webpack.js.org/concepts/plugins/) for more information about webpack plugins. You can also use [this collection](https://webpack.js.org/awesome-webpack/#webpack-plugins) to find a plugin that suits your needs.
|
|
265
265
|
::
|
|
266
266
|
|
|
267
267
|
### Parameters
|
|
@@ -15,20 +15,20 @@ Hook | Arguments | Environment | Description
|
|
|
15
15
|
`app:error` | `err` | Server & Client | Called when a fatal error occurs.
|
|
16
16
|
`app:error:cleared` | `{ redirect? }` | Server & Client | Called when a fatal error occurs.
|
|
17
17
|
`vue:setup` | - | Server & Client | Called when the setup of Nuxt root is initialized. This callback must be synchronous.
|
|
18
|
-
`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
|
|
18
|
+
`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#onerrorcaptured).
|
|
19
19
|
`app:rendered` | `renderContext` | Server | Called when SSR rendering is done.
|
|
20
20
|
`app:redirected` | - | Server | Called before SSR redirection.
|
|
21
21
|
`app:beforeMount` | `vueApp` | Client | Called before mounting the app, called only on client side.
|
|
22
22
|
`app:mounted` | `vueApp` | Client | Called when Vue app is initialized and mounted in browser.
|
|
23
|
-
`app:suspense:resolve` | `appComponent` | Client | On [Suspense](https://vuejs.org/guide/built-ins/suspense
|
|
23
|
+
`app:suspense:resolve` | `appComponent` | Client | On [Suspense](https://vuejs.org/guide/built-ins/suspense#suspense) resolved event.
|
|
24
24
|
`app:manifest:update` | `{ id, timestamp }` | Client | Called when there is a newer version of your app detected.
|
|
25
25
|
`app:data:refresh` | `keys?` | Client | Called when `refreshNuxtData` is called.
|
|
26
26
|
`link:prefetch` | `to` | Client | Called when a `<NuxtLink>` is observed to be prefetched.
|
|
27
|
-
`page:start` | `pageComponent?` | Client | Called on [Suspense](https://vuejs.org/guide/built-ins/suspense
|
|
28
|
-
`page:finish` | `pageComponent?` | Client | Called on [Suspense](https://vuejs.org/guide/built-ins/suspense
|
|
27
|
+
`page:start` | `pageComponent?` | Client | Called on [Suspense](https://vuejs.org/guide/built-ins/suspense#suspense) inside of `NuxtPage` pending event.
|
|
28
|
+
`page:finish` | `pageComponent?` | Client | Called on [Suspense](https://vuejs.org/guide/built-ins/suspense#suspense) inside of `NuxtPage` resolved event.
|
|
29
29
|
`page:loading:start` | - | Client | Called when the `setup()` of the new page is running.
|
|
30
30
|
`page:loading:end` | - | Client | Called after `page:finish`
|
|
31
|
-
`page:transition:finish`| `pageComponent?` | Client | After page transition [onAfterLeave](https://vuejs.org/guide/built-ins/transition
|
|
31
|
+
`page:transition:finish`| `pageComponent?` | Client | After page transition [onAfterLeave](https://vuejs.org/guide/built-ins/transition#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
33
|
`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).
|
|
34
34
|
|
package/3.api/6.nuxt-config.md
CHANGED
|
@@ -202,7 +202,7 @@ This can be overridden with `definePageMeta` on an individual page. Only JSON-se
|
|
|
202
202
|
- **Type**: `boolean`
|
|
203
203
|
- **Default:** `false`
|
|
204
204
|
|
|
205
|
-
**See**: [Vue KeepAlive](https://vuejs.org/api/built-in-components
|
|
205
|
+
**See**: [Vue KeepAlive](https://vuejs.org/api/built-in-components#keepalive)
|
|
206
206
|
|
|
207
207
|
### `layoutTransition`
|
|
208
208
|
|
|
@@ -213,7 +213,7 @@ This can be overridden with `definePageMeta` on an individual page. Only JSON-se
|
|
|
213
213
|
- **Type**: `boolean`
|
|
214
214
|
- **Default:** `false`
|
|
215
215
|
|
|
216
|
-
**See**: [Vue Transition docs](https://vuejs.org/api/built-in-components
|
|
216
|
+
**See**: [Vue Transition docs](https://vuejs.org/api/built-in-components#transition)
|
|
217
217
|
|
|
218
218
|
### `pageTransition`
|
|
219
219
|
|
|
@@ -224,7 +224,7 @@ This can be overridden with `definePageMeta` on an individual page. Only JSON-se
|
|
|
224
224
|
- **Type**: `boolean`
|
|
225
225
|
- **Default:** `false`
|
|
226
226
|
|
|
227
|
-
**See**: [Vue Transition docs](https://vuejs.org/api/built-in-components
|
|
227
|
+
**See**: [Vue Transition docs](https://vuejs.org/api/built-in-components#transition)
|
|
228
228
|
|
|
229
229
|
### `rootAttrs`
|
|
230
230
|
|
|
@@ -339,7 +339,7 @@ Shared build configuration.
|
|
|
339
339
|
|
|
340
340
|
Nuxt allows visualizing your bundles and how to optimize them.
|
|
341
341
|
|
|
342
|
-
Set to `true` to enable bundle analysis, or pass an object with options: [for webpack](https://github.com/webpack
|
|
342
|
+
Set to `true` to enable bundle analysis, or pass an object with options: [for webpack](https://github.com/webpack/webpack-bundle-analyzer#options-for-plugin) or [for vite](https://github.com/btd/rollup-plugin-visualizer#options).
|
|
343
343
|
|
|
344
344
|
- **Type**: `object`
|
|
345
345
|
- **Default**
|
|
@@ -1146,7 +1146,7 @@ and these plugins do not need to be listed in `nuxt.config` unless you
|
|
|
1146
1146
|
need to customize their order. All plugins are deduplicated by their src path.
|
|
1147
1147
|
::
|
|
1148
1148
|
|
|
1149
|
-
**See**: [`app/plugins/` directory documentation](https://nuxt.com/docs/4.x/guide/directory-structure/plugins)
|
|
1149
|
+
**See**: [`app/plugins/` directory documentation](https://nuxt.com/docs/4.x/guide/directory-structure/app/plugins)
|
|
1150
1150
|
|
|
1151
1151
|
**Example**:
|
|
1152
1152
|
```ts
|
|
@@ -1217,7 +1217,7 @@ Additional router options passed to `vue-router`. On top of the options for `vue
|
|
|
1217
1217
|
For more control, you can use an `router.options.ts` file.
|
|
1218
1218
|
::
|
|
1219
1219
|
|
|
1220
|
-
**See**: [Vue Router documentation](https://router.vuejs.org/api/interfaces/routeroptions
|
|
1220
|
+
**See**: [Vue Router documentation](https://router.vuejs.org/api/interfaces/routeroptions)
|
|
1221
1221
|
|
|
1222
1222
|
#### `hashMode`
|
|
1223
1223
|
|
|
@@ -1586,7 +1586,7 @@ export default defineNuxtConfig({
|
|
|
1586
1586
|
|
|
1587
1587
|
Configuration that will be passed directly to Vite.
|
|
1588
1588
|
|
|
1589
|
-
**See**: [Vite configuration docs](https://vite.dev/config) for more information.
|
|
1589
|
+
**See**: [Vite configuration docs](https://vite.dev/config/) for more information.
|
|
1590
1590
|
Please note that not all vite options are supported in Nuxt.
|
|
1591
1591
|
|
|
1592
1592
|
### `build`
|
|
@@ -1785,13 +1785,13 @@ Vue.js config
|
|
|
1785
1785
|
|
|
1786
1786
|
Options for the Vue compiler that will be passed at build time.
|
|
1787
1787
|
|
|
1788
|
-
**See**: [Vue documentation](https://vuejs.org/api/application
|
|
1788
|
+
**See**: [Vue documentation](https://vuejs.org/api/application#app-config-compileroptions)
|
|
1789
1789
|
|
|
1790
1790
|
### `config`
|
|
1791
1791
|
|
|
1792
|
-
It is possible to pass configure the Vue app globally. Only serializable options may be set in your `nuxt.config`. All other options should be set at runtime in a Nuxt plugin
|
|
1792
|
+
It is possible to pass configure the Vue app globally. Only serializable options may be set in your `nuxt.config`. All other options should be set at runtime in a Nuxt plugin.
|
|
1793
1793
|
|
|
1794
|
-
**See**: [Vue app config documentation](https://vuejs.org/api/application
|
|
1794
|
+
**See**: [Vue app config documentation](https://vuejs.org/api/application#app-config)
|
|
1795
1795
|
|
|
1796
1796
|
### `propsDestructure`
|
|
1797
1797
|
|
|
@@ -1918,7 +1918,7 @@ Hard-replaces `typeof process`, `typeof window` and `typeof document` to tree-sh
|
|
|
1918
1918
|
|
|
1919
1919
|
If you are using webpack, Nuxt uses `webpack-bundle-analyzer` to visualize your bundles and how to optimize them.
|
|
1920
1920
|
|
|
1921
|
-
Set to `true` to enable bundle analysis, or pass an object with options: [for webpack](https://github.com/webpack
|
|
1921
|
+
Set to `true` to enable bundle analysis, or pass an object with options: [for webpack](https://github.com/webpack/webpack-bundle-analyzer#options-for-plugin) or [for vite](https://github.com/btd/rollup-plugin-visualizer#options).
|
|
1922
1922
|
|
|
1923
1923
|
- **Type**: `object`
|
|
1924
1924
|
- **Default**
|
|
@@ -1965,7 +1965,7 @@ Configure [webpack experiments](https://webpack.js.org/configuration/experiments
|
|
|
1965
1965
|
|
|
1966
1966
|
Enables Common CSS Extraction.
|
|
1967
1967
|
|
|
1968
|
-
Using [mini-css-extract-plugin](https://github.com/webpack
|
|
1968
|
+
Using [mini-css-extract-plugin](https://github.com/webpack/mini-css-extract-plugin) under the hood, your CSS will be extracted into separate files, usually one per component. This allows caching your CSS and JavaScript separately.
|
|
1969
1969
|
|
|
1970
1970
|
- **Type**: `boolean`
|
|
1971
1971
|
- **Default:** `true`
|
|
@@ -2067,7 +2067,7 @@ Set to `false` to disable the overlay provided by [FriendlyErrorsWebpackPlugin](
|
|
|
2067
2067
|
|
|
2068
2068
|
### `hotMiddleware`
|
|
2069
2069
|
|
|
2070
|
-
See [webpack-hot-middleware](https://github.com/webpack
|
|
2070
|
+
See [webpack-hot-middleware](https://github.com/webpack/webpack-hot-middleware) for available options.
|
|
2071
2071
|
|
|
2072
2072
|
### `loaders`
|
|
2073
2073
|
|
|
@@ -2075,7 +2075,7 @@ Customize the options of Nuxt's integrated webpack loaders.
|
|
|
2075
2075
|
|
|
2076
2076
|
#### `css`
|
|
2077
2077
|
|
|
2078
|
-
See [css-loader](https://github.com/webpack
|
|
2078
|
+
See [css-loader](https://github.com/webpack/css-loader) for available options.
|
|
2079
2079
|
|
|
2080
2080
|
##### `esModule`
|
|
2081
2081
|
|
|
@@ -2095,7 +2095,7 @@ See [css-loader](https://github.com/webpack-contrib/css-loader) for available op
|
|
|
2095
2095
|
|
|
2096
2096
|
#### `cssModules`
|
|
2097
2097
|
|
|
2098
|
-
See [css-loader](https://github.com/webpack
|
|
2098
|
+
See [css-loader](https://github.com/webpack/css-loader) for available options.
|
|
2099
2099
|
|
|
2100
2100
|
##### `esModule`
|
|
2101
2101
|
|
|
@@ -2137,7 +2137,7 @@ See [css-loader](https://github.com/webpack-contrib/css-loader) for available op
|
|
|
2137
2137
|
|
|
2138
2138
|
#### `file`
|
|
2139
2139
|
|
|
2140
|
-
**See**: [`file-loader` Options](https://github.com/webpack
|
|
2140
|
+
**See**: [`file-loader` Options](https://github.com/webpack/file-loader#options)
|
|
2141
2141
|
|
|
2142
2142
|
**Default**:
|
|
2143
2143
|
```json
|
|
@@ -2156,7 +2156,7 @@ See [css-loader](https://github.com/webpack-contrib/css-loader) for available op
|
|
|
2156
2156
|
|
|
2157
2157
|
#### `fontUrl`
|
|
2158
2158
|
|
|
2159
|
-
**See**: [`file-loader` Options](https://github.com/webpack
|
|
2159
|
+
**See**: [`file-loader` Options](https://github.com/webpack/file-loader#options)
|
|
2160
2160
|
|
|
2161
2161
|
**Default**:
|
|
2162
2162
|
```json
|
|
@@ -2175,7 +2175,7 @@ See [css-loader](https://github.com/webpack-contrib/css-loader) for available op
|
|
|
2175
2175
|
|
|
2176
2176
|
#### `imgUrl`
|
|
2177
2177
|
|
|
2178
|
-
**See**: [`file-loader` Options](https://github.com/webpack
|
|
2178
|
+
**See**: [`file-loader` Options](https://github.com/webpack/file-loader#options)
|
|
2179
2179
|
|
|
2180
2180
|
**Default**:
|
|
2181
2181
|
```json
|
|
@@ -2201,7 +2201,7 @@ See [css-loader](https://github.com/webpack-contrib/css-loader) for available op
|
|
|
2201
2201
|
}
|
|
2202
2202
|
```
|
|
2203
2203
|
|
|
2204
|
-
**See**: [`less-loader` Options](https://github.com/webpack
|
|
2204
|
+
**See**: [`less-loader` Options](https://github.com/webpack/less-loader#options)
|
|
2205
2205
|
|
|
2206
2206
|
#### `pugPlain`
|
|
2207
2207
|
|
|
@@ -2209,7 +2209,7 @@ See [css-loader](https://github.com/webpack-contrib/css-loader) for available op
|
|
|
2209
2209
|
|
|
2210
2210
|
#### `sass`
|
|
2211
2211
|
|
|
2212
|
-
**See**: [`sass-loader` Options](https://github.com/webpack
|
|
2212
|
+
**See**: [`sass-loader` Options](https://github.com/webpack/sass-loader#options)
|
|
2213
2213
|
|
|
2214
2214
|
**Default**:
|
|
2215
2215
|
```json
|
|
@@ -2236,7 +2236,7 @@ See [css-loader](https://github.com/webpack-contrib/css-loader) for available op
|
|
|
2236
2236
|
}
|
|
2237
2237
|
```
|
|
2238
2238
|
|
|
2239
|
-
**See**: [`sass-loader` Options](https://github.com/webpack
|
|
2239
|
+
**See**: [`sass-loader` Options](https://github.com/webpack/sass-loader#options)
|
|
2240
2240
|
|
|
2241
2241
|
#### `stylus`
|
|
2242
2242
|
|
|
@@ -2247,7 +2247,7 @@ See [css-loader](https://github.com/webpack-contrib/css-loader) for available op
|
|
|
2247
2247
|
}
|
|
2248
2248
|
```
|
|
2249
2249
|
|
|
2250
|
-
**See**: [`stylus-loader` Options](https://github.com/webpack
|
|
2250
|
+
**See**: [`stylus-loader` Options](https://github.com/webpack/stylus-loader#options)
|
|
2251
2251
|
|
|
2252
2252
|
#### `vue`
|
|
2253
2253
|
|
|
@@ -2341,7 +2341,7 @@ Defaults to true when `extractCSS` is enabled.
|
|
|
2341
2341
|
- **Type**: `boolean`
|
|
2342
2342
|
- **Default:** `false`
|
|
2343
2343
|
|
|
2344
|
-
**See**: [css-minimizer-webpack-plugin documentation](https://github.com/webpack
|
|
2344
|
+
**See**: [css-minimizer-webpack-plugin documentation](https://github.com/webpack/css-minimizer-webpack-plugin).
|
|
2345
2345
|
|
|
2346
2346
|
### `plugins`
|
|
2347
2347
|
|
|
@@ -2368,7 +2368,7 @@ export default defineNuxtConfig({
|
|
|
2368
2368
|
|
|
2369
2369
|
### `postcss`
|
|
2370
2370
|
|
|
2371
|
-
Customize PostCSS Loader. same options as [`postcss-loader` options](https://github.com/webpack
|
|
2371
|
+
Customize PostCSS Loader. same options as [`postcss-loader` options](https://github.com/webpack/postcss-loader#options)
|
|
2372
2372
|
|
|
2373
2373
|
#### `postcssOptions`
|
|
2374
2374
|
|
|
@@ -143,7 +143,7 @@ Most of the Nuxt ecosystem can consume ESM directly. In general we advocate that
|
|
|
143
143
|
|
|
144
144
|
#### What's Corepack
|
|
145
145
|
|
|
146
|
-
[Corepack](https://
|
|
146
|
+
[Corepack](https://github.com/nodejs/corepack) makes sure you are using the correct version for package manager when you run corresponding commands. Projects might have `packageManager` field in their `package.json`.
|
|
147
147
|
|
|
148
148
|
Under projects with configuration as shown below, Corepack will install `v7.5.0` of `pnpm` (if you don't have it already) and use it to run your commands.
|
|
149
149
|
|
|
@@ -8,19 +8,19 @@ Once you've read the [general contribution guide](/docs/4.x/community/contributi
|
|
|
8
8
|
|
|
9
9
|
## Monorepo Guide
|
|
10
10
|
|
|
11
|
-
- `packages/kit`: Toolkit for authoring Nuxt Modules, published as [`@nuxt/kit`](https://npmjs.com/package/@nuxt/kit).
|
|
12
|
-
- `packages/nuxt`: The core of Nuxt, published as [`nuxt`](https://npmjs.com/package/nuxt).
|
|
13
|
-
- `packages/schema`: Cross-version Nuxt typedefs and defaults, published as [`@nuxt/schema`](https://npmjs.com/package/@nuxt/schema).
|
|
14
|
-
- `packages/rspack`: The [Rspack](https://rspack.
|
|
15
|
-
- `packages/vite`: The [Vite](https://vite.dev) bundler for Nuxt, published as [`@nuxt/vite-builder`](https://npmjs.com/package/@nuxt/vite-builder).
|
|
16
|
-
- `packages/webpack`: The [webpack](https://webpack.js.org) bundler for Nuxt, published as [`@nuxt/webpack-builder`](https://npmjs.com/package/@nuxt/webpack-builder).
|
|
11
|
+
- `packages/kit`: Toolkit for authoring Nuxt Modules, published as [`@nuxt/kit`](https://www.npmjs.com/package/@nuxt/kit).
|
|
12
|
+
- `packages/nuxt`: The core of Nuxt, published as [`nuxt`](https://www.npmjs.com/package/nuxt).
|
|
13
|
+
- `packages/schema`: Cross-version Nuxt typedefs and defaults, published as [`@nuxt/schema`](https://www.npmjs.com/package/@nuxt/schema).
|
|
14
|
+
- `packages/rspack`: The [Rspack](https://rspack.rs) bundler for Nuxt, published as [`@nuxt/rspack-builder`](https://www.npmjs.com/package/@nuxt/rspack-builder).
|
|
15
|
+
- `packages/vite`: The [Vite](https://vite.dev) bundler for Nuxt, published as [`@nuxt/vite-builder`](https://www.npmjs.com/package/@nuxt/vite-builder).
|
|
16
|
+
- `packages/webpack`: The [webpack](https://webpack.js.org) bundler for Nuxt, published as [`@nuxt/webpack-builder`](https://www.npmjs.com/package/@nuxt/webpack-builder).
|
|
17
17
|
|
|
18
18
|
## Setup
|
|
19
19
|
|
|
20
20
|
To contribute to Nuxt, you need to set up a local environment.
|
|
21
21
|
|
|
22
|
-
1. [Fork](https://
|
|
23
|
-
2. Ensure using the latest [Node.js](https://nodejs.org/en)
|
|
22
|
+
1. [Fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo) the [`nuxt/nuxt`](https://github.com/nuxt/nuxt) repository to your own GitHub account and then [clone](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) it to your local device.
|
|
23
|
+
2. Ensure using the latest [Node.js](https://nodejs.org/en)
|
|
24
24
|
3. Enable [Corepack](https://github.com/nodejs/corepack) to have `pnpm` and `yarn`
|
|
25
25
|
```bash [Terminal]
|
|
26
26
|
corepack enable
|