This repository has been archived by the owner on Apr 6, 2023. It is now read-only.
docs(api): add <ClientOnly> to API docs
#8400
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| --- | ||
| description: The <ClientOnly> component renders its slot only in client-side. | ||
| --- | ||
| # `<ClientOnly>` | ||
|
|
||
| The `<ClientOnly>` component renders its slot only in client-side. To import a component only on the client, register the component in a client-side only plugin. | ||
|
|
||
| ## Props | ||
|
|
||
| - **placeholderTag** | **fallbackTag**: specify a tag to be rendered server-side. | ||
|
There was a problem hiding this comment. i'll fix this :) thanks ! |
||
| - **placeholder** | **fallback**: specify a content to be rendered server-side. | ||
|
|
||
| ```vue | ||
| <template> | ||
| <div> | ||
| <Sidebar /> | ||
| <ClientOnly fallback-tag="span" fallback="Loading comments..."> | ||
| <Comment /> | ||
| </ClientOnly> | ||
| </div> | ||
| </template> | ||
| ``` | ||
|
|
||
| ## Slots | ||
|
|
||
| - **#fallback**: specify a content to be displayed server-side. | ||
|
|
||
| ```vue | ||
| <template> | ||
| <div> | ||
| <Sidebar /> | ||
| <ClientOnly> | ||
| <!-- ... --> | ||
| <template #fallback> | ||
| <!-- this will be rendered on server side --> | ||
| <p>Loading comments...</p> | ||
| </template> | ||
| </ClientOnly> | ||
| </div> | ||
| </template> | ||
| ``` | ||
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(there seems a type at end of the sentence)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
which one ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Instead of the plugin, I assume you meant "within the component". (Alternative to
.clientcomponents)There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this was retrieved from the guide docs.
Maybe changing to
To import a component only on the client, add the .client suffix to the component file name or import it explicitly within the component.might be better ?