Skip to content
This repository has been archived by the owner on Apr 6, 2023. It is now read-only.

Commit

Permalink
docs(api): add <ClientOnly> to API docs (#8400)
Browse files Browse the repository at this point in the history
  • Loading branch information
huang-julien committed Oct 21, 2022
1 parent b9d83b3 commit 02227a2
Show file tree
Hide file tree
Showing 7 changed files with 41 additions and 0 deletions.
41 changes: 41 additions & 0 deletions docs/content/3.api/2.components/1.client-only.md
@@ -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>
```

0 comments on commit 02227a2

Please sign in to comment.