众所周知,在React中有一款非常强大的拖拽库,叫React DnD,而Vue中,大部分都是类似于vue.draggable等拖拽排序的库,然而它并不能满足我们所有的需求,特别是应对一些自由拖拽或混合拖拽的场景(例如:低代码),它是很难做到的,所以vue3-dnd它来了!
React DnD 是 Redux 核心作者 Dan Abramov 创造的一组 React 工具库,可以帮助您构建复杂的拖放接口,同时保持组件的解耦性。 React DnD 并没有提供一个排序或拖拽的组件,相反,它为您提供了所需的工具。
vue3-dnd 是基于React DnD的核心程序实现的一组Vue composition-api,它提供了尽量与React DnD保持一致的api,便于我们去构建一个复杂、自由的拖拽功能。
越来越多的人使用pnpm,所以我们也推荐你使用pnpm来进行安装,当然你也可以使用其它任意工具进行安装
pnpm install vue3-dnd react-dnd-html5-backend
# or
npm install vue3-dnd react-dnd-html5-backend
react-dnd-html5-backend 是一个React DnD 的插件,它提供了一个HTML5的拖放支持;你也可以使用react-dnd-touch-backend 提供移动端拖放支持。
得益于React DnD的优秀设计,我们可以直接使用它提供的backend,或者实现一个自己的backend,还可以使用 react-dnd-test-backend 来测试你的拖拽组件。
React DnD创造了一些新的概念,如果第一次使用它的话,我们可能要提前了解它。
当然,你也可以先跳过这一部分,在你真正使用的时候再去了解它。
React DnD 使用数据而不是视图作为拖拽实施。当您在屏幕上拖动某些东西时,我们不会说正在拖动组件或 DOM 节点。相反,我们说正在拖动某种类型的项目。
拖放本质上是有状态的。拖动操作正在进行中,或者没有。要么有当前类型和当前项目,要么没有。这种状态必须存在于某个地方。
对于每个需要跟踪拖放状态的组件,您可以定义一个收集函数,从监视器中提取状态;例如:
const [collect, drop] = useDrop({
accept: 'Cell',
collect: monitor => ({
canDrop: monitor.canDrop(),
hovered: monitor.isOver(),
}),
})
连接器允许您将DOM元素连接到backend中预定义角色之一(拖动源drag
、拖动预览dragPreview
或放置目标drop
)。
我们的hooks中提供了连接器函数,让我们看看如何使用它来指定放置目标:
我们使用拖拽源dragSource
来表示拖拽的元素
我们使用拖放目标dropTarget
来表示目标接收拖拽元素
在使用Vue3 DnD的时候,我们一般需要使用DndProvider
组件,如果没有特殊情况,我们可以将它放在App.vue
里边
我们可以使用useDrag
这个函数,来构建一个拖拽组件。
dragPreview
dragSource
可以看到,简单的几行代码,我们构建了一个拖拽的元素,它平时展示dragSource
,而一旦开始拖拽,它就会展示dragPreview
。
我们可以使用useDrop
这个函数,来构建一个拖放组件。
Drop Target
上边的代码,帮助我们构建了一个拖放组件,它只会对type
为BOX
的拖拽元素产生反应。
我们都知道,在拖拽的过程中,浏览器会给我们提供一个元素的快照,但是我们如果想自己操作这个快照该怎么办呢?这个时候就可以使用useDragLayer
这个函数
dragLayer
上边的例子,就会让你在拖拽的过程中,展示一个dragLayer
元素,一般我们会结合useDrag
的dragPreview
连接器进行使用。
俗话说的好,有图有真相,没有实际的效果,怎么能知道它的强大呢?
当然,它还可以实现更多,这里就不再一一展示了。
别看它叫vue3-dnd,它同样也可以支持vue2,在vue2中只需要稍微更改一下使用方式即可。
{{ name }}
为什么不叫vue dnd呢?当然是因为有人已经提前占用了这个包名~
同时我们还希望继续在vue3-dnd的上层提供一些易用性更高的组件,欢迎大家一起参与,敬请期待。