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

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

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

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

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

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

- 包体积（解压后）：1.7 MB，18 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：2 个
- peer 依赖：@angular/core \>=12，@angular/common \>=12
- 首次发布：2025-04-04T16:45:37.273Z
- 最新版本发布：2026-11-16T07:27:43.859Z
- 近 30 天下载量：2471（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：123（近 12 个月 71 个）

## 中文简介

与Cloudflare RetimeKit整合的Angular UI组件和公用事业

## 安装

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

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

## README

# 实时 Kit 用户界面

**实时 Kit 用户界面** 提供预建的、随时可用的UI组件,用于与 [Cloudflare 实时 Kit](https://npmjs.com/package/@cloudflare/realtimekit)。 。 。 .

如果您使用特定框架( 或者没有框架 - 见 HTML), 我们还提供专用软件包 :

-   [反应](https://npmjs.com/package/@cloudflare/realtimekit-react-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-ui @cloudflare/realtimekit
```

然后,你需要初始化一个会议对象 一旦你收到一个 `authToken` 您的API 参与者.

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

```js
import RealtimeKitClient from '@cloudflare/realtimekit';

const meeting = await RealtimeKitClient.init({
  authToken: '<your-auth-token>',
  defaults: {
    video: true,
    audio: true,
  },
});
```

### 简单使用

在模板文件( 组件. html) 中装入组件 :

```html
<rtk-meeting #myid></rtk-meeting>
```

然后将会议对象初始化并传递给组件:

```tsx
import { RtkMeeting } from '@cloudflare/realtimekit-ui';
import RealtimeKitClient from '@cloudflare/realtimekit';

class AppComponent {
  title = 'MyProject';
  @ViewChild('myid') meetingComponent: RtkMeeting;
  rtkMeeting: RtkClient;

  async ngAfterViewInit() {
    const meeting = await RealtimeKitClient.init({
      authToken: '<auth-token>',
      defaults: {
        video: true,
        audio: true,
      },
    });
    meeting.joinRoom();
    this.rtkMeeting = meeting;
    if (this.meetingComponent) this.meetingComponent.meeting = meeting;
  }
}
```

### 使用 RtkUi 提供

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

```html
<rtk-ui-provider #myid>
  <rtk-simple-grid />
</rtk-ui-provider>
```

然后将会议对象初始化并传递给组件:

```tsx
import { RtkMeeting } from '@cloudflare/realtimekit-ui';
import RealtimeKitClient from '@cloudflare/realtimekit';

class AppComponent {
  title = 'MyProject';
  @ViewChild('myid') uiProvider: RtkUiProvider;
  rtkMeeting: RtkClient;

  async ngAfterViewInit() {
    const meeting = await RealtimeKitClient.init({
      authToken: '<auth-token>',
      defaults: {
        video: true,
        audio: true,
      },
    });
    meeting.joinRoom();
    this.rtkMeeting = meeting;
    if (this.uiProvider) this.uiProvider.meeting = meeting;
  }
}
```

## 常见问题

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

与Cloudflare RetimeKit整合的Angular UI组件和公用事业

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

在项目目录运行 npm install @cloudflare/realtimekit-angular-ui，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@angular/core（\>=12）、@angular/common（\>=12）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

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

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

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

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

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

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

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

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

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

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

