v3.17
GitHub

<ClientOnly>

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

<ClientOnly> 组件用于有意只在客户端渲染一个组件。

默认插槽的内容将被从服务器构建中树摇掉。（这确实意味着其中的组件使用的任何 CSS 可能在渲染初始 HTML 时没有内联。）

属性

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

插槽

  • #fallback：指定一个将在服务器上渲染并在 <ClientOnly> 在浏览器中挂载之前显示的内容。
pages/example.vue
<template>
  <div>
    <Sidebar />
    <!-- 这将在服务器端渲染 "span" 元素 -->
    <ClientOnly fallbackTag="span">
      <!-- 这个组件将仅在客户端渲染 -->
      <Comments />
      <template #fallback>
        <!-- 这将在服务器端渲染 -->
        <p>正在加载评论...</p>
      </template>
    </ClientOnly>
  </div>
</template>

示例

访问 HTML 元素

<ClientOnly> 内的组件只有在挂载后才会渲染。要访问 DOM 中渲染的元素，可以观察一个模板引用：

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

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

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