Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: warn about single root element for island components. #26462

Merged
merged 4 commits into from
Mar 25, 2024
Merged

docs: warn about single root element for island components. #26462

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5cf9e73
docs: warn about single root element for island components.
huang-julien Mar 23, 2024
d61d55e
docs: update location/wording
danielroe Mar 25, 2024
db50c56
Merge remote-tracking branch 'origin/main' into doc/singlerouteelement
danielroe Mar 25, 2024
f002d27
docs: mention comments
danielroe Mar 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/2.guide/2.directory-structure/1.components.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -299,6 +299,10 @@ Now you can register server-only components with the `.server` suffix and use th

Server-only components use [`<NuxtIsland>`](/docs/api/components/nuxt-island) under the hood, meaning that `lazy` prop and `#fallback` slot are both passed down to it.

::alert{type=warning}
Server components (and islands) must have a single root element. (HTML comments are considered elements as well.)
::

::alert{type=warning}
Most features for server-only components and island components, such as slots and client components, are only available for single file components.
::
Expand Down
6 changes: 5 additions & 1 deletion docs/2.guide/2.directory-structure/1.pages.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ If you are using [`app.vue`](/docs/guide/directory-structure/app), make sure to
</template>
```

Pages **must have a single root element** to allow [route transitions](/docs/getting-started/transitions) between pages, HTML comments are considered elements as well.
Pages **must have a single root element** to allow [route transitions](/docs/getting-started/transitions) between pages. HTML comments are considered elements as well.

This means that when the route is server-rendered, or statically generated, you will be able to see its contents correctly, but when you navigate towards that route during client-side navigation the transition between routes will fail and you'll see that the route will not be rendered.

Expand Down Expand Up @@ -365,6 +365,10 @@ You can define a page as [client only](/docs/guide/directory-structure/component

You can define a page as [server only](/docs/guide/directory-structure/components#server-components) by giving it a `.server.vue` suffix. While you will be able to navigate to the page using client-side navigation, controlled by `vue-router`, it will be rendered with a server component automatically, meaning the code required to render the page will not be in your client-side bundle.

::alert{type=warning}
Server-only pages must have a single root element. (HTML comments are considered elements as well.)
::

## Custom Routing

As your app gets bigger and more complex, your routing might require more flexibility. For this reason, Nuxt directly exposes the router, routes and router options for customization in different ways.
Expand Down