# @bimetal/overlay-react-components 中文文档

规范地址：https://npmcn.com/package/%40bimetal/overlay-react-components/

版本：0\.42\.0
npm 元数据更新时间：2026-10-30T11:42:20.951Z
中文译文更新时间：2026-11-08T03:00:02.720Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40bimetal/overlay-react-components
原文对照：https://npmcn.com/package/%40bimetal/overlay-react-components/?lang=original

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

- 包体积（解压后）：19.5 kB，17 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：3 个
- peer 依赖：react ^18\.0\.0 \|\| ^19\.0\.0，react-dom ^18\.0\.0 \|\| ^19\.0\.0
- 首次发布：2026-08-30T08:40:03.724Z
- 最新版本发布：2026-10-30T11:42:20.747Z
- 近 30 天下载量：3605（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：7（近 12 个月 7 个）

## 中文简介

BIMETAL 覆盖家族的反演渲染层 — Canonic 覆盖控制器上的对话框.

## 安装

```sh
npm install @bimetal/overlay-react-components
```

也可以使用：`pnpm add @bimetal/overlay-react-components`、`yarn add @bimetal/overlay-react-components`、`bun add @bimetal/overlay-react-components`

## README

# @ bimetal/ overlay- react- 组件

BIMETAL 反应渲染层 **覆盖家族** 目前 **对话框**一个瘦子 在峡谷上绑起 `@bimetal/overlay-headless` 控制器。 控制器。 弹出/ 工具提示 / 菜单 / Drawer 遵循同一核心.

```tsx
import { useOverlayController } from '@bimetal/react';
import { Dialog } from '@bimetal/overlay-react-components';

function Example() {
  const [snapshot, controller] = useOverlayController();
  return (
    <>
      <button onClick={() => controller.open()}>Open</button>
      <Dialog controller={controller} title="Hello">…content…</Dialog>
    </>
  );
}
```

控制器拥有开放/关闭+删除策略;组件使模式DOM, 陷阱焦点( e)`@bimetal/a11y-dom`),锁定正文卷轴,并反馈 Esc / 背景 / 关闭按钮 被解职 `requestClose`样式来源于 `@bimetal/overlay-themes` (再出口). 阿帕奇2.0 (英语).

## 常见问题

### @bimetal/overlay-react-components 是什么？

BIMETAL 覆盖家族的反演渲染层 — Canonic 覆盖控制器上的对话框\.

### 如何安装 @bimetal/overlay-react-components？

在项目目录运行 npm install @bimetal/overlay-react-components，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（^18\.0\.0 \|\| ^19\.0\.0）、react-dom（^18\.0\.0 \|\| ^19\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @bimetal/overlay-react-components 支持 TypeScript 吗？

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

### @bimetal/overlay-react-components 支持 ESM 还是 CommonJS？

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

### @bimetal/overlay-react-components 可以商用吗？

@bimetal/overlay-react-components 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @bimetal/overlay-react-components 的下载量有多少？

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

### @bimetal/overlay-react-components 还在维护吗？

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