<ClientOnly>

源码
使用 <ClientOnly> 组件仅在客户端渲染组件。

<ClientOnly> 组件用于有目的地仅在客户端渲染组件。

默认插槽的内容将从服务器构建中被 tree-shake 移除。(这意味着其中组件使用的任何 CSS 可能不会在渲染初始 HTML 时被内联。)

Props

  • placeholderTag | fallbackTag: 指定在服务器端渲染的标签。
  • placeholder | fallback: 指定在服务器端渲染的内容。
<template>
  <div>
    <Sidebar />
    <!-- <Comment> 组件将仅在客户端渲染 -->
    <ClientOnly
      fallback-tag="span"
      fallback="加载评论中..."
    >
      <Comment />
    </ClientOnly>
  </div>
</template>

Slots

  • #fallback: 指定在服务器端渲染并显示的内容,直到 <ClientOnly> 在浏览器中挂载。
app/pages/example.vue
<template>
  <div>
    <Sidebar />
    <!-- 这将在服务器端渲染 "span" 元素 -->
    <ClientOnly fallback-tag="span">
      <!-- 此组件将仅在客户端渲染 -->
      <Comments />
      <template #fallback>
        <!-- 这将在服务器端渲染 -->
        <p>加载评论中...</p>
      </template>
    </ClientOnly>
  </div>
</template>

示例

访问 HTML 元素

<ClientOnly> 内部的组件仅在挂载后渲染。要访问 DOM 中的渲染元素,您可以监听模板 ref:

app/pages/example.vue
<script setup lang="ts">
const nuxtWelcomeRef = useTemplateRef('nuxtWelcomeRef')

// 当组件可用时,watch 会被触发
watch(nuxtWelcomeRef, () => {
  console.log('<NuxtWelcome /> 已挂载')
}, { once: true })
</script>

<template>
  <ClientOnly>
    <NuxtWelcome ref="nuxtWelcomeRef" />
  </ClientOnly>
</template>