docs(api): add `<ClientOnly>` to API docs (#8400)

This commit is contained in:
Julien Huang 2022-10-22 00:47:13 +02:00 committed by GitHub
parent b9d83b3cd1
commit 02227a2f1b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 41 additions and 0 deletions

View File

@ -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.
- **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>
```