别错过!一款不错的轻量级拖拽库 drag-kit，支持React、Vue等

引言：发现一个宝藏 npm 拖拽库，使用方便简单。

在前端开发中，拖拽功能也是 UI 交互的核心之一，特别是当你需要处理复杂的拖拽需求时，有一个合适的库能变得轻松高效。今天，我们将解析一款轻量级的拖拽库——drag-kit，并展示它如何无缝集成到 Vue 和 React 等主流前端框架中。无论你是需要简单的拖拽效果，还是在跨 iframe 场景中解决棘手的问题，drag-kit 能助你一臂之力。

为什么选择 drag-kit？

在构建具有丰富交互功能的前端应用时，拖拽是不可或缺的。常见的拖拽库功能有限，难以支持复杂的场景，比如：

• 需要高性能拖拽：避免在复杂页面中出现卡顿。
• 跨 iframe 拖拽：处理边界问题，实现顺畅的跨 iframe 拖拽。
• 响应式支持：确保在桌面端和移动设备上都有一致体验。
• 功能丰富：如方向锁定、网格对齐、拖拽区域限制、自动吸附等。
• 兼容 Vue 2、Vue 3 和 React 等主流框架。
• 适配 PC 端移动端：同时支持不同设备上的拖拽需求。

如果你曾经遇到这些问题，那你一定要了解 drag-kit。它不仅解决了这些常见的拖拽难题，还提供了一些你意想不到的高级功能。接下来，我们会深入探讨它在不同应用场景中的表现，并结合实际代码，展示如何轻松实现拖拽功能。

快速上手：基础拖拽

拖拽功能在 UI 开发中非常常见，比如对话框、工具栏等。使用 drag-kit，你可以在几分钟内实现这些功能。

安装 drag-kit

首先，在你的项目中安装 drag-kit：

npm install drag-kit

目前，该库的稳定版本是drag-kit@1.0.7，在多场景交互、性能优化上再次做了提升。

基础拖拽示例

无论是构建一个复杂的后台管理系统，还是设计一个用户可自定义的界面，我们所需的都是快速的配置：（可视区域内拖拽）

import { createDraggable } from 'drag-kit';
createDraggable('draggableElementId', {
	initialPosition: { x: '100px', y: '100px' }, // 可选，支持 calc
});

我们为一个拖拽设置了初始位置，并允许用户自由拖动。drag-kit 的设计考虑了性能优化，确保在频繁拖拽时不会出现卡顿或延迟。

核心能力支持

拖动模式和功能

drag-kit 支持三种拖拽模式和五个核心功能，适应不同的拖拽需求。

import { createDraggable } from 'drag-kit';
// createDraggable(elementId: string, options?: DraggableOptions): Draggable;
// elementId：必传，options：可不传
createDraggable('draggableElementId', {
// mode: screen, // 拖动模式（'screen' | 'page' | 'container'），默认是 `screen`。
// initialPosition: { x: '100px', y: '100px' }, //元素的初始位置，默认 {x: 0，y: 0}。
// dragArea: document.getElementById('dragContainer'), // 拖动区域。如果 `mode` 为 `container`，则需要设置该参数。
// lockAxis: 'none', // 锁定拖动轴（'x' | 'y' | 'none'），默认为 `none`。
// edgeBuffer: 0, // 边缘缓冲区（number），默认为 0。
// gridSize: undefined, // 拖动网格大小（number），默认为 `undefined`，即无网格对齐。
// snapMode: 'none', // 自动吸附模式，(`'none' | 'auto' | 'right' | 'left' | 'top' | 'bottom'`)，默认为 `none`。
// shouldSave: false, // 是否将拖拽位置保存到本地存储。
// onDragStart: () => {}, // 拖拽开始时的回调函数。
// onDrag: () => {}, // 拖拽过程中的回调函数。
// onDragEnd: () => {}, // 拖拽结束时的回调函数。
});

