Drag and drop so simple it hurts
JavaScript HTML CSS
Clone or download
Pull request Compare This branch is 1 commit ahead, 330 commits behind bevacqua:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
dist
example
resources
.editorconfig
.gitignore
.jshintignore
.jshintrc
bower.json
changelog.markdown
dragula.js
dragula.styl
index.html
license
package.json
readme.markdown

readme.markdown

Dragula

Drag and drop so simple it hurts

Browser support includes every sane browser and IE7+.

Demo

demo.png

Inspiration

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!

Features

  • 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

Install

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

Usage

Dragula provides the easiest possible API to make drag and drop a breeze in your applications.

dragula(containers, options?)

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, it'll be sent back to the container it was originally taken from.

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.

options.accepts

You can set accepts to a method with the following signature: (el, target, source). It'll be called to make sure that an element el, that came from container source, can be dropped on container target. Note that if options.copy is set to true, el will be set to the copy, instead of the originally dragged element.

options.copy

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

options.revertOnSpill

By default, spilling an element outside of any containers will move the element back to it's last known stable parent. 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 last known stable parent.

options.removeOnSpill

By default, spilling an element outside of any containers will move the element back to it's last known stable parent. 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.

options.direction

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.

API

The dragula method returns a tiny object with a concise API. We'll refer to the API returned by dragula as drake.

drake.cancel(revert)

If an element managed by drake is currently being dragged, this method will gracefully cancel the drag action. Note that a cancellation may still result in a drop event if the last known position was a container other than the source and revertOnSpill isn't true. You can also pass in revert at the method invocation level.

drake.remove()

If an element managed by drake is currently being dragged, this method will gracefully remove it from the DOM.

drake.on (Events)

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 el was dropped into container
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

drake.destroy()

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.

License

MIT