@g9tm/lynxcontrols-progress-overlay

中文文档
1.7.3发布于 2026/11/16MITTypeScriptES Module近 30 天下载 2053

G9ProgressOverlay: long-running operation progress with leases, cancel, minimize and retry.

原始使用文档

@g9tm/lynxcontrols-progress-overlay

One shared overlay for long operations (MAUI G9MAUIControls.ProgressOverlay): leases, staged progress, cancel, minimize to a draggable bubble, success and failure terminals with retry. Depends on @g9tm/lynxcontrols-foundation and @g9tm/lynxcontrols only. Migration table: docs/migration/ProgressOverlay.md.

import { g9ProgressReport, useG9ProgressOverlay } from '@g9tm/lynxcontrols-progress-overlay';

const progress = useG9ProgressOverlay();          // or g9ProgressOverlay() outside components (active host)
const lease = await progress.show('Uploading samples', 'bottom');
try {
  progress.report(0.048, 'Uploading', '12 of 250');
  progress.report(g9ProgressReport.indeterminate('Connecting'));
  progress.reportQueued(3);                       // "+3 waiting"
  await upload();
  await progress.tryShowCurrentSuccess('250 samples uploaded');
} catch (error) {
  await progress.tryShowCurrentFailure('Server unreachable', 'Retry', () => upload());
} finally {
  await lease.dispose();                          // the last lease waits until the terminal state was seen
}

const off = progress.onCancelRequested(() => uploader.cancel());

// The host decides where an overlay shown without a position sits (MAUI 1.3.0), and moves a live one on a screen change.
progress.placementProvider = () => (mapTabShown ? { position: 'top', offset: mapTopBarHeight } : null);
onTabChanged(() => void progress.refreshPlacement());

Behaviour

  • Leases. Concurrent operations each hold a lease on one visual; the oldest is the running one (its context text shows), the rest are queued. Releasing the running lease hands the view to the next; the overlay closes when the last lease is released after its terminal state was seen.
  • Reports are coalesced to ≤ 10 Hz and drive only the Running state; indeterminate reports do not move the bar.
  • Cancel (a 44 × 44 target) switches instantly to Canceling and broadcasts to onCancelRequested listeners. A cancellation is never an error: when the run stops, the overlay closes and a neutral "Cancelled" toast shows; if the step cannot be interrupted, a notice appears after 5 s.
  • Terminals always force the full card. Success dwells 2.2 s (countdown bar). Failure waits for the user: Retry resets to Running and runs the action once (a second tap joins it); Close acknowledges. showStandaloneFailure shows a failure with nothing running.
  • Minimize. Tapping the running card collapses it to a 72 × 72 bubble (lynx-ui Draggable); tapping the bubble restores it.
  • Placement. Bottom (default) or top, above the host's bottom inset (bottomWithTabBar) or below its top inset, 14 px in; toasts lift above a bottom overlay. Call refreshBottomInset() after the tab bar hides or returns (it glides 220 ms).
  • Host placement (MAUI 1.3.0). The right spot depends on the screen, not on who started the work: set the service's placementProvider (it receives the host and returns { position, offset }, an edge plus extra distance from that edge's inset, or null for the default g9ProgressOverlayPlacement.default). An overlay shown without a position follows it: the provider is read when the overlay mounts, and refreshPlacement() moves a live overlay when the screen under it changes (a tab switch, a full-screen sheet). An offset change on the same edge glides; an edge change fades out at the old edge and in at the new one (a glide would sweep the card over the whole screen); refreshPlacement(false) jumps. An overlay shown with a position keeps it for its life, and a minimized bubble is never moved. A throwing provider falls back to the default (with a console warning).

Bubble drag on desktop is a device check (ledger N-047); the placement motions are N-060.

版本与发布记录

@g9tm/lynxcontrols-progress-overlay 共发布 14 个版本,首次发布于 2026/10/07;过去 12 个月发布了 14 个版本。

版本发布日期距今
1.7.3latest2026/11/16今天
1.7.22026/11/132 天前
1.7.12026/11/133 天前
1.7.02026/11/133 天前
1.6.12026/11/123 天前
1.6.02026/11/123 天前

关于 @g9tm/lynxcontrols-progress-overlay 的常见问题

@g9tm/lynxcontrols-progress-overlay 是什么?

G9ProgressOverlay: long-running operation progress with leases, cancel, minimize and retry.

如何安装 @g9tm/lynxcontrols-progress-overlay?

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

@g9tm/lynxcontrols-progress-overlay 支持 TypeScript 吗?

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

@g9tm/lynxcontrols-progress-overlay 支持 ESM 还是 CommonJS?

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

@g9tm/lynxcontrols-progress-overlay 可以商用吗?

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

@g9tm/lynxcontrols-progress-overlay 的下载量有多少?

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

@g9tm/lynxcontrols-progress-overlay 还在维护吗?

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