# @cloudflare/realtimekit-react-ui 中文文档

规范地址：https://npmcn.com/package/%40cloudflare/realtimekit-react-ui/

版本：2\.1\.0
npm 元数据更新时间：2026-11-16T07:27:38.921Z
中文译文更新时间：2026-11-16T07:28:17.865Z
软件包许可：未声明

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

原始 npm 页面：https://www.npmjs.com/package/%40cloudflare/realtimekit-react-ui
原文对照：https://npmcn.com/package/%40cloudflare/realtimekit-react-ui/?lang=original
项目主页：https://realtime.cloudflare.com/
源码仓库：https://github.com/cloudflare/realtimekit-ui

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

- 包体积（解压后）：161 kB，46 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2025-04-04T16:45:24.179Z
- 最新版本发布：2026-11-16T07:27:38.532Z
- 近 30 天下载量：290537（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：129（近 12 个月 76 个）

## 中文简介

与 Cloudflare RealtimeKit 集成的预建、现成和通用组件

## 安装

```sh
npm install @cloudflare/realtimekit-react-ui
```

也可以使用：`pnpm add @cloudflare/realtimekit-react-ui`、`yarn add @cloudflare/realtimekit-react-ui`、`bun add @cloudflare/realtimekit-react-ui`

## README

# 实时 Kit 回放 UI

**实时 Kit 回放 UI** 提供预建的、现成的UI组件,用于与 [Cloudflare 实时 Kit](https://npmjs.com/package/@cloudflare/realtimekit)。 。 。 .

如果您使用不同的框架或没有框架(见HTML),我们也提供专用包:

-   [角质](https://npmjs.com/package/@cloudflare/realtimekit-angular-ui)
-   [HTML (网络组件)](https://npmjs.com/package/@cloudflare/realtimekit-ui)

## 使用量

首先,随同安装实时Kit UI [实时 Kit](https://npmjs.com/package/@cloudflare/realtimekit)数字 :

> `@cloudflare/realtimekit` 是提供API处理客户端会议的核心软件包. 你用它来访问和在会议上执行动作.

```sh
npm i @cloudflare/realtimekit-react-ui @cloudflare/realtimekit
```

### 简单使用

这是使用RealtimeKit UI的最简单的方法,在这里你不必独自管理整个会话UI. 一切都会得到照顾 `RtkMeeting` 组件.

使用 `useRealtimeKitClient()` 要访问的钩 `meeting` 实例状态,以及 `meeting` 实例初始化方法.

那就传过去 `authToken` 从你的API那里得到的参与者.

> 您从您的后端 API 调用 RealtimeKit 添加参与者 API 获取此功能 `authToken` 用于实时 Kit.

```jsx
import { useRealtimeKitClient } from '@cloudflare/realtimekit/react';

function App() {
  const [meeting, initMeeting] = useRealtimeKitClient();

  useEffect(() => {
    initMeeting({
      authToken: '<auth-token>',
      roomName: '<room-name>',
      defaults: {
        audio: true,
        video: true,
      },
    });
  }, []);

  return <RtkMeeting meeting={meeting} />;
}
```

### 使用 `<RtkUiProvider>`

如果您想要使用单个的 UI 组件来构建您想要的 UI, 您可以使用 `RtkUiProvider` 向所有儿童提供会议实例,使发展更容易:

```jsx
import { useRealtimeKitClient } from '@cloudflare/realtimekit/react';
import {
  RtkUiProvider,
  RtkMeeting,
  RtkSimpleGrid,
} from '@cloudflare/realtimekit-react-ui';

function App() {
  const [meeting, initMeeting] = useRealtimeKitClient();

  useEffect(() => {
    initMeeting({
      authToken: '<auth-token>',
      roomName: '<room-name>',
      defaults: {
        audio: true,
        video: true,
      },
    });
  }, []);

  return (
    <RtkUiProvider meeting={meeting}>
      <RtkSimpleGrid />
    </RtkUiProvider>
  );
}
```

## 常见问题

### @cloudflare/realtimekit-react-ui 是什么？

与 Cloudflare RealtimeKit 集成的预建、现成和通用组件

### 如何安装 @cloudflare/realtimekit-react-ui？

在项目目录运行 npm install @cloudflare/realtimekit-react-ui，或使用 pnpm add / yarn add / bun add。

### @cloudflare/realtimekit-react-ui 支持 TypeScript 吗？

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

### @cloudflare/realtimekit-react-ui 支持 ESM 还是 CommonJS？

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

### @cloudflare/realtimekit-react-ui 可以商用吗？

@cloudflare/realtimekit-react-ui 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @cloudflare/realtimekit-react-ui 的下载量有多少？

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

### @cloudflare/realtimekit-react-ui 还在维护吗？

最新版本 2\.1\.0 发布于 2026/11/16（今天）；至今共发布 129 个版本，其中过去 12 个月发布了 76 个；首次发布于 2025/04/05。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

