Drag and drop so simple it hurts
Browser support includes every sane browser and IE7+.
Have you ever wanted a drag and drop library that just works? That doesn't just depend on bloated frameworks, that has great support? That actually understands where to place the elements when they are dropped? That doesn't need you to do a zillion things to get it to work? Well, so did I!
- Super easy to set up
- No bloated dependencies
- Figures out sort order on its own
- A shadow where the item would be dropped offers visual feedback
- Touch events!
You can get it on npm.
npm install dragula --save
Or bower, too. (note that it's called dragula.js
in bower)
bower install dragula.js --save
Dragula provides the easiest possible API to make drag and drop a breeze in your applications.
By default, dragula
will allow the user to drag an element in any of the containers
and drop it in any other container in the list. If the element is dropped anywhere that's not one of the containers
, the event will be gracefully cancelled according to the revertOnSpill
and removeOnSpill
options.
Note that dragging is only triggered on left clicks, and only if no meta keys are pressed. Clicks on buttons and anchor tags are ignored, too.
The example below allows the user to drag elements from left
into right
, and from right
into left
.
dragula([left, right]);
You can also provide an options
object. The options are detailed below.
You can define a moves
method which will be invoked with (el, container)
whenever an element is clicked. If this method returns false
, a drag event won't begin, and the event won't be prevented either.
You can set accepts
to a method with the following signature: (el, target, source, sibling)
. It'll be called to make sure that an element el
, that came from container source
, can be dropped on container target
before a sibling
element. The sibling
can be null
, which would mean that the element would be placed as the last element in the container. Note that if options.copy
is set to true
, el
will be set to the copy, instead of the originally dragged element.
If copy
is set to true
, items will be copied rather than moved. This implies the following differences:
Event | Move | Copy |
---|---|---|
drag |
Element will be concealed from source |
Nothing happens |
drop |
Element will be moved into target |
Element will be cloned into target |
remove |
Element will be removed from DOM | Nothing happens |
cancel |
Element will stay in source |
Nothing happens |
By default, spilling an element outside of any containers will move the element back to the drop position previewed by the feedback shadow. Setting revertOnSpill
to true
will ensure elements dropped outside of any approved containers are moved back to the source element where the drag event began, rather than stay at the drop position previewed by the feedback shadow.
By default, spilling an element outside of any containers will move the element back to the drop position previewed by the feedback shadow. Setting removeOnSpill
to true
will ensure elements dropped outside of any approved containers are removed from the DOM. Note that remove
events won't fire if copy
is set to true
.
When an element is dropped onto a container, it'll be placed near the point where the mouse was released. If the direction
is 'vertical'
, the default value, the Y axis will be considered. Otherwise, if the direction
is 'horizontal'
, the X axis will be considered.
The dragula
method returns a tiny object with a concise API. We'll refer to the API returned by dragula
as drake
.
Gracefully end the drag event as if using the last position marked by the preview shadow as the drop target. The proper cancel
or drop
event will be fired, depending on whether the item was dropped back where it was originally lifted from (which is essentially a no-op that's treated as a cancel
event).
If an element managed by drake
is currently being dragged, this method will gracefully cancel the drag action. You can also pass in revert
at the method invocation level, effectively producing the same result as if revertOnSpill
was true
.
Note that a "cancellation" will result in a cancel
event only in the following scenarios.
revertOnSpill
istrue
- Drop target (as previewed by the feedback shadow) is the source container and the item is dropped in the same position where it was originally dragged from
If an element managed by drake
is currently being dragged, this method will gracefully remove it from the DOM.
The drake
is an event emitter. The following events can be tracked using drake.on(type, listener)
:
Event Name | Listener Arguments | Event Description |
---|---|---|
drag |
el, container |
el was lifted from container |
drop |
el, container, source |
el was dropped into container , and originally came from source |
cancel |
el, container |
el was being dragged but it got nowhere and went back into container , it's last stable parent |
remove |
el, container |
el was being dragged but it got nowhere and it was removed from the DOM. It's last stable parent was container . |
shadow |
el, container |
el , the visual aid shadow, was moved into container . May trigger many times as the position of el changes, even within the same container |
Removes all drag and drop events used by dragula
to manage drag and drop between the containers
. If .destroy
is called while an element is being dragged, the drag will be effectively cancelled.
MIT