8000 docs: document `NuxtIsland` by huang-julien · Pull Request #22434 · nuxt/nuxt · GitHub
[go: up one dir, main page]
Skip to content

docs: document NuxtIsland #22434

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

Merged
merged 3 commits into from
Aug 2, 2023
Merged

docs: document NuxtIsland #22434

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
af840eb
docs: document `NuxtIsland`
huang-julien Aug 1, 2023
234a2c8
doc: add new info block
huang-julien Aug 1, 2023
1f9b8ee
docs: small tweaks
danielroe Aug 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 50 additions & 0 deletions docs/3.api/2.components/8.nuxt-island.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
title: "<NuxtIsland>"
description: "Nuxt provides `<NuxtIsland>` component to render a non-interactive component without any client JS"
---

# `<NuxtIsland>`

Nuxt provide `<NuxtIsland>` to render components only server side.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Nuxt provide `<NuxtIsland>` to render components only server side.
Nuxt provides `<NuxtIsland>` to render components only server side.


When rendering an island component, the content of the island component is static, thus no JS is downloaded client-side.
Changing the island component props triggers a refetch of the island component to re-render it again.

::alert{type=warning}
This component is experimental and in order to use it you must enable the `experimental.componentsIsland` option in your `nuxt.config`.
::

::alert{type=info}
Global styles of your application are sent with the response
::

::alert{type=info}
Server only components use `<NuxtIsland>` under the hood
::

## Props

- **name** : Name of the component to render.
- **type**: `string`
- **required**
- **lazy**: Make the component non-blocking.
- **type**: `boolean`
- **default**: `false`
- **props**: Props to send to the component to render.
- **type**: `Record<string, any>`
- **source**: Remote source to call the island to render.
- **type**: `string`

::alert{type=warning}
Remote islands need `experimental.componentsIsland` to be `'local+remote'` in your `nuxt.config`.
::

## `Slots`

Slots can be passed to an island component if declared.

Every slot is interactive since the parent component is the one providing it.

Some slots are reserved to `NuxtIsland` for special cases.

- **fallback**: Specify the content to be rendered before the island loads (if the component is lazy) or if `NuxtIsland` fails to fetch the component.
0 docs/3.api/2.components/8.teleports.md → docs/3.api/2.components/9.teleports.md
View file
Open in desktop
File renamed without changes.
0