拖拽模式（mode）：

• screen 模式：在当前 可视区域 内拖拽，适用于对话框、工具栏等 UI 元素。拖动范围受到屏幕边界限制。
• page 模式：元素可以在整个 页面范围 内拖动，不受视口限制。适合页面有滚动条的场景，元素可拖动到页面的任何位置。
• container 模式：元素在指定的 容器 内拖动，通过 dragArea 参数指定容器。适合局部拖动的场景，如面板或对话框内部的元素拖动。

核心功能：

• 方向锁定（lockAxis） ：锁定拖动轴（x 轴、y 轴或无）。
• 边缘缓冲区（edgeBuffer） ：设置拖拽边缘的缓冲区域。
• 网格对齐（gridSize） ：设置拖动网格大小（默认为 undefined，即无网格对齐）。
• 自动吸附模式（snapMode） ：自动吸附到视口边缘（默认为 none）。
• 位置保存（shouldSave） ：是否将拖拽位置保存到本地存储。

跨 iframe 拖拽：解决棘手问题

跨 iframe 拖拽是许多开发者头疼的问题，涉及边界计算、事件传递和跨域安全等复杂问题。drag-kit 已经为开发者解决了这些难题，它支持精确的跨 iframe 拖拽，让你无需额外编写复杂的逻辑。

drag-kit 能够准确计算元素位置，并确保拖拽行为在跨 iframe 场景中顺畅衔接。

移动设备支持

drag-kit 还支持在触摸设备上的拖拽操作，通过使用 calc 和百分比（%）布局，实现响应式拖拽，保证在不同屏幕尺寸上的正常使用：

createDraggable('draggableElementId', {
	mode: 'screen',
	initialPosition: { x: 'calc(100vw - 120px)', y: '10%' }
});

确保元素相对于屏幕的拖拽，避免了绝对定位在不同设备上的兼容性问题。

性能优化

为了避免性能开销，建议在不需要拖拽功能时销毁实例，特别是在元素被移除或视图销毁时。以 Vue3 举例：

<template>
	<div id="draggableElement" style="display: none;">Drag me!</div>
</template>
<script lang="ts">
import { onMounted } from 'vue';
import { createDraggable } from 'drag-kit';
export default {
  setup() {
    let draggable;
    onMounted(() => {
      draggable = createDraggable('draggableElement', {
      	initialPosition: { x: '100px', y: '200px' }
      });
    });
    onBeforeUnmount(() => {
    	draggable?.destroy();
    });
  }
};
</script>

通过在 onMounted 钩子中初始化拖拽，并在 onBeforeUnmount 钩子中销毁实例，确保拖拽功能在组件生命周期内得到适当管理。

高级功能拓展（配置超级简单）

在基础功能的基础上，drag-kit 还提供了许多高级功能，帮助你应对更复杂的需求，如 方向锁定、拖拽边界控制、响应式布局、自动吸附 等。下面我们将深入了解这些功能，并展示它们的应用场景。

可视区域内拖拽

在当前浏览器 可视区域 内拖拽，拖动范围受到屏幕边界限制。适用于需要固定在屏幕上的 UI 元素，如对话框、工具栏等。

import { createDraggable } from 'drag-kit';
createDraggable('draggableElementId', {
	initialPosition: { x: '100px', y: '100px' }, // 可选，支持 calc
});

页面范围拖拽

在页面范围内拖拽，即使页面有滚动条，元素也能被拖动到页面的任意位置：

createDraggable('draggableElementId', {
	mode: 'page',
});

拖拽边界控制

在某些场景下，你可能希望拖拽元素保持在页面或者指定容器的边界之内，避免用户拖动到视图外部。drag-kit还 提供了边界缓冲区选项，允许你设置拖拽的最大范围。

createDraggable('draggableElementId', {
  mode: 'container', // 限制在指定容器内拖拽
  dragArea: document.getElementById('dragContainer'),
  edgeBuffer: 20,
});

锁定方向拖拽

我们可以使用 lockAxis 参数来限制拖拽的方向：

createDraggable('draggableElementId', {
	lockAxis: 'x', // 锁定 X 轴拖动
});

网格对齐功能

如果你需要对齐到网格，可以通过 gridSize 参数设置网格对齐大小，实现拖动时自动对齐到指定位置：

createDraggable('draggableElementId', {
	gridSize: 50, // 设置网格间距为 50px
});

自动吸附模式

吸附功能允许你在拖拽结束时，自动吸附到视口边缘。

createDraggable('draggableElementId', {
	snapMode: 'auto', // 自动吸附
});

集成跨框架开发：Vue 2 / 3 和 React

drag-kit 提供了开箱即用的跨框架支持，特别是 Vue 和 React 项目。无论你是在开发基于 Vue 3 的项目，还是使用 React 构建复杂交互界面，都可以轻松集成。

此外，Vue 和 React 有时改变一个数据会发生多次渲染的情况，drag-kit也进行了处理。另外，将元素在初始化前设置为 display: none，会提升更好的交互效果。

在 Vue 框架中集成

drag-kit 与 Vue 2 和 Vue 3 完美兼容。你可以轻松地将拖拽功能集成到 Vue 组件中，无需复杂的配置。

<template>
<div id="draggableElement" style="display: none;">Drag me!</div>
</template>
<script lang="ts">
import { onMounted } from 'vue';
import { createDraggable } from 'drag-kit';
export default {
  setup() {
    let draggable;
    onMounted(() => {
      draggable = createDraggable('draggableElement', {
        initialPosition: { x: '100px', y: '200px' }
      });
    });
    onBeforeUnmount(() => {
      draggable?.destroy();
    });
  }
};
</script>

通过简单的 onMounted 钩子，拖拽功能就能无缝集成到 Vue 组件中。

在 React 框架中集成

如果你使用 React 开发项目，drag-kit 也提供了友好的支持。以下是一个在 React 中使用 drag-kit 的例子：

import React, { useEffect } from 'react';
import { createDraggable } from 'drag-kit';
const DraggableComponent: React.FC = () => {
  useEffect(() => {
    const draggable = createDraggable('draggableElement', {
      initialPosition: { x: '100px', y: '200px' }
    });
    return () => {
      draggable?.destroy();
    };
  }, []);
	return <div id="draggableElement" style={{ display: 'none' }}>Drag me!</div>;
};
export default DraggableComponent;

在 React 项目中，利用 useEffect 钩子可以在组件挂载时初始化拖拽，并在组件卸载时清理拖拽实例。

在纯 JavaScript 中使用

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Drag Kit Example</title>
<style>
#draggableElement {
  width: 100px;
  height: 100px;
  background-color: #3498db;
  position: absolute;
  cursor: move;
}
</style>
</head>
<body>
<div id="draggableElement">拖拽我！</div>

<script src="https://unpkg.com/drag-kit/lib/drag-kit.umd.js"></script>
<script>
// 初始化拖拽功能
document.addEventListener('DOMContentLoaded', () => {
  const draggable = dragKit.createDraggable('draggableElement', {
  	initialPosition: { x: '50px', y: '50px' }
  });
});
</script>
</body>
</html>

总结

drag-kit 一款不错的轻量级却功能丰富的拖拽库 drag-kit，能够处理复杂的拖拽需求，例如跨 iframe 拖拽、方向锁定、边界限制、网格对齐等。无论你是在开发一个简单的个人项目，还是构建企业级应用，drag-kit 都能为你的拖拽需求提供完美的解决方案。

它的跨框架兼容性，适配 Vue 2、Vue 3 和 React，让开发者可以轻松将其集成到不同的技术栈中。欢迎在评论区分享你的经验和见解，也可以提出任何问题，我们一起讨论！