# @gripflow/core 中文文档

规范地址：https://npmcn.com/package/%40gripflow/core/

版本：0\.1\.1
npm 元数据更新时间：2026-10-12T06:17:29.056Z
中文译文更新时间：2026-11-17T03:24:55.024Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40gripflow/core
原文对照：https://npmcn.com/package/%40gripflow/core/?lang=original
项目主页：https://github.com/salmannizam/Gripflow#readme
源码仓库：https://github.com/salmannizam/Gripflow

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

- 包体积（解压后）：742 kB，9 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=18
- 运行依赖：0 个
- 首次发布：2026-10-12T05:50:50.503Z
- 最新版本发布：2026-10-12T06:17:28.845Z
- 近 30 天下载量：7868（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：3（近 12 个月 3 个）

## 中文简介

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

## 安装

```sh
npm install @gripflow/core
```

也可以使用：`pnpm add @gripflow/core`、`yarn add @gripflow/core`、`bun add @gripflow/core`

## README

# @ gripflow/ core (英语)

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

[![npm](https://img.shields.io/npm/v/@gripflow/core?color=cb3837&logo=npm)](https://www.npmjs.com/package/@gripflow/core) [![types](https://img.shields.io/npm/types/@gripflow/core)](https://www.npmjs.com/package/@gripflow/core) [![license](https://img.shields.io/npm/l/@gripflow/core)](https://github.com/salmannizam/Gripflow/blob/main/LICENSE)

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

安装 `@gripflow/core` 当您想要:

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

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

## 安装

```bash
npm install @gripflow/core
```

## 纯助手

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

```ts
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` 是无头状态机器。 拥有传感器、活性拖放验证和事件; ,您会记录元素,并给出结果,而无论您的框架如何.

```ts
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` 还有道具:

```ts
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`](https://www.npmjs.com/package/@gripflow/react) • 妇女 [`@gripflow/presets`](https://www.npmjs.com/package/@gripflow/presets) • 妇女 [`@gripflow/kanban`](https://www.npmjs.com/package/@gripflow/kanban) • 妇女 [`@gripflow/tree`](https://www.npmjs.com/package/@gripflow/tree) • 妇女 [`@gripflow/nestjs-adapter`](https://www.npmjs.com/package/@gripflow/nestjs-adapter)

## 作者

创建和维护者 [萨尔曼尼扎姆](https://github.com/salmannizam). 欢迎就 [GitHub 图像](https://github.com/salmannizam/Gripflow/issues)麻省理工学院有执照.

## 常见问题

### @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 和提交记录判断。

