@bimetal/kanban-headless

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

Canonical, framework-agnostic kanban controller (createKanbanController) on @bimetal/headless-core. Owns all board-interaction semantics — drag/drop, dialog, filter, WIP-error-as-state, undo. Instance #2 of the component family; frameworks bind it as pure

原始使用文档

@bimetal/kanban-headless

The canonical, framework-agnostic kanban controller — instance #2 of the BIMETAL component family. Built on @bimetal/headless-core exactly like the calendar controller, so it shares the identity-stable getSnapshot/subscribe contract and errors-as-state surface; framework bindings are pure bindings.

createKanbanController({ store, boardId, config }) owns every board interaction decision:

  • Dialog — openCreateCard / openEditCard / saveCard / deleteCard.
  • Drag/drop — dropCard(cardId, toColumnId, toIndex) / reorderCard, with startDrag / updateDragPreview / endDrag for live previews.
  • Pointer drag — pointerDownCard / pointerMoveCard / pointerUpCard / pointerCancelCard. A mouse drags after 4 px. A touch or pen pointer (pass e.pointerType) picks the card up only after config.touchHoldMs (default 450 ms) without movement. A swipe before that stays the browser's scroll (the card has touch-action: pan-x pan-y). Once a card is picked up, touchMoveCard(e) stops the scroll; register it on touchmove with { passive: false }. contextMenuCard(e) keeps the long-press menu away (bimetal-363). touchHoldMs: 0 picks the card up on touchdown; a swipe that starts on a card then drags it and does not scroll (bimetal-386).
  • WIP-error-as-state — a rejected create/move (WIP limit) surfaces as snapshot.lastAction (a toast) and never throws into the binding.
  • Undo — undo() reverts the whole board one step; Ctrl/Cmd+Z via handleKeydown.
  • Filter / selection — setFilter, selectCard / clearSelection.
  • Activation — a card click (not the click trailing a drag) and Enter go through activateCard: it selects the card (onSelectionChange fires), then calls the optional onCardActivate(cardId) hook. With the hook set, or with config.cardDialog: false, the built-in edit dialog does not open — for a host that shows the card in its own detail view (master-detail).
  • Locks — config.readOnly locks everything, moving included. config.lockStructure (columns: add, rename, reorder, delete, WIP) and config.lockCardContent (cards: create, edit, delete) lock finer and keep moving cards by pointer and keyboard; undo/redo are off under any lock. The snapshot carries canEditStructure / canEditCards / undoRedoAvailable, and the bindings hide their affordances by these.

The cut line is identical to the calendar controller: DOM measurement and listener registration belong to the framework; every if belongs here.

版本与发布记录

@bimetal/kanban-headless 共发布 15 个版本,首次发布于 2026/07/16;过去 12 个月发布了 15 个版本。

版本发布日期距今
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 个月前

其他发布通道:next → 1.0.0-rc.3。

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

@bimetal/kanban-headless 是什么?

Canonical, framework-agnostic kanban controller (createKanbanController) on @bimetal/headless-core. Owns all board-interaction semantics — drag/drop, dialog, filter, WIP-error-as-state, undo. Instance #2 of the component family; frameworks bind it as pure

如何安装 @bimetal/kanban-headless?

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

@bimetal/kanban-headless 支持 TypeScript 吗?

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

@bimetal/kanban-headless 支持 ESM 还是 CommonJS?

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

@bimetal/kanban-headless 可以商用吗?

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

@bimetal/kanban-headless 的下载量有多少?

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

@bimetal/kanban-headless 还在维护吗?

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