@bimetal/overlay-headless

中文文档
0.42.0发布于 2026/10/30Apache-2.0TypeScriptES Module近 30 天下载 1.2万

Canonical, framework-agnostic overlay controller (open/close + dismiss policy) shared by Dialog/Popover/Tooltip/Menu/Drawer.

原始使用文档

@bimetal/overlay-headless

Canonical, framework-agnostic overlay controller — the shared core for the overlay family (Dialog first; Popover / Tooltip / Menu / Drawer to follow). It owns the open/close state and the dismiss policy (whether an Esc or backdrop dismiss is honored); it is deliberately DOM-free. The render-layer bindings install the focus trap (@bimetal/a11y-dom), the scroll lock and the backdrop, and feed dismiss gestures back via requestClose(reason).

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() — drive the state (close() bypasses policy).
  • requestClose('esc' | 'backdrop' | 'programmatic') — the single place the dismiss decision lives, so no binding diverges.
  • getSnapshot() / subscribe() — identity-stable snapshot for useSyncExternalStore.

Part of the BIMETAL component family. Apache-2.0.

版本与发布记录

@bimetal/overlay-headless 共发布 7 个版本,首次发布于 2026/08/30;过去 12 个月发布了 7 个版本。

版本发布日期距今
0.42.0latest2026/10/309 天前
0.41.02026/10/2415 天前
0.40.02026/10/1128 天前
0.39.02026/10/061 个月前
0.38.02026/10/041 个月前
0.37.02026/09/131 个月前

关于 @bimetal/overlay-headless 的常见问题

@bimetal/overlay-headless 是什么?

Canonical, framework-agnostic overlay controller (open/close + dismiss policy) shared by Dialog/Popover/Tooltip/Menu/Drawer.

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