@100mslive/roomkit-react

中文文档
0.6.3发布于 2026/10/01MITTypeScriptESM + CJS构建来源已验证近 30 天下载 2.9万

Banner

中文使用文档
文档目录10 节
  1. 安装
  2. 使用量
  3. 使用房间代码
  4. 使用认证脚本
  5. 自定义
  6. 理解结构
  7. 预建中的主要组件
  8. 自定义样式
  9. 捐款
  10. 社区与支持

Banner

Lint, Test and Build Bundle Size License Tree shaking

室内反应库

100ms Room Kit 提供了简单易用UI组件在您的应用程序中构建Live Streaming & Video Conferencing 体验的简单 & 方便.

安装

// npm
npm install @100mslive/roomkit-react@latest --save

// yarn
yarn add @100mslive/roomkit-react@latest

使用量

使用房间代码

import { HMSPrebuilt } from '@100mslive/roomkit-react'

export default App() {
    return (
        <HMSPrebuilt roomCode={<room-code>} />
    );
}

使用认证脚本

import { HMSPrebuilt } from '@100mslive/roomkit-react'

export default App() {
    return (
        <HMSPrebuilt authToken={<auth-token>} />
    );
}

关于其他道具,请参考 文档

自定义

当我们提议 无代码自定义预建,您可以叉出您的预建组件副本,并修改代码,以便进行更多的微调.

预建自定义可用于 100毫分高压板。 。 。 .

理解结构

这个 src 文件夹包含所有组件, Button, (中文(简体) ), Accordion 包括:. 这个 Prebuilt 文件夹包含完整的预建执行 . App.tsx 是一个包含 HMSPrebuilt 组件.

预建中的主要组件

构成部分说明
拉尤特房间这是包含来自仪表板的配置的背景 自定义。无论对仪表板自定义器作何种修改,在下次加入时都可以使用.
附录包含在不同屏幕之间切换的逻辑,例如预览到会议,会议到离开。 这些过渡是基于反应商店提供的室状态(useHMSStore(selectHMSRoomState)) (中文(简体) ).
预览屏幕包含预览执行。 包含视频平板、视频、音频切换和虚拟背景及设置以及名称输入.
会议此选项包含完成预览并进入会话后屏幕 。 这包含了头和脚以及主要内容.
视频结构部分此组件包含主要视频渲染组件和一个侧边栏( Chat 和 Polls 等交互功能在此显示)
离开史克林这是您离开会议时显示的屏幕

自定义样式

基础配置 拥有您可以使用的所有变量。 主题的任何更改都可以在此进行. 除非您想要引入新的变量, 很可能不需要额外的修改 .

何时 HMSThemeProvider 在顶层使用,所有变量将提供给此组件树下的所有儿童.

对于使用基元件创建的组件,例如 Box, (中文(简体) ), Flex, (中文(简体) ), Button 等,css Prop可供修改样式. 在css道具内,您可以访问来自 基础配置。 。 。 .

捐款

  • 确定您创建的任何新组件/文件 Typescript。 。 。 .

  • 别忘了为按钮,菜单等可操作性设备添加数据测试ID.

  • 设置适当的工具( E)ESLint 语录 财务报告和审定财务报表 高级在你的编辑.

  • yarn lint 将会在您推动更改前运行, 所以每次推出失败时, 请检查是否有提示错误 .

读这个 医生 用于编码指南.

社区与支持

  • GitHub 问题 - 使用Web SDK提交任何错误.
  • 盘子 - 问问题从百米队获得帮助.
  • 联系人 ——联系百米团队,获取定价信息,了解我们如何帮助您上线,或者更多地了解平台.

版本与发布记录

@100mslive/roomkit-react 共发布 475 个版本,首次发布于 2023/07/25;过去 12 个月发布了 80 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.6.3latest2026/10/011 个月前
0.6.3-alpha.1alpha2026/10/011 个月前
0.6.3-alpha.02026/09/291 个月前
0.6.22026/09/221 个月前
0.6.2-alpha.62026/09/221 个月前
0.6.2-alpha.52026/09/221 个月前

关于 @100mslive/roomkit-react 的常见问题

如何安装 @100mslive/roomkit-react?

在项目目录运行 npm install @100mslive/roomkit-react,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(>=17.0.2 <19.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@100mslive/roomkit-react 支持 TypeScript 吗?

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

@100mslive/roomkit-react 支持 ESM 还是 CommonJS?

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

@100mslive/roomkit-react 可以商用吗?

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

@100mslive/roomkit-react 的下载量有多少?

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

@100mslive/roomkit-react 还在维护吗?

最新版本 0.6.3 发布于 2026/10/01(1 个月前);至今共发布 475 个版本,其中过去 12 个月发布了 80 个;首次发布于 2023/07/25。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。