<ClientOnly>

ソース
<ClientOnly> コンポーネントを使用すると、コンポーネントをクライアントサイドでのみレンダリングできます。

<ClientOnly> コンポーネントは、意図的にコンポーネントをクライアントサイドでのみレンダリングするために使用されます。

デフォルトスロットのコンテンツは、サーバービルドからツリーシェイクされます。（これは、その内部のコンポーネントで使用されているCSSが、初期HTMLをレンダリングする際にインライン化されない可能性があることを意味します。）

プロップス

  • placeholderTag | fallbackTag: サーバーサイドでレンダリングするタグを指定します。
  • placeholder | fallback: サーバーサイドでレンダリングするコンテンツを指定します。
<template>
  <div>
    <Sidebar />
    <!-- The <Comment> component will only be rendered on client-side -->
    <ClientOnly
      fallback-tag="span"
      fallback="Loading comments..."
    >
      <Comment />
    </ClientOnly>
  </div>
</template>

スロット

  • #fallback: サーバーでレンダリングされ、ブラウザで<ClientOnly>がマウントされるまで表示されるコンテンツを指定します。
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>

例

HTML要素へのアクセス

<ClientOnly> 内のコンポーネントは、マウントされた後にのみレンダリングされます。DOMでレンダリングされた要素にアクセスするには、テンプレート参照を監視できます。

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>