@nuxt/docs-nightly 5.0.0-29354479.c2e19985 → 5.0.0-29550727.fea006dd
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 +1 -1
- package/1.getting-started/02.installation.md +7 -9
- package/1.getting-started/03.configuration.md +27 -27
- package/1.getting-started/04.views.md +5 -5
- package/1.getting-started/05.assets.md +8 -8
- package/1.getting-started/06.styling.md +20 -16
- package/1.getting-started/07.routing.md +11 -7
- package/1.getting-started/08.seo-meta.md +7 -3
- package/1.getting-started/09.transitions.md +110 -10
- package/1.getting-started/10.data-fetching.md +16 -16
- package/1.getting-started/11.state-management.md +3 -3
- package/1.getting-started/12.error-handling.md +18 -12
- package/1.getting-started/13.server.md +6 -6
- package/1.getting-started/14.layers.md +69 -16
- package/1.getting-started/15.prerendering.md +14 -0
- package/1.getting-started/16.deployment.md +4 -4
- package/1.getting-started/17.testing.md +110 -14
- package/1.getting-started/18.upgrade.md +218 -39
- package/{2.guide/1.directory-structure → 2.directory-structure}/0.nuxt.md +1 -1
- package/{2.guide/1.directory-structure → 2.directory-structure}/0.output.md +1 -1
- package/{2.guide/1.directory-structure → 2.directory-structure}/1.app/1.assets.md +2 -2
- package/{2.guide/1.directory-structure → 2.directory-structure}/1.app/1.components.md +10 -6
- package/{2.guide/1.directory-structure → 2.directory-structure}/1.app/1.composables.md +2 -2
- package/{2.guide/1.directory-structure → 2.directory-structure}/1.app/1.layouts.md +36 -4
- package/{2.guide/1.directory-structure → 2.directory-structure}/1.app/1.middleware.md +5 -5
- package/{2.guide/1.directory-structure → 2.directory-structure}/1.app/1.pages.md +38 -17
- package/{2.guide/1.directory-structure → 2.directory-structure}/1.app/1.plugins.md +6 -7
- package/{2.guide/1.directory-structure → 2.directory-structure}/1.app/1.utils.md +3 -3
- package/{2.guide/1.directory-structure → 2.directory-structure}/1.app/3.app.md +4 -4
- package/{2.guide/1.directory-structure → 2.directory-structure}/1.app/3.error.md +10 -8
- package/{2.guide/1.directory-structure → 2.directory-structure}/1.content.md +2 -2
- package/2.directory-structure/1.layers.md +87 -0
- package/{2.guide/1.directory-structure → 2.directory-structure}/1.modules.md +13 -3
- package/{2.guide/1.directory-structure → 2.directory-structure}/1.node_modules.md +2 -2
- package/{2.guide/1.directory-structure → 2.directory-structure}/1.public.md +1 -1
- package/{2.guide/1.directory-structure → 2.directory-structure}/1.server.md +38 -18
- package/{2.guide/1.directory-structure → 2.directory-structure}/1.shared.md +3 -3
- package/{2.guide/1.directory-structure → 2.directory-structure}/2.env.md +2 -2
- package/{2.guide/1.directory-structure → 2.directory-structure}/2.nuxtignore.md +1 -1
- package/{2.guide/1.directory-structure → 2.directory-structure}/2.nuxtrc.md +4 -1
- package/{2.guide/1.directory-structure → 2.directory-structure}/3.nuxt-config.md +1 -1
- package/{2.guide/1.directory-structure → 2.directory-structure}/3.package.md +1 -1
- package/2.directory-structure/3.tsconfig.md +70 -0
- package/2.directory-structure/index.md +65 -0
- package/{2.guide → 3.guide}/0.index.md +10 -7
- package/{2.guide/2.concepts/3.rendering.md → 3.guide/1.concepts/1.rendering.md} +9 -30
- package/{2.guide/2.concepts/2.vuejs-development.md → 3.guide/1.concepts/10.vuejs-development.md} +7 -6
- package/{2.guide/2.concepts/10.nuxt-lifecycle.md → 3.guide/1.concepts/2.nuxt-lifecycle.md} +33 -26
- package/{2.guide/2.concepts/1.auto-imports.md → 3.guide/1.concepts/3.auto-imports.md} +7 -7
- package/{2.guide/2.concepts → 3.guide/1.concepts}/4.server-engine.md +3 -3
- package/{2.guide/2.concepts → 3.guide/1.concepts}/5.modules.md +15 -2
- package/{2.guide/2.concepts → 3.guide/1.concepts}/7.esm.md +3 -2
- package/{2.guide/2.concepts → 3.guide/1.concepts}/8.typescript.md +19 -38
- package/{2.guide/2.concepts → 3.guide/1.concepts}/9.code-style.md +1 -1
- package/{2.guide/5.best-practices → 3.guide/2.best-practices}/hydration.md +14 -14
- package/{2.guide/5.best-practices → 3.guide/2.best-practices}/performance.md +4 -5
- package/3.guide/3.ai/.navigation.yml +3 -0
- package/3.guide/3.ai/1.mcp.md +277 -0
- package/3.guide/3.ai/2.llms-txt.md +65 -0
- package/3.guide/4.modules/.navigation.yml +3 -0
- package/3.guide/4.modules/1.getting-started.md +103 -0
- package/3.guide/4.modules/2.module-anatomy.md +138 -0
- package/3.guide/4.modules/3.recipes-basics.md +420 -0
- package/3.guide/4.modules/4.recipes-advanced.md +243 -0
- package/3.guide/4.modules/5.testing.md +76 -0
- package/3.guide/4.modules/6.best-practices.md +104 -0
- package/3.guide/4.modules/7.ecosystem.md +32 -0
- package/3.guide/4.modules/index.md +36 -0
- package/{2.guide/4.recipes → 3.guide/5.recipes}/1.custom-routing.md +5 -5
- package/{2.guide/4.recipes → 3.guide/5.recipes}/2.vite-plugin.md +5 -1
- package/{2.guide/4.recipes → 3.guide/5.recipes}/3.custom-usefetch.md +2 -2
- package/{2.guide/4.recipes → 3.guide/5.recipes}/4.sessions-and-authentication.md +4 -4
- package/{2.guide/3.going-further → 3.guide/6.going-further}/1.events.md +2 -3
- package/{2.guide/3.going-further → 3.guide/6.going-further}/1.experimental-features.md +106 -39
- package/{2.guide/3.going-further → 3.guide/6.going-further}/1.features.md +1 -1
- package/{2.guide/3.going-further → 3.guide/6.going-further}/1.internals.md +5 -4
- package/{2.guide/3.going-further → 3.guide/6.going-further}/10.runtime-config.md +3 -3
- package/{2.guide/3.going-further → 3.guide/6.going-further}/2.hooks.md +4 -4
- package/{2.guide/3.going-further → 3.guide/6.going-further}/4.kit.md +1 -1
- package/{2.guide/3.going-further → 3.guide/6.going-further}/6.nuxt-app.md +5 -5
- package/{2.guide/3.going-further → 3.guide/6.going-further}/7.layers.md +68 -25
- package/{2.guide/3.going-further → 3.guide/6.going-further}/9.debugging.md +1 -1
- package/{3.api → 4.api}/1.components/1.nuxt-client-fallback.md +4 -0
- package/{3.api → 4.api}/1.components/10.nuxt-picture.md +1 -1
- package/{3.api → 4.api}/1.components/11.teleports.md +1 -1
- package/{3.api → 4.api}/1.components/12.nuxt-route-announcer.md +5 -3
- package/{3.api → 4.api}/1.components/13.nuxt-time.md +5 -3
- package/4.api/1.components/14.nuxt-announcer.md +81 -0
- package/{3.api → 4.api}/1.components/2.nuxt-page.md +3 -3
- package/{3.api → 4.api}/1.components/3.nuxt-layout.md +6 -6
- package/{3.api → 4.api}/1.components/4.nuxt-link.md +11 -11
- package/{3.api → 4.api}/1.components/5.nuxt-loading-indicator.md +1 -1
- package/{3.api → 4.api}/1.components/6.nuxt-error-boundary.md +1 -1
- package/{3.api → 4.api}/1.components/7.nuxt-welcome.md +2 -2
- package/{3.api → 4.api}/1.components/8.nuxt-island.md +9 -2
- package/4.api/2.composables/use-announcer.md +128 -0
- package/{3.api → 4.api}/2.composables/use-app-config.md +1 -1
- package/{3.api → 4.api}/2.composables/use-async-data.md +79 -16
- package/4.api/2.composables/use-cookie.md +207 -0
- package/{3.api → 4.api}/2.composables/use-error.md +2 -2
- package/{3.api → 4.api}/2.composables/use-fetch.md +37 -35
- package/{3.api → 4.api}/2.composables/use-head-safe.md +37 -20
- package/4.api/2.composables/use-head.md +184 -0
- package/{3.api → 4.api}/2.composables/use-hydration.md +24 -18
- package/4.api/2.composables/use-lazy-async-data.md +96 -0
- package/4.api/2.composables/use-lazy-fetch.md +112 -0
- package/{3.api → 4.api}/2.composables/use-nuxt-app.md +9 -7
- package/{3.api → 4.api}/2.composables/use-nuxt-data.md +1 -1
- package/{3.api → 4.api}/2.composables/use-request-fetch.md +1 -1
- package/{3.api → 4.api}/2.composables/use-response-header.md +1 -1
- package/{3.api → 4.api}/2.composables/use-route-announcer.md +5 -3
- package/{3.api → 4.api}/2.composables/use-route.md +2 -2
- package/4.api/2.composables/use-router.md +94 -0
- package/{3.api → 4.api}/2.composables/use-runtime-config.md +1 -1
- package/{3.api → 4.api}/2.composables/use-runtime-hook.md +1 -1
- package/{3.api → 4.api}/2.composables/use-state.md +11 -1
- package/{3.api → 4.api}/3.utils/$fetch.md +1 -1
- package/{3.api → 4.api}/3.utils/abort-navigation.md +3 -3
- package/{3.api → 4.api}/3.utils/add-route-middleware.md +1 -1
- package/{3.api → 4.api}/3.utils/call-once.md +0 -2
- package/{3.api → 4.api}/3.utils/clear-nuxt-state.md +4 -2
- package/{3.api → 4.api}/3.utils/create-error.md +6 -6
- package/{3.api → 4.api}/3.utils/define-lazy-hydration-component.md +4 -4
- package/{3.api → 4.api}/3.utils/define-nuxt-component.md +1 -1
- package/4.api/3.utils/define-nuxt-plugin.md +102 -0
- package/{3.api → 4.api}/3.utils/define-nuxt-route-middleware.md +3 -3
- package/{3.api → 4.api}/3.utils/define-page-meta.md +30 -17
- package/{3.api → 4.api}/3.utils/navigate-to.md +15 -15
- package/{3.api → 4.api}/3.utils/on-before-route-leave.md +1 -1
- package/{3.api → 4.api}/3.utils/on-before-route-update.md +1 -1
- package/{3.api → 4.api}/3.utils/refresh-cookie.md +1 -3
- package/{3.api → 4.api}/3.utils/set-page-layout.md +36 -0
- package/{3.api → 4.api}/3.utils/set-response-status.md +2 -2
- package/{3.api → 4.api}/3.utils/show-error.md +3 -3
- package/{3.api → 4.api}/3.utils/update-app-config.md +2 -2
- package/{3.api → 4.api}/4.commands/add.md +12 -12
- package/4.api/4.commands/analyze.md +42 -0
- package/4.api/4.commands/build-module.md +42 -0
- package/4.api/4.commands/build.md +47 -0
- package/{3.api → 4.api}/4.commands/cleanup.md +6 -6
- package/4.api/4.commands/dev.md +60 -0
- package/{3.api → 4.api}/4.commands/devtools.md +7 -7
- package/4.api/4.commands/generate.md +42 -0
- package/4.api/4.commands/info.md +33 -0
- package/4.api/4.commands/init.md +50 -0
- package/4.api/4.commands/module.md +84 -0
- package/4.api/4.commands/prepare.md +41 -0
- package/4.api/4.commands/preview.md +44 -0
- package/4.api/4.commands/test.md +40 -0
- package/4.api/4.commands/typecheck.md +44 -0
- package/4.api/4.commands/upgrade.md +37 -0
- package/{3.api → 4.api}/5.kit/1.modules.md +32 -19
- package/{3.api → 4.api}/5.kit/10.templates.md +23 -23
- package/{3.api → 4.api}/5.kit/11.nitro.md +41 -37
- package/{3.api → 4.api}/5.kit/14.builder.md +35 -23
- package/{3.api → 4.api}/5.kit/16.layers.md +12 -12
- package/{3.api → 4.api}/5.kit/2.programmatic.md +2 -2
- package/{3.api → 4.api}/5.kit/4.autoimports.md +23 -19
- package/4.api/5.kit/5.components.md +146 -0
- package/4.api/5.kit/9.head.md +132 -0
- package/4.api/6.advanced/1.hooks.md +105 -0
- package/{3.api → 4.api}/6.nuxt-config.md +69 -51
- 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 +8 -8
- package/5.community/6.roadmap.md +26 -26
- package/5.community/7.changelog.md +20 -0
- package/6.bridge/1.overview.md +9 -1
- package/6.bridge/2.typescript.md +1 -1
- package/6.bridge/3.bridge-composition-api.md +1 -1
- package/6.bridge/4.plugins-and-middleware.md +3 -3
- package/6.bridge/8.nitro.md +4 -0
- package/7.migration/11.server.md +2 -2
- package/7.migration/2.configuration.md +5 -5
- package/7.migration/20.module-authors.md +3 -3
- package/7.migration/3.auto-imports.md +1 -1
- package/7.migration/5.plugins-and-middleware.md +2 -2
- package/7.migration/6.pages-and-layouts.md +6 -6
- package/7.migration/7.component-options.md +1 -1
- package/README.md +1 -1
- package/package.json +1 -1
- package/2.guide/1.directory-structure/3.tsconfig.md +0 -38
- package/2.guide/3.going-further/3.modules.md +0 -901
- package/3.api/2.composables/use-cookie.md +0 -183
- package/3.api/2.composables/use-head.md +0 -69
- package/3.api/2.composables/use-lazy-async-data.md +0 -47
- package/3.api/2.composables/use-lazy-fetch.md +0 -55
- package/3.api/2.composables/use-router.md +0 -94
- package/3.api/3.utils/define-nuxt-plugin.md +0 -102
- package/3.api/4.commands/analyze.md +0 -42
- package/3.api/4.commands/build-module.md +0 -42
- package/3.api/4.commands/build.md +0 -47
- package/3.api/4.commands/dev.md +0 -60
- package/3.api/4.commands/generate.md +0 -42
- package/3.api/4.commands/info.md +0 -33
- package/3.api/4.commands/init.md +0 -50
- package/3.api/4.commands/module.md +0 -84
- package/3.api/4.commands/prepare.md +0 -41
- package/3.api/4.commands/preview.md +0 -44
- package/3.api/4.commands/test.md +0 -40
- package/3.api/4.commands/typecheck.md +0 -44
- package/3.api/4.commands/upgrade.md +0 -37
- package/3.api/5.kit/5.components.md +0 -146
- package/3.api/6.advanced/1.hooks.md +0 -105
- /package/{2.guide/1.directory-structure → 2.directory-structure}/.navigation.yml +0 -0
- /package/{2.guide/1.directory-structure → 2.directory-structure}/1.app/.navigation.yml +0 -0
- /package/{2.guide/1.directory-structure → 2.directory-structure}/1.app/3.app-config.md +0 -0
- /package/{2.guide/1.directory-structure → 2.directory-structure}/2.gitignore.md +0 -0
- /package/{2.guide → 3.guide}/.navigation.yml +0 -0
- /package/{2.guide/2.concepts → 3.guide/1.concepts}/.navigation.yml +0 -0
- /package/{2.guide/5.best-practices → 3.guide/2.best-practices}/.navigation.yml +0 -0
- /package/{2.guide/5.best-practices → 3.guide/2.best-practices}/plugins.md +0 -0
- /package/{2.guide/4.recipes → 3.guide/5.recipes}/.navigation.yml +0 -0
- /package/{2.guide/3.going-further → 3.guide/6.going-further}/.navigation.yml +0 -0
- /package/{2.guide/3.going-further → 3.guide/6.going-further}/11.nightly-release-channel.md +0 -0
- /package/{2.guide/3.going-further → 3.guide/6.going-further}/index.md +0 -0
- /package/{3.api → 4.api}/.navigation.yml +0 -0
- /package/{3.api → 4.api}/1.components/.navigation.yml +0 -0
- /package/{3.api → 4.api}/1.components/1.client-only.md +0 -0
- /package/{3.api → 4.api}/1.components/1.dev-only.md +0 -0
- /package/{3.api → 4.api}/1.components/9.nuxt-img.md +0 -0
- /package/{3.api → 4.api}/2.composables/.navigation.yml +0 -0
- /package/{3.api → 4.api}/2.composables/on-prehydrate.md +0 -0
- /package/{3.api → 4.api}/2.composables/use-loading-indicator.md +0 -0
- /package/{3.api → 4.api}/2.composables/use-preview-mode.md +0 -0
- /package/{3.api → 4.api}/2.composables/use-request-event.md +0 -0
- /package/{3.api → 4.api}/2.composables/use-request-header.md +0 -0
- /package/{3.api → 4.api}/2.composables/use-request-headers.md +0 -0
- /package/{3.api → 4.api}/2.composables/use-request-url.md +0 -0
- /package/{3.api → 4.api}/2.composables/use-seo-meta.md +0 -0
- /package/{3.api → 4.api}/2.composables/use-server-seo-meta.md +0 -0
- /package/{3.api → 4.api}/3.utils/.navigation.yml +0 -0
- /package/{3.api → 4.api}/3.utils/clear-error.md +0 -0
- /package/{3.api → 4.api}/3.utils/clear-nuxt-data.md +0 -0
- /package/{3.api → 4.api}/3.utils/define-route-rules.md +0 -0
- /package/{3.api → 4.api}/3.utils/on-nuxt-ready.md +0 -0
- /package/{3.api → 4.api}/3.utils/prefetch-components.md +0 -0
- /package/{3.api → 4.api}/3.utils/preload-components.md +0 -0
- /package/{3.api → 4.api}/3.utils/preload-route-components.md +0 -0
- /package/{3.api → 4.api}/3.utils/prerender-routes.md +0 -0
- /package/{3.api → 4.api}/3.utils/refresh-nuxt-data.md +0 -0
- /package/{3.api → 4.api}/3.utils/reload-nuxt-app.md +0 -0
- /package/{3.api → 4.api}/4.commands/.navigation.yml +0 -0
- /package/{3.api → 4.api}/5.kit/.navigation.yml +0 -0
- /package/{3.api → 4.api}/5.kit/10.runtime-config.md +0 -0
- /package/{3.api → 4.api}/5.kit/12.resolving.md +0 -0
- /package/{3.api → 4.api}/5.kit/13.logging.md +0 -0
- /package/{3.api → 4.api}/5.kit/15.examples.md +0 -0
- /package/{3.api → 4.api}/5.kit/3.compatibility.md +0 -0
- /package/{3.api → 4.api}/5.kit/6.context.md +0 -0
- /package/{3.api → 4.api}/5.kit/7.pages.md +0 -0
- /package/{3.api → 4.api}/5.kit/8.layout.md +0 -0
- /package/{3.api → 4.api}/5.kit/9.plugins.md +0 -0
- /package/{3.api → 4.api}/6.advanced/.navigation.yml +0 -0
- /package/{3.api → 4.api}/6.advanced/2.import-meta.md +0 -0
- /package/{3.api → 4.api}/index.md +0 -0
|
@@ -19,7 +19,7 @@ If you want to play around with Nuxt in your browser, you can [try it out in one
|
|
|
19
19
|
|
|
20
20
|
Nuxt uses conventions and an opinionated directory structure to automate repetitive tasks and allow developers to focus on pushing features. The configuration file can still customize and override its default behaviors.
|
|
21
21
|
|
|
22
|
-
- **File-based routing:** define routes based on the structure of your [`app/pages/` directory](/docs/4.x/
|
|
22
|
+
- **File-based routing:** define routes based on the structure of your [`app/pages/` directory](/docs/4.x/directory-structure/app/pages). This can make it easier to organize your application and avoid the need for manual route configuration.
|
|
23
23
|
- **Code splitting:** Nuxt automatically splits your code into smaller chunks, which can help reduce the initial load time of your application.
|
|
24
24
|
- **Server-side rendering out of the box:** Nuxt comes with built-in SSR capabilities, so you don't have to set up a separate server yourself.
|
|
25
25
|
- **Auto-imports:** write Vue composables and components in their respective directories and use them without having to import them with the benefits of tree-shaking and optimized JS bundles.
|
|
@@ -17,25 +17,23 @@ Or follow the steps below to set up a new Nuxt project on your computer.
|
|
|
17
17
|
|
|
18
18
|
## New Project
|
|
19
19
|
|
|
20
|
-
|
|
21
|
-
<!-- markdownlint-disable-next-line MD001 -->
|
|
22
|
-
#### Prerequisites
|
|
20
|
+
### Prerequisites
|
|
23
21
|
|
|
24
22
|
- **Node.js** - [`20.x`](https://nodejs.org/en) or newer (but we recommend the [active LTS release](https://github.com/nodejs/release#release-schedule))
|
|
25
|
-
- **Text editor** - There is no IDE requirement, but we recommend [Visual Studio Code](https://code.visualstudio.com/) with the [official Vue extension](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (previously known as Volar) or [WebStorm](https://www.jetbrains.com/webstorm/), which, along with [other JetBrains IDEs](https://www.jetbrains.com/ides/), offers great Nuxt support right out-of-the-box.
|
|
23
|
+
- **Text editor** - There is no IDE requirement, but we recommend [Visual Studio Code](https://code.visualstudio.com/) with the [official Vue extension](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (previously known as Volar) or [WebStorm](https://www.jetbrains.com/webstorm/), which, along with [other JetBrains IDEs](https://www.jetbrains.com/ides/), offers great Nuxt support right out-of-the-box. If you use another editor, such as Neovim, you can configure [Vue Language Server](https://github.com/vuejs/language-tools) support by following the [Vue Language Tools setup guides](https://github.com/vuejs/language-tools/wiki).
|
|
26
24
|
- **Terminal** - In order to run Nuxt commands
|
|
27
25
|
|
|
28
26
|
::note
|
|
29
27
|
::details
|
|
30
28
|
:summary[Additional notes for an optimal setup:]
|
|
31
29
|
- **Node.js**: Make sure to use an even numbered version (20, 22, etc.)
|
|
32
|
-
- **
|
|
33
|
-
- **WSL**: If you are using Windows and experience slow HMR, you may want to try using [WSL (Windows Subsystem for Linux)](https://
|
|
34
|
-
- **Windows slow DNS resolution
|
|
30
|
+
- **Neovim**: When configuring the Vue TypeScript plugin, make sure `location` points to the `@vue/language-server` package directory, not its binary. See the [Neovim setup guide](https://github.com/vuejs/language-tools/wiki/Neovim) for a working configuration.
|
|
31
|
+
- **WSL**: If you are using Windows and experience slow HMR, you may want to try using [WSL (Windows Subsystem for Linux)](https://learn.microsoft.com/en-us/windows/wsl/install) which may solve some performance issues.
|
|
32
|
+
- **Windows slow DNS resolution**: Instead of using `localhost:3000` for local dev server on Windows, use `127.0.0.1` for much faster loading experience on browsers.
|
|
35
33
|
::
|
|
36
34
|
::
|
|
37
35
|
|
|
38
|
-
Open a terminal (if you're using [Visual Studio Code](https://code.visualstudio.com), you can open an [integrated terminal](https://code.visualstudio.com/docs/
|
|
36
|
+
Open a terminal (if you're using [Visual Studio Code](https://code.visualstudio.com), you can open an [integrated terminal](https://code.visualstudio.com/docs/terminal/basics)) and use the following command to create a new starter project:
|
|
39
37
|
|
|
40
38
|
::code-group{sync="pm"}
|
|
41
39
|
|
|
@@ -44,7 +42,7 @@ npm create nuxt@latest <project-name>
|
|
|
44
42
|
```
|
|
45
43
|
|
|
46
44
|
```bash [yarn]
|
|
47
|
-
yarn create nuxt
|
|
45
|
+
yarn create nuxt <project-name>
|
|
48
46
|
```
|
|
49
47
|
|
|
50
48
|
```bash [pnpm]
|
|
@@ -4,11 +4,11 @@ description: Nuxt is configured with sensible defaults to make you productive.
|
|
|
4
4
|
navigation.icon: i-lucide-cog
|
|
5
5
|
---
|
|
6
6
|
|
|
7
|
-
By default, Nuxt is configured to cover most use cases. The [`nuxt.config.ts`](/docs/4.x/
|
|
7
|
+
By default, Nuxt is configured to cover most use cases. The [`nuxt.config.ts`](/docs/4.x/directory-structure/nuxt-config) file can override or extend this default configuration.
|
|
8
8
|
|
|
9
9
|
## Nuxt Configuration
|
|
10
10
|
|
|
11
|
-
The [`nuxt.config.ts`](/docs/4.x/
|
|
11
|
+
The [`nuxt.config.ts`](/docs/4.x/directory-structure/nuxt-config) file is located at the root of a Nuxt project and can override or extend the application's behavior.
|
|
12
12
|
|
|
13
13
|
A minimal configuration file exports the `defineNuxtConfig` function containing an object with your configuration. The `defineNuxtConfig` helper is globally available without import.
|
|
14
14
|
|
|
@@ -124,7 +124,7 @@ const appConfig = useAppConfig()
|
|
|
124
124
|
</script>
|
|
125
125
|
```
|
|
126
126
|
|
|
127
|
-
:read-more{to="/docs/4.x/
|
|
127
|
+
:read-more{to="/docs/4.x/directory-structure/app/app-config"}
|
|
128
128
|
|
|
129
129
|
## `runtimeConfig` vs. `app.config`
|
|
130
130
|
|
|
@@ -133,37 +133,37 @@ As stated above, `runtimeConfig` and `app.config` are both used to expose variab
|
|
|
133
133
|
- `runtimeConfig`: Private or public tokens that need to be specified after build using environment variables.
|
|
134
134
|
- `app.config`: Public tokens that are determined at build time, website configuration such as theme variant, title and any project config that are not sensitive.
|
|
135
135
|
|
|
136
|
-
Feature
|
|
137
|
-
|
|
138
|
-
Client
|
|
139
|
-
Environment
|
|
140
|
-
Reactive
|
|
141
|
-
Types support
|
|
142
|
-
Configuration per
|
|
143
|
-
Hot
|
|
144
|
-
Non
|
|
136
|
+
| Feature | `runtimeConfig` | `app.config` |
|
|
137
|
+
|---------------------------|-----------------|--------------|
|
|
138
|
+
| Client-side | Hydrated | Bundled |
|
|
139
|
+
| Environment variables | ✅ Yes | ❌ No |
|
|
140
|
+
| Reactive | ✅ Yes | ✅ Yes |
|
|
141
|
+
| Types support | ✅ Partial | ✅ Yes |
|
|
142
|
+
| Configuration per request | ❌ No | ✅ Yes |
|
|
143
|
+
| Hot module replacement | ❌ No | ✅ Yes |
|
|
144
|
+
| Non-primitive JS types | ❌ No | ✅ Yes |
|
|
145
145
|
|
|
146
146
|
## External Configuration Files
|
|
147
147
|
|
|
148
|
-
Nuxt uses [`nuxt.config.ts`](/docs/4.x/
|
|
148
|
+
Nuxt uses [`nuxt.config.ts`](/docs/4.x/directory-structure/nuxt-config) file as the single source of truth for configurations and skips reading external configuration files. During the course of building your project, you may have a need to configure those. The following table highlights common configurations and, where applicable, how they can be configured with Nuxt.
|
|
149
149
|
|
|
150
|
-
Name
|
|
151
|
-
|
|
152
|
-
[Nitro](https://nitro.build)
|
|
153
|
-
[PostCSS](https://postcss.org)
|
|
154
|
-
[Vite](https://vite.dev)
|
|
155
|
-
[webpack](https://webpack.js.org)
|
|
150
|
+
| Name | Config File | How To Configure |
|
|
151
|
+
|-----------------------------------|-------------------------|---------------------------------------------------------------------------|
|
|
152
|
+
| [Nitro](https://nitro.build) | ~~`nitro.config.ts`~~ | Use [`nitro`](/docs/4.x/api/nuxt-config#nitro) key in `nuxt.config` |
|
|
153
|
+
| [PostCSS](https://postcss.org) | ~~`postcss.config.js`~~ | Use [`postcss`](/docs/4.x/api/nuxt-config#postcss) key in `nuxt.config` |
|
|
154
|
+
| [Vite](https://vite.dev) | ~~`vite.config.ts`~~ | Use [`vite`](/docs/4.x/api/nuxt-config#vite) key in `nuxt.config` |
|
|
155
|
+
| [webpack](https://webpack.js.org) | ~~`webpack.config.ts`~~ | Use [`webpack`](/docs/4.x/api/nuxt-config#webpack-1) key in `nuxt.config` |
|
|
156
156
|
|
|
157
157
|
Here is a list of other common config files:
|
|
158
158
|
|
|
159
|
-
Name | Config File
|
|
160
|
-
|
|
161
|
-
[TypeScript](https://www.typescriptlang.org) | `tsconfig.json`
|
|
162
|
-
[ESLint](https://eslint.org) | `eslint.config.js`
|
|
163
|
-
[Prettier](https://prettier.io) | `prettier.config.js`
|
|
164
|
-
[Stylelint](https://stylelint.io) | `stylelint.config.js`
|
|
165
|
-
[TailwindCSS](https://tailwindcss.com) | `tailwind.config.js`
|
|
166
|
-
[Vitest](https://vitest.dev) | `vitest.config.ts`
|
|
159
|
+
| Name | Config File | How To Configure |
|
|
160
|
+
|----------------------------------------------|-----------------------|-------------------------------------------------------------------------------|
|
|
161
|
+
| [TypeScript](https://www.typescriptlang.org) | `tsconfig.json` | [More Info](/docs/4.x/directory-structure/tsconfig) |
|
|
162
|
+
| [ESLint](https://eslint.org) | `eslint.config.js` | [More Info](https://eslint.org/docs/latest/use/configure/configuration-files) |
|
|
163
|
+
| [Prettier](https://prettier.io) | `prettier.config.js` | [More Info](https://prettier.io/docs/configuration.html) |
|
|
164
|
+
| [Stylelint](https://stylelint.io) | `stylelint.config.js` | [More Info](https://stylelint.io/user-guide/configure/) |
|
|
165
|
+
| [TailwindCSS](https://tailwindcss.com) | `tailwind.config.js` | [More Info](https://tailwindcss.nuxtjs.org/tailwindcss/configuration/) |
|
|
166
|
+
| [Vitest](https://vitest.dev) | `vitest.config.ts` | [More Info](https://vitest.dev/config/) |
|
|
167
167
|
|
|
168
168
|
## Vue Configuration
|
|
169
169
|
|
|
@@ -26,7 +26,7 @@ If you are familiar with Vue, you might wonder where `main.js` is (the file that
|
|
|
26
26
|
|
|
27
27
|

|
|
28
28
|
|
|
29
|
-
Most components are reusable pieces of the user interface, like buttons and menus. In Nuxt, you can create these components in the [`app/components/`](/docs/4.x/
|
|
29
|
+
Most components are reusable pieces of the user interface, like buttons and menus. In Nuxt, you can create these components in the [`app/components/`](/docs/4.x/directory-structure/app/components) directory, and they will be automatically available across your application without having to explicitly import them.
|
|
30
30
|
|
|
31
31
|
::code-group
|
|
32
32
|
|
|
@@ -55,9 +55,9 @@ Most components are reusable pieces of the user interface, like buttons and menu
|
|
|
55
55
|
|
|
56
56
|

|
|
57
57
|
|
|
58
|
-
Pages represent views for each specific route pattern. Every file in the [`app/pages/`](/docs/4.x/
|
|
58
|
+
Pages represent views for each specific route pattern. Every file in the [`app/pages/`](/docs/4.x/directory-structure/app/pages) directory represents a different route displaying its content.
|
|
59
59
|
|
|
60
|
-
To use pages, create an `app/pages/index.vue` file and add `<NuxtPage />` component to the [`app/app.vue`](/docs/4.x/
|
|
60
|
+
To use pages, create an `app/pages/index.vue` file and add `<NuxtPage />` component to the [`app/app.vue`](/docs/4.x/directory-structure/app/app) (or remove `app/app.vue` for default entry). You can now create more pages and their corresponding routes by adding new files in the [`app/pages/`](/docs/4.x/directory-structure/app/pages) directory.
|
|
61
61
|
|
|
62
62
|
::code-group
|
|
63
63
|
|
|
@@ -91,7 +91,7 @@ To use pages, create an `app/pages/index.vue` file and add `<NuxtPage />` compon
|
|
|
91
91
|
Layouts are wrappers around pages that contain a common User Interface for several pages, such as header and footer displays. Layouts are Vue files using `<slot />` components to display the **page** content. The `app/layouts/default.vue` file will be used by default. Custom layouts can be set as part of your page metadata.
|
|
92
92
|
|
|
93
93
|
::note
|
|
94
|
-
If you only have a single layout in your application, we recommend using [`app/app.vue`](/docs/4.x/
|
|
94
|
+
If you only have a single layout in your application, we recommend using [`app/app.vue`](/docs/4.x/directory-structure/app/app) with [`<NuxtPage />`](/docs/4.x/api/components/nuxt-page) instead.
|
|
95
95
|
::
|
|
96
96
|
|
|
97
97
|
::code-group
|
|
@@ -137,7 +137,7 @@ If you only have a single layout in your application, we recommend using [`app/a
|
|
|
137
137
|
|
|
138
138
|
::
|
|
139
139
|
|
|
140
|
-
If you want to create more layouts and learn how to use them in your pages, find more information in the [Layouts section](/docs/4.x/
|
|
140
|
+
If you want to create more layouts and learn how to use them in your pages, find more information in the [Layouts section](/docs/4.x/directory-structure/app/layouts).
|
|
141
141
|
|
|
142
142
|
## Advanced: Extending the HTML Template
|
|
143
143
|
|
|
@@ -6,14 +6,14 @@ navigation.icon: i-lucide-image
|
|
|
6
6
|
|
|
7
7
|
Nuxt uses two directories to handle assets like stylesheets, fonts or images.
|
|
8
8
|
|
|
9
|
-
- The [`public/`](/docs/4.x/
|
|
10
|
-
- The [`app/assets/`](/docs/4.x/
|
|
9
|
+
- The [`public/`](/docs/4.x/directory-structure/public) directory content is served at the server root as-is.
|
|
10
|
+
- The [`app/assets/`](/docs/4.x/directory-structure/app/assets) directory contains by convention every asset that you want the build tool (Vite or webpack) to process.
|
|
11
11
|
|
|
12
12
|
## Public Directory
|
|
13
13
|
|
|
14
|
-
The [`public/`](/docs/4.x/
|
|
14
|
+
The [`public/`](/docs/4.x/directory-structure/public) directory is used as a public server for static assets publicly available at a defined URL of your application.
|
|
15
15
|
|
|
16
|
-
You can get a file in the [`public/`](/docs/4.x/
|
|
16
|
+
You can get a file in the [`public/`](/docs/4.x/directory-structure/public) directory from your application's code or from a browser by the root URL `/`.
|
|
17
17
|
|
|
18
18
|
### Example
|
|
19
19
|
|
|
@@ -30,11 +30,11 @@ For example, referencing an image file in the `public/img/` directory, available
|
|
|
30
30
|
|
|
31
31
|
## Assets Directory
|
|
32
32
|
|
|
33
|
-
Nuxt uses [Vite](https://vite.dev/guide/assets
|
|
33
|
+
Nuxt uses [Vite](https://vite.dev/guide/assets) (default) or [webpack](https://webpack.js.org/guides/asset-management/) to build and bundle your application. The main function of these build tools is to process JavaScript files, but they can be extended through [plugins](https://vite.dev/plugins/) (for Vite) or [loaders](https://webpack.js.org/loaders/) (for webpack) to process other kinds of assets, like stylesheets, fonts or SVGs. This step transforms the original file, mainly for performance or caching purposes (such as stylesheet minification or browser cache invalidation).
|
|
34
34
|
|
|
35
|
-
By convention, Nuxt uses the [`app/assets/`](/docs/4.x/
|
|
35
|
+
By convention, Nuxt uses the [`app/assets/`](/docs/4.x/directory-structure/app/assets) directory to store these files but there is no auto-scan functionality for this directory, and you can use any other name for it.
|
|
36
36
|
|
|
37
|
-
In your application's code, you can reference a file located in the [`app/assets/`](/docs/4.x/
|
|
37
|
+
In your application's code, you can reference a file located in the [`app/assets/`](/docs/4.x/directory-structure/app/assets) directory by using the `~/assets/` path.
|
|
38
38
|
|
|
39
39
|
### Example
|
|
40
40
|
|
|
@@ -50,5 +50,5 @@ For example, referencing an image file that will be processed if a build tool is
|
|
|
50
50
|
```
|
|
51
51
|
|
|
52
52
|
::note
|
|
53
|
-
Nuxt won't serve files in the [`app/assets/`](/docs/4.x/
|
|
53
|
+
Nuxt won't serve files in the [`app/assets/`](/docs/4.x/directory-structure/app/assets) directory at a static URL like `/assets/my-file.png`. If you need a static URL, use the [`public/`](/docs/4.x/getting-started/assets#public-directory) directory.
|
|
54
54
|
::
|
|
@@ -9,12 +9,12 @@ You can use CSS preprocessors, CSS frameworks, UI libraries and Nuxt modules to
|
|
|
9
9
|
|
|
10
10
|
## Local Stylesheets
|
|
11
11
|
|
|
12
|
-
If you're writing local stylesheets, the natural place to put them is the [`app/assets/` directory](/docs/4.x/
|
|
12
|
+
If you're writing local stylesheets, the natural place to put them is the [`app/assets/` directory](/docs/4.x/directory-structure/app/assets).
|
|
13
13
|
|
|
14
14
|
### Importing Within Components
|
|
15
15
|
|
|
16
16
|
You can import stylesheets in your pages, layouts and components directly.
|
|
17
|
-
You can use a JavaScript import, or a CSS [`@import` statement](https://developer.mozilla.org/en-US/docs/Web/CSS/@import).
|
|
17
|
+
You can use a JavaScript import, or a CSS [`@import` statement](https://developer.mozilla.org/en-US/docs/Web/CSS/Reference/At-rules/@import).
|
|
18
18
|
|
|
19
19
|
```vue [app/pages/index.vue]
|
|
20
20
|
<script>
|
|
@@ -37,7 +37,7 @@ The stylesheets will be inlined in the HTML rendered by Nuxt.
|
|
|
37
37
|
### The CSS Property
|
|
38
38
|
|
|
39
39
|
You can also use the `css` property in the Nuxt configuration.
|
|
40
|
-
The natural place for your stylesheets is the [`app/assets/` directory](/docs/4.x/
|
|
40
|
+
The natural place for your stylesheets is the [`app/assets/` directory](/docs/4.x/directory-structure/app/assets). You can then reference its path and Nuxt will include it to all the pages of your application.
|
|
41
41
|
|
|
42
42
|
```ts [nuxt.config.ts]
|
|
43
43
|
export default defineNuxtConfig({
|
|
@@ -95,6 +95,10 @@ pnpm install animate.css
|
|
|
95
95
|
bun install animate.css
|
|
96
96
|
```
|
|
97
97
|
|
|
98
|
+
```bash [deno]
|
|
99
|
+
deno install npm:animate.css
|
|
100
|
+
```
|
|
101
|
+
|
|
98
102
|
::
|
|
99
103
|
|
|
100
104
|
Then you can reference it directly in your pages, layouts and components:
|
|
@@ -151,7 +155,7 @@ Nuxt uses `unhead` under the hood, and you can refer to [its full documentation]
|
|
|
151
155
|
|
|
152
156
|
If you need more advanced control, you can intercept the rendered html with a hook and modify the head programmatically.
|
|
153
157
|
|
|
154
|
-
Create a plugin in
|
|
158
|
+
Create a plugin in `~~/server/plugins/my-plugin.ts` like this:
|
|
155
159
|
|
|
156
160
|
<!-- TODO: figure out how to use twoslash to inject types for a different context -->
|
|
157
161
|
|
|
@@ -163,7 +167,7 @@ export default defineNitroPlugin((nitro) => {
|
|
|
163
167
|
})
|
|
164
168
|
```
|
|
165
169
|
|
|
166
|
-
External stylesheets are render-blocking resources: they must be loaded and processed before the browser renders the page. Web pages that contain unnecessarily large styles take longer to render. You can read more about it on [web.dev](https://web.dev/defer-non-critical-css).
|
|
170
|
+
External stylesheets are render-blocking resources: they must be loaded and processed before the browser renders the page. Web pages that contain unnecessarily large styles take longer to render. You can read more about it on [web.dev](https://web.dev/articles/defer-non-critical-css).
|
|
167
171
|
|
|
168
172
|
## Using Preprocessors
|
|
169
173
|
|
|
@@ -206,7 +210,7 @@ export default defineNuxtConfig({
|
|
|
206
210
|
In both cases, the compiled stylesheets will be inlined in the HTML rendered by Nuxt.
|
|
207
211
|
::
|
|
208
212
|
|
|
209
|
-
If you need to inject code in pre-processed files, like a [Sass partial](https://sass-lang.com/documentation/at-rules/use
|
|
213
|
+
If you need to inject code in pre-processed files, like a [Sass partial](https://sass-lang.com/documentation/at-rules/use/#partials) with color variables, you can do so with the Vite [preprocessors options](https://vite.dev/config/shared-options#css-preprocessoroptions).
|
|
210
214
|
|
|
211
215
|
Create some partials in your `app/assets` directory:
|
|
212
216
|
|
|
@@ -258,11 +262,11 @@ export default defineNuxtConfig({
|
|
|
258
262
|
|
|
259
263
|
::
|
|
260
264
|
|
|
261
|
-
Nuxt uses Vite by default. If you wish to use webpack instead, refer to each preprocessor loader [documentation](https://webpack.js.org/loaders/sass-loader).
|
|
265
|
+
Nuxt uses Vite by default. If you wish to use webpack instead, refer to each preprocessor loader [documentation](https://webpack.js.org/loaders/sass-loader/).
|
|
262
266
|
|
|
263
267
|
### Preprocessor Workers (Experimental)
|
|
264
268
|
|
|
265
|
-
Vite has made available an [experimental option](https://vite.dev/config/shared-options
|
|
269
|
+
Vite has made available an [experimental option](https://vite.dev/config/shared-options#css-preprocessormaxworkers) which can speed up using preprocessors.
|
|
266
270
|
|
|
267
271
|
You can enable this in your `nuxt.config`:
|
|
268
272
|
|
|
@@ -284,7 +288,7 @@ This is an experimental option and you should refer to the Vite documentation an
|
|
|
284
288
|
|
|
285
289
|
One of the best things about Vue and SFC is how great it is at naturally dealing with styling. You can directly write CSS or preprocessor code in the style block of your components file, therefore you will have fantastic developer experience without having to use something like CSS-in-JS. However if you wish to use CSS-in-JS, you can find 3rd party libraries and modules that support it, such as [pinceau](https://github.com/Tahul/pinceau).
|
|
286
290
|
|
|
287
|
-
You can refer to the [Vue docs](https://vuejs.org/api/sfc-css-features
|
|
291
|
+
You can refer to the [Vue docs](https://vuejs.org/api/sfc-css-features) for a comprehensive reference about styling components in SFC.
|
|
288
292
|
|
|
289
293
|
### Class And Style Bindings
|
|
290
294
|
|
|
@@ -354,7 +358,7 @@ const styleObject = reactive({ color: 'red', fontSize: '13px' })
|
|
|
354
358
|
|
|
355
359
|
::
|
|
356
360
|
|
|
357
|
-
Refer to the [Vue docs](https://vuejs.org/guide/essentials/class-and-style
|
|
361
|
+
Refer to the [Vue docs](https://vuejs.org/guide/essentials/class-and-style) for more information.
|
|
358
362
|
|
|
359
363
|
### Dynamic Styles With `v-bind`
|
|
360
364
|
|
|
@@ -447,7 +451,7 @@ SFC style blocks support preprocessor syntax. Vite comes with built-in support f
|
|
|
447
451
|
|
|
448
452
|
::
|
|
449
453
|
|
|
450
|
-
You can refer to the [Vite CSS docs](https://vite.dev/guide/features
|
|
454
|
+
You can refer to the [Vite CSS docs](https://vite.dev/guide/features#css) and the [@vitejs/plugin-vue docs](https://github.com/vitejs/vite-plugin-vue/tree/main/packages/plugin-vue).
|
|
451
455
|
For webpack users, refer to the [vue loader docs](https://vue-loader.vuejs.org).
|
|
452
456
|
|
|
453
457
|
## Using PostCSS
|
|
@@ -478,7 +482,7 @@ By default, Nuxt comes with the following plugins already pre-configured:
|
|
|
478
482
|
- [postcss-import](https://github.com/postcss/postcss-import): Improves the `@import` rule
|
|
479
483
|
- [postcss-url](https://github.com/postcss/postcss-url): Transforms `url()` statements
|
|
480
484
|
- [autoprefixer](https://github.com/postcss/autoprefixer): Automatically adds vendor prefixes
|
|
481
|
-
- [cssnano](https://cssnano.github.io/cssnano): Minification and purge
|
|
485
|
+
- [cssnano](https://cssnano.github.io/cssnano/): Minification and purge
|
|
482
486
|
|
|
483
487
|
## Leveraging Layouts For Multiple Styles
|
|
484
488
|
|
|
@@ -500,7 +504,7 @@ Use different styles for different layouts.
|
|
|
500
504
|
</style>
|
|
501
505
|
```
|
|
502
506
|
|
|
503
|
-
:read-more{to="/docs/4.x/
|
|
507
|
+
:read-more{to="/docs/4.x/directory-structure/app/layouts"}
|
|
504
508
|
|
|
505
509
|
## Third Party Libraries And Modules
|
|
506
510
|
|
|
@@ -517,7 +521,7 @@ Here are a few modules to help you get started:
|
|
|
517
521
|
- [Nuxt UI](https://ui.nuxt.com): A UI Library for Modern Web Apps
|
|
518
522
|
- [Panda CSS](https://panda-css.com/docs/installation/nuxt): CSS-in-JS engine that generates atomic CSS at build time
|
|
519
523
|
|
|
520
|
-
Nuxt modules provide you with a good developer experience out of the box, but remember that if your favorite tool doesn't have a module, it doesn't mean that you can't use it with Nuxt! You can configure it yourself for your own project. Depending on the tool, you might need to use a [Nuxt plugin](/docs/4.x/
|
|
524
|
+
Nuxt modules provide you with a good developer experience out of the box, but remember that if your favorite tool doesn't have a module, it doesn't mean that you can't use it with Nuxt! You can configure it yourself for your own project. Depending on the tool, you might need to use a [Nuxt plugin](/docs/4.x/directory-structure/app/plugins) and/or [make your own module](/docs/4.x/guide/modules). Share them with the [community](/modules) if you do!
|
|
521
525
|
|
|
522
526
|
### Easily Load Webfonts
|
|
523
527
|
|
|
@@ -535,7 +539,7 @@ Nuxt comes with the same `<Transition>` element that Vue has, and also has suppo
|
|
|
535
539
|
|
|
536
540
|
### Font Advanced Optimization
|
|
537
541
|
|
|
538
|
-
We would recommend using [Fontaine](https://github.com/nuxt-modules/fontaine) to reduce your [CLS](https://web.dev/cls). If you need something more advanced, consider creating a Nuxt module to extend the build process or the Nuxt runtime.
|
|
542
|
+
We would recommend using [Fontaine](https://github.com/nuxt-modules/fontaine) to reduce your [CLS](https://web.dev/articles/cls). If you need something more advanced, consider creating a Nuxt module to extend the build process or the Nuxt runtime.
|
|
539
543
|
|
|
540
544
|
::tip
|
|
541
545
|
Always remember to take advantage of the various tools and techniques available in the Web ecosystem at large to make styling your application easier and more efficient. Whether you're using native CSS, a preprocessor, postcss, a UI library or a module, Nuxt has got you covered. Happy styling!
|
|
@@ -551,7 +555,7 @@ You can do the following to speed-up the download of your global CSS files:
|
|
|
551
555
|
- Host your assets on the same domain (do not use a different subdomain)
|
|
552
556
|
|
|
553
557
|
Most of these things should be done for you automatically if you're using modern platforms like Cloudflare, Netlify or Vercel.
|
|
554
|
-
You can find an LCP optimization guide on [web.dev](https://web.dev/optimize-lcp).
|
|
558
|
+
You can find an LCP optimization guide on [web.dev](https://web.dev/articles/optimize-lcp).
|
|
555
559
|
|
|
556
560
|
If all of your CSS is inlined by Nuxt, you can (experimentally) completely stop external CSS files from being referenced in your rendered HTML.
|
|
557
561
|
You can achieve that with a hook, that you can place in a module, or in your Nuxt configuration file.
|
|
@@ -4,11 +4,11 @@ description: Nuxt file-system routing creates a route for every file in the page
|
|
|
4
4
|
navigation.icon: i-lucide-milestone
|
|
5
5
|
---
|
|
6
6
|
|
|
7
|
-
One core feature of Nuxt is the file system router. Every Vue file inside the [`app/pages/`](/docs/4.x/
|
|
7
|
+
One core feature of Nuxt is the file system router. Every Vue file inside the [`app/pages/`](/docs/4.x/directory-structure/app/pages) directory creates a corresponding URL (or route) that displays the contents of the file. By using dynamic imports for each page, Nuxt leverages code-splitting to ship the minimum amount of JavaScript for the requested route.
|
|
8
8
|
|
|
9
9
|
## Pages
|
|
10
10
|
|
|
11
|
-
Nuxt routing is based on [vue-router](https://router.vuejs.org) and generates the routes from every component created in the [`app/pages/` directory](/docs/4.x/
|
|
11
|
+
Nuxt routing is based on [vue-router](https://router.vuejs.org) and generates the routes from every component created in the [`app/pages/` directory](/docs/4.x/directory-structure/app/pages), based on their filename.
|
|
12
12
|
|
|
13
13
|
This file system routing uses naming conventions to create dynamic and nested routes:
|
|
14
14
|
|
|
@@ -43,7 +43,7 @@ This file system routing uses naming conventions to create dynamic and nested ro
|
|
|
43
43
|
|
|
44
44
|
::
|
|
45
45
|
|
|
46
|
-
:read-more{to="/docs/4.x/
|
|
46
|
+
:read-more{to="/docs/4.x/directory-structure/app/pages"}
|
|
47
47
|
|
|
48
48
|
## Navigation
|
|
49
49
|
|
|
@@ -90,11 +90,15 @@ Nuxt provides a customizable route middleware framework you can use throughout y
|
|
|
90
90
|
Route middleware runs within the Vue part of your Nuxt app. Despite the similar name, they are completely different from server middleware, which are run in the Nitro server part of your app.
|
|
91
91
|
::
|
|
92
92
|
|
|
93
|
+
::important
|
|
94
|
+
Route middleware does **not** run for server routes (e.g. `/api/*`) or other server requests. To apply middleware to these requests, use [server middleware](/docs/4.x/directory-structure/server#server-middleware) instead.
|
|
95
|
+
::
|
|
96
|
+
|
|
93
97
|
There are three kinds of route middleware:
|
|
94
98
|
|
|
95
99
|
1. Anonymous (or inline) route middleware, which are defined directly in the pages where they are used.
|
|
96
|
-
2. Named route middleware, which are placed in the [`app/middleware/`](/docs/4.x/
|
|
97
|
-
3. Global route middleware, which are placed in the [`app/middleware/`](/docs/4.x/
|
|
100
|
+
2. Named route middleware, which are placed in the [`app/middleware/`](/docs/4.x/directory-structure/app/middleware) directory and will be automatically loaded via asynchronous import when used on a page. (**Note**: The route middleware name is normalized to kebab-case, so `someMiddleware` becomes `some-middleware`.)
|
|
101
|
+
3. Global route middleware, which are placed in the [`app/middleware/`](/docs/4.x/directory-structure/app/middleware) directory (with a `.global` suffix) and will be automatically run on every route change.
|
|
98
102
|
|
|
99
103
|
Example of an `auth` middleware protecting the `/dashboard` page:
|
|
100
104
|
|
|
@@ -125,13 +129,13 @@ definePageMeta({
|
|
|
125
129
|
|
|
126
130
|
::
|
|
127
131
|
|
|
128
|
-
:read-more{to="/docs/4.x/
|
|
132
|
+
:read-more{to="/docs/4.x/directory-structure/app/middleware"}
|
|
129
133
|
|
|
130
134
|
## Route Validation
|
|
131
135
|
|
|
132
136
|
Nuxt offers route validation via the `validate` property in [`definePageMeta()`](/docs/4.x/api/utils/define-page-meta) in each page you wish to validate.
|
|
133
137
|
|
|
134
|
-
The `validate` property accepts the `route` as an argument. You can return a boolean value to determine whether or not this is a valid route to be rendered with this page. If you return `false`, this will cause a 404 error. You can also directly return an object with `
|
|
138
|
+
The `validate` property accepts the `route` as an argument. You can return a boolean value to determine whether or not this is a valid route to be rendered with this page. If you return `false`, this will cause a 404 error. You can also directly return an object with `status`/`statusText` to customize the error returned.
|
|
135
139
|
|
|
136
140
|
If you have a more complex use case, then you can use anonymous route middleware instead.
|
|
137
141
|
|
|
@@ -9,7 +9,7 @@ and numerous configuration options to manage your app's head and SEO meta tags.
|
|
|
9
9
|
|
|
10
10
|
## Nuxt Config
|
|
11
11
|
|
|
12
|
-
Providing an [`app.head`](/docs/4.x/api/nuxt-config#head) property in your [`nuxt.config.ts`](/docs/4.x/
|
|
12
|
+
Providing an [`app.head`](/docs/4.x/api/nuxt-config#head) property in your [`nuxt.config.ts`](/docs/4.x/directory-structure/nuxt-config) allows you to statically customize the head for your entire app.
|
|
13
13
|
|
|
14
14
|
::important
|
|
15
15
|
This method does not allow you to provide reactive data. We recommend using `useHead()` in `app.vue`.
|
|
@@ -134,6 +134,10 @@ const title = ref('Hello World')
|
|
|
134
134
|
|
|
135
135
|
It's suggested to wrap your components in either a `<Head>` or `<Html>` components as tags will be deduped more intuitively.
|
|
136
136
|
|
|
137
|
+
::warning
|
|
138
|
+
If you need to duplicate tags across client-server boundaries, apply a `key` attribute on the `<Head>` component.
|
|
139
|
+
::
|
|
140
|
+
|
|
137
141
|
## Types
|
|
138
142
|
|
|
139
143
|
Below are the non-reactive types used for [`useHead`](/docs/4.x/api/composables/use-head), [`app.head`](/docs/4.x/api/nuxt-config#head) and components.
|
|
@@ -273,7 +277,7 @@ useHead({
|
|
|
273
277
|
|
|
274
278
|
### With `definePageMeta`
|
|
275
279
|
|
|
276
|
-
Within your [`app/pages/` directory](/docs/4.x/
|
|
280
|
+
Within your [`app/pages/` directory](/docs/4.x/directory-structure/app/pages), you can use `definePageMeta` along with [`useHead`](/docs/4.x/api/composables/use-head) to set metadata based on the current route.
|
|
277
281
|
|
|
278
282
|
For example, you can first set the current page title (this is extracted at build time via a macro, so it can't be set dynamically):
|
|
279
283
|
|
|
@@ -299,7 +303,7 @@ useHead({
|
|
|
299
303
|
|
|
300
304
|
:link-example{to="/docs/4.x/examples/features/meta-tags"}
|
|
301
305
|
|
|
302
|
-
:read-more{to="/docs/4.x/
|
|
306
|
+
:read-more{to="/docs/4.x/directory-structure/app/pages/#page-metadata"}
|
|
303
307
|
|
|
304
308
|
### Dynamic Title
|
|
305
309
|
|