# @duannx/vue-client-only 中文文档

规范地址：https://npmcn.com/package/%40duannx/vue-client-only/

版本：1\.0\.3
npm 元数据更新时间：2022-06-21T07:15:45.354Z
中文译文更新时间：2026-11-12T23:30:55.666Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40duannx/vue-client-only
原文对照：https://npmcn.com/package/%40duannx/vue-client-only/?lang=original
项目主页：https://github.com/duannx/vue-client-only#readme
源码仓库：https://github.com/duannx/vue-client-only

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：12.3 kB，10 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=8\.0\.0
- 运行依赖：0 个
- peer 依赖：vue ^3\.x
- 首次发布：2022-06-20T03:27:17.282Z
- 最新版本发布：2022-06-21T07:15:45.279Z
- 近 30 天下载量：3559（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：4（近 12 个月 0 个）

## 中文简介

[![npm](https://img.shields.io/npm/v/vue-client-only.svg)](https://www.npmjs.com/package/vue-client-only) ![license](https://img.shields.io/github/license/duannx/vue-client-only.svg)

## 安装

```sh
npm install @duannx/vue-client-only
```

也可以使用：`pnpm add @duannx/vue-client-only`、`yarn add @duannx/vue-client-only`、`bun add @duannx/vue-client-only`

## README

# 仅限客户

[![npm](https://img.shields.io/npm/v/vue-client-only.svg)](https://www.npmjs.com/package/vue-client-only) ![license](https://img.shields.io/github/license/duannx/vue-client-only.svg)

## 什么是只有Vue客户?

此组件只帮助您在客户端生成组件 。 仅支持 Vue3

## 安装

```js
npm install --save @duannx/vue-client-only
or
yarn add @duannx/vue-client-only
```

## 使用量

```js
import ClientOnly from '@duannx/vue-client-only'

<client-only>
    <some-component></some-component>
    This will be render only in the client
    <template #placeholder>
      This is the placeholder that will be render on SSR
    </template>
</client-only>
```

### 占位符

使用 `placeholder` 用于渲染 SSR 软件的插槽

```js
<client-only>
    This will be render only in the client
    <template #placeholder>
      This is the placeholder that will be render on SSR
    </template>
</client-only>
```

### 道具

-   `is-show`:布尔. 使用此道具来准确控制组件在客户端上被提供时. 如果您不设置此道具, 组件只有在组件被挂起时才会在客户端上提供.

```js
<!-- The default slot will be shown only when isShow is set to true -->
<client-only :is-show="isShow">
    This will be render only in the client
    <template #placeholder>
      This is the placeholder that will be render on SSR
    </template>
</client-only>
```

## 何时使用此组件?

-   **当一个组件无法在服务器侧运行时**。 。 。 . **没有.** 你可以把只能在浏览器上运行的逻辑移动到挂载的钩子上. 无需使用此组件 .
-   **当面对错误时: `Hydration mismatch`。 。 。 .** **没有。 请.** 此错误由客户端中的组件状态与服务器中的状态或部分状态不匹配所引起 [不正确的 HTML 嵌入标记](https://vuejs.org/guide/scaling-up/ssr.html#hydration-mismatch). 你需要找到根源并修复它。 须寻取出根并修. 过度使用这一构成部分将消除安全部门改革的好处.
-   **想要减少服务器工作量时 .** 此组件将推迟在服务器一侧渲染组件 。 所以您的服务器会运行得更快,有更好的服务器响应时间,并减少向客户端传输的文件大小.
-   **当您想要推迟客户端组件的渲染时 .** 这个 `is-show` 道克会帮你的 几乎是时间,在页面加载时,下行内容并不有用. 这样您就可以将所有下行内容的渲染延迟到页面被加载或用户与页面交互时. 示例,此代码会将内容的渲染延迟到用户点击或滚动页面时:

```vue
<script setup>
  import ClientOnly from '@duannx/vue-client-only'
  import { onMounted } from '@vue/runtime-core'
  const isShow = ref(false)
  onMounted(() => {
    ['keydown', 'click', 'touchstart', 'scroll'].forEach((type) => {
      addEventListener(type, () => {
        isShow.value = true
      }, { once: true, capture: true });
    })
  })
</script>
<template>
Some above the fold content ...
<ClientOnly :is-show="isShow">
  <p>This content is loaded after the user input</p>
  <template #placeholder>
    <p>Content placeholder. Click anywhere to show the main content...</p>
  </template>
</ClientOnly>
</template>

```

## 德莫尔

这个 [德莫尔](https://duannx.github.io/vue-client-only/) 只有客户一方。 它显示了组件在客户端中的样子. [演示码](https://github.com/duannx/vue-client-only/blob/main/dev/src/App.vue)

## 捐款

请阅读 [捐款额](https://npmcn.com/package/%40duannx/vue-client-only/CONTRIBUTING.md) 关于我们代码的细节 以及向我们提交拉动请求的程序.

## 版本

**仅限客户** 使用情况 [交换器](http://semver.org/) 用于版本.

## 许可证

这个项目根据麻省理工学院许可证颁发——见 [自由主义](https://npmcn.com/package/%40duannx/vue-client-only/LICENSE) 文件 详细情况.

## 常见问题

### 如何安装 @duannx/vue-client-only？

在项目目录运行 npm install @duannx/vue-client-only，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：vue（^3\.x）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @duannx/vue-client-only 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @duannx/vue-client-only 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @duannx/vue-client-only 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=8\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @duannx/vue-client-only 可以商用吗？

@duannx/vue-client-only 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @duannx/vue-client-only 的下载量有多少？

根据 npm 官方下载统计，@duannx/vue-client-only 在 2026/10/13 – 2026/11/11 这 30 天内被下载 3,559 次，日均约 119 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @duannx/vue-client-only 还在维护吗？

最新版本 1\.0\.3 发布于 2022/06/21（4 年前）；至今共发布 4 个版本，其中过去 12 个月发布了 0 个；首次发布于 2022/06/20。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。