gil
5f664546cf
- CLAUDE.md 운영 규칙 - wiki/ 정리된 지식 페이지 (Nuxt + Claude Code) - raw/ 원본 자료 - reference/ Nuxt 4.x 공식 문서 Co-authored-by: Cursor <cursoragent@cursor.com>
80 lines
2.1 KiB
Markdown
80 lines
2.1 KiB
Markdown
---
|
|
title: '<ClientOnly>'
|
|
description: Render components only in client-side with the <ClientOnly> component.
|
|
links:
|
|
- label: Source
|
|
icon: i-simple-icons-github
|
|
to: https://github.com/nuxt/nuxt/blob/main/packages/nuxt/src/app/components/client-only.ts
|
|
size: xs
|
|
---
|
|
|
|
The `<ClientOnly>` component is used for purposely rendering a component only on client side.
|
|
|
|
::note
|
|
The content of the default slot will be tree-shaken out of the server build. (This does mean that any CSS used by components within it may not be inlined when rendering the initial HTML.)
|
|
::
|
|
|
|
## 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 />
|
|
<!-- The <Comment> component will only be rendered on client-side -->
|
|
<ClientOnly
|
|
fallback-tag="span"
|
|
fallback="Loading comments..."
|
|
>
|
|
<Comment />
|
|
</ClientOnly>
|
|
</div>
|
|
</template>
|
|
```
|
|
|
|
## Slots
|
|
|
|
- `#fallback`: specify a content to be rendered on the server and displayed until `<ClientOnly>` is mounted in the browser.
|
|
|
|
```vue [app/pages/example.vue]
|
|
<template>
|
|
<div>
|
|
<Sidebar />
|
|
<!-- This renders the "span" element on the server side -->
|
|
<ClientOnly fallback-tag="span">
|
|
<!-- this component will only be rendered on client side -->
|
|
<Comments />
|
|
<template #fallback>
|
|
<!-- this will be rendered on server side -->
|
|
<p>Loading comments...</p>
|
|
</template>
|
|
</ClientOnly>
|
|
</div>
|
|
</template>
|
|
```
|
|
|
|
## Examples
|
|
|
|
### Accessing HTML Elements
|
|
|
|
Components inside `<ClientOnly>` are rendered only after being mounted. To access the rendered elements in the DOM, you can watch a template ref:
|
|
|
|
```vue [app/pages/example.vue]
|
|
<script setup lang="ts">
|
|
const nuxtWelcomeRef = useTemplateRef('nuxtWelcomeRef')
|
|
|
|
// The watch will be triggered when the component is available
|
|
watch(nuxtWelcomeRef, () => {
|
|
console.log('<NuxtWelcome /> mounted')
|
|
}, { once: true })
|
|
</script>
|
|
|
|
<template>
|
|
<ClientOnly>
|
|
<NuxtWelcome ref="nuxtWelcomeRef" />
|
|
</ClientOnly>
|
|
</template>
|
|
```
|