# @bimetal/overlay-headless 中文文档

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

版本：0\.42\.0
npm 元数据更新时间：2026-10-30T11:43:30.767Z
中文译文更新时间：2026-11-08T02:53:17.917Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：22.5 kB，19 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2026-08-30T08:40:00.926Z
- 最新版本发布：2026-10-30T11:43:30.584Z
- 近 30 天下载量：11948（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：7（近 12 个月 7 个）

## 中文简介

由 Dialog/Popover/Tooltip/Menu/Drawer 共享的Canonic,框架-不可知重叠控制器(开/关闭+除去策略).

## 安装

```sh
npm install @bimetal/overlay-headless
```

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

## README

# @ bimetal/ 无覆盖头

框架-不可知论 **覆盖控制器** ——覆盖的共享核心 家族(先拨号; Popover / Tooltip / menu / Drawer ). 它拥有开放/关闭 **状态** 和解雇 **政策** (是否为 `Esc` 或被弃绝,或被弃绝 蓄意 **无DOM**设置焦点陷阱 (单位:千美元)`@bimetal/a11y-dom`),卷轴锁和背景,并反馈解答手势通过 `requestClose(reason)`。 。 。 .

```ts
import { createOverlayController } from '@bimetal/overlay-headless';

const dialog = createOverlayController({ onOpenChange: (open) => {} });
dialog.open();
dialog.requestClose('esc');       // closes iff config.closeOnEsc
dialog.requestClose('backdrop');  // closes iff config.closeOnBackdrop
dialog.close();                   // force-close (a close button / app action)
```

-   `open()` 编号 : `close()` 编号 : `toggle()` - 驱动国家(`close()` 绕过策略).
-   `requestClose('esc' | 'backdrop' | 'programmatic')` - 唯一被开除的地方 因此,没有约束性的差异.
-   `getSnapshot()` 编号 : `subscribe()` ——身份稳定快照 `useSyncExternalStore`。 。 。 .

BIMETAL成分家族的一部分. 阿帕奇2.0 (英语).

## 常见问题

### @bimetal/overlay-headless 是什么？

由 Dialog/Popover/Tooltip/Menu/Drawer 共享的Canonic,框架-不可知重叠控制器\(开/关闭\+除去策略\)\.

### 如何安装 @bimetal/overlay-headless？

在项目目录运行 npm install @bimetal/overlay-headless，或使用 pnpm add / yarn add / bun add。

### @bimetal/overlay-headless 支持 TypeScript 吗？

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

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

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

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

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

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

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

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

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