@gripflow/core

中文文档
0.1.1发布于 2026/10/12MITTypeScriptESM + CJS零依赖近 30 天下载 7868

Gripflow核心:框架独立,有指针的无头拖放引擎,触控和键盘传感器,相撞探测,调制器,可分拣模型和自动滚转.

中文使用文档
文档目录7 节
  1. 安装
  2. 纯助手
  3. 发动机
  4. 构件
  5. 活动
  6. 相关软件包
  7. 作者

@ gripflow/ core (英语)

Gripflow后方的框架独立拖放引擎. 指针,触控和键盘传感器,相撞探测器,调制器,可分拣数学,自动滚动和可访问性公告,以平版TypeScript形式发布.

npm types license

建立反应还是下一个.js应用程序? 你不需要直接安装这个 开始 @gripflow/presets (各种列表、网格、表格), @gripflow/kanban 或者说 @gripflow/tree。 。 。 . @gripflow/core 为您安装.

安装 @gripflow/core 当您想要:

  • 使用该 纯助手 (单位:千美元)arrayMove, (中文(简体) ), applySortableMove在服务器上或在测试中,
  • 写入 定制传感器、修改器或碰撞探测器, (中文(简体) ),
  • 或构建一个 另一个 UI 框架的适配器 (Vue, Svelte, Solid, 香草DOM).

它没有反应依赖,没有网络接入和遥测.

安装

npm install @gripflow/core

纯助手

在不改变数据的情况下重排顺序 :

import { arrayMove, applySortableMove } from "@gripflow/core";

arrayMove(["a", "b", "c"], 0, 2); // ["b", "c", "a"]

// Apply the move reported by a drag-end event, by id, across containers:
const next = applySortableMove({ todo: todoCards, done: doneCards }, event.move, (card) => card.id);

也导出 : arrayInsert, (中文(简体) ), arrayRemove, (中文(简体) ), moveById, (中文(简体) ), moveBetweenContainers, (中文(简体) ), findContainerOf。 。 。 .

发动机

DragEngine 是无头状态机器。 拥有传感器、活性拖放验证和事件; ,您会记录元素,并给出结果,而无论您的框架如何.

import { DragEngine, pointerSensor, keyboardSensor } from "@gripflow/core";

const engine = new DragEngine({
  sensors: [pointerSensor(), keyboardSensor()],
  onDragEnd(event) {
    console.log("dropped", event.active.id, "over", event.over?.id, "move:", event.move);
  },
});

const unmount = engine.mount(); // starts listening; call the returned function to stop

const card = document.querySelector<HTMLElement>("#card-1")!;
const registration = engine.registerDraggable({ id: "card-1", element: card });

// later:
registration.unregister();
unmount();

反应包( R)@gripflow/react 和朋友),就是这个API周围的薄的束缚.

构件

区域出口
发动机DragEngine, (中文(简体) ), createStore, (中文(简体) ), SortableCoordinator, (中文(简体) ), GeometryCache
传感器pointerSensor, (中文(简体) ), keyboardSensor, (中文(简体) ), isInteractiveTarget
碰撞探测closestCenter, (中文(简体) ), closestCorners, (中文(简体) ), pointerWithin, (中文(简体) ), rectIntersection, (中文(简体) ), containerAware, (中文(简体) ), composeDetectors, (中文(简体) ), defaultCollisionDetector
修改器restrictToVerticalAxis, (中文(简体) ), restrictToHorizontalAxis, (中文(简体) ), restrictToWindowEdges, (中文(简体) ), restrictToParentElement, (中文(简体) ), restrictToBounds, (中文(简体) ), snapToGrid
排序战略verticalListStrategy, (中文(简体) ), horizontalListStrategy, (中文(简体) ), rectSortingStrategy, (中文(简体) ), noSortingStrategy
可排序数据arrayMove, (中文(简体) ), applySortableMove, (中文(简体) ), moveBetweenContainers, (中文(简体) ), arrayInsert, (中文(简体) ), arrayRemove
滚动和移动AutoScroller, (中文(简体) ), resolveAnimation, (中文(简体) ), prefersReducedMotion
无障碍createDefaultAnnouncements, (中文(简体) ), DEFAULT_INSTRUCTIONS
帮助者createHistory (未执行/重新执行), createOptimisticController (乐观的更新与回滚), loggerPlugin

示例: 限制拖曳到垂直轴(工作通过) @gripflow/react是因为 modifiers 还有道具:

import { restrictToVerticalAxis, restrictToWindowEdges } from "@gripflow/core";

new DragEngine({ modifiers: [restrictToVerticalAxis, restrictToWindowEdges()] });

每个导出都完全输入,所以您的编辑器会显示您输入的文档 .

活动

dragStart, (中文(简体) ), dragMove, (中文(简体) ), dragOver, (中文(简体) ), dropTargetEnter, (中文(简体) ), dropTargetLeave, (中文(简体) ), dropRequested, (中文(简体) ), dropAccepted, (中文(简体) ), dropRejected, (中文(简体) ), dragEnd, (中文(简体) ), dragCancel, (中文(简体) ), error。订阅 engine.on(name, handler) 或者说 通过 onDragEnd- 选项中的处理者.

@gripflow/react • 妇女 @gripflow/presets • 妇女 @gripflow/kanban • 妇女 @gripflow/tree • 妇女 @gripflow/nestjs-adapter

作者

创建和维护者 萨尔曼尼扎姆. 欢迎就 GitHub 图像麻省理工学院有执照.

版本与发布记录

@gripflow/core 共发布 3 个版本,首次发布于 2026/10/12;过去 12 个月发布了 3 个版本。

版本发布日期距今
0.1.1latest2026/10/121 个月前
0.1.02026/10/121 个月前
0.0.0-stage2026/10/121 个月前

关于 @gripflow/core 的常见问题

@gripflow/core 是什么?

Gripflow核心:框架独立,有指针的无头拖放引擎,触控和键盘传感器,相撞探测,调制器,可分拣模型和自动滚转.

如何安装 @gripflow/core?

在项目目录运行 npm install @gripflow/core,或使用 pnpm add / yarn add / bun add。

@gripflow/core 支持 TypeScript 吗?

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

@gripflow/core 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@gripflow/core 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=18。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@gripflow/core 可以商用吗?

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

@gripflow/core 的下载量有多少?

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

@gripflow/core 还在维护吗?

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