<ClientOnly>

Render components only in client-side with the <ClientOnly> component.

The <ClientOnly> component is used for purposely rendering a component only on client side.

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 · string

Specify a tag to be rendered server-side. Alias: fallbackTag

fallbackTag · string

Specify a tag to be rendered server-side. Alias: placeholderTag

placeholder · string

Specify a content to be rendered server-side. Alias: fallback

fallback · string

Specify a content to be rendered server-side. Alias: placeholder

Usage

<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.

[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:

[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>