@cloudflare/realtimekit-react-ui

中文文档
2.1.0发布于 2026/11/16TypeScriptESM + CJS构建来源已验证近 30 天下载 29.1万

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

中文使用文档
文档目录3 节
  1. 使用量
  2. 简单使用
  3. 使用 <RtkUiProvider>

实时 Kit 回放 UI

实时 Kit 回放 UI 提供预建的、现成的UI组件,用于与 Cloudflare 实时 Kit。 。 。 .

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

使用量

首先,随同安装实时Kit UI 实时 Kit数字 :

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

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

简单使用

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

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

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

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

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 向所有儿童提供会议实例,使发展更容易:

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 共发布 129 个版本,首次发布于 2025/04/05;过去 12 个月发布了 76 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
2.1.0latest2026/11/16今天
2.1.0-staging.6staging2026/11/16今天
2.1.0-staging.52026/11/132 天前
2.1.0-staging.42026/11/123 天前
2.1.0-staging.32026/11/124 天前
2.1.0-staging.22026/11/124 天前

关于 @cloudflare/realtimekit-react-ui 的常见问题

@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 和提交记录判断。