Need help with draggable?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

Shopify
14.7K Stars 873 Forks MIT License 368 Commits 109 Opened issues

Description

The JavaScript Drag & Drop library your grandparents warned you about.

Services available

!
?

Need anything else?

Contributors list

No Data

CircleCI npm version codecov Greenkeeper badge

Development

Draggable is no longer maintained by its original authors. Maintenance of this repo has been passed on to new collaborators and is no longer worked on by anyone at Shopify.

We are still looking for more maintainers! If anyone is interested in answering / triaging issues, reviewing / rejecting / approving PRs, and authoring code for bug fixes / new features — please send an email to

curtis.dulmage (at) shopify (dot) com
. You may be asked a few questions before obtaining collaboration permission, but if everything checks out, we will happily add you as a collaborator.

Get complete control over drag and drop behaviour with Draggable! Draggable abstracts native browser events into a comprehensive API to create a custom drag and drop experience.

Draggable
comes with additional modules:
Sortable
,
Droppable
,
Swappable
. Draggable itself does not perform any sorting behaviour while dragging, but does the heavy lifting, e.g. creates mirror, emits events, manages sensor events, makes elements draggable.

The additional modules are built on top of

Draggable
and therefore provide a similar API interface, for more information read the documentation below.

Features

  • Works with native drag, mouse, touch and force touch events
  • Can extend dragging behaviour by hooking into draggables event life cycle
  • Can extend drag detection by adding sensors to draggable
  • The library is targeted ES6 first

Table of Contents

Install

You can install the library via npm.

npm install @shopify/draggable --save

or via yarn:

yarn add @shopify/draggable

or via CDN












Browser Compatibility

| Chrome | Firefox | IE | Opera | Safari | Edge | | ---------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | | Latest ✔ | Latest ✔ | 11+ ✔ | Latest ✔ | Latest ✔ | Latest ✔ |

Bundle sizes

| Package name | ES6 bundle sizes | ES5 bundle sizes | | -------------------------- | ---------------- | ---------------- | | draggable.bundle.js | ~11kb | ~19.2kb | | draggable.bundle.legacy.js | ~19.2kb | ~25.63kb | | draggable.js | ~8.06kb | ~15.36kb | | sortable.js | ~8.93kb | ~16.51kb | | swappable.js | ~8.56kb | ~16.14kb | | droppable.js | ~8.8kb | ~16.55kb | | plugins.js | ~2.37kb | ~8.76kb | | plugins/collidable.js | ~1.45kb | ~7.81kb | | plugins/snappable.js | ~1.19kb | ~6.94kb | | plugins/swap-animation.js | ~1kb | ~6.65kb |

Documentation

You can find the documentation for each module within their respective directories.

TypeScript

Draggable includes TypeScript definitions.

Documentation

Running examples

To run the

examples
project locally, simply run the following from the
draggable
root:
yarn && yarn start

This will start a server that hosts the contents of

examples/
. It also watches for file changes from both
src/
and
examples/src
and reloads the browser.

Contributing

Contributions are more than welcome, the code base is still new and needs more love.

For more information, please checkout the contributing document.

Roadmap

We are currently working on

v1.0.0-beta.12
. Check out the project board to see tasks and follow progress on the release. Any Pull Requests should be pointed against the feature branch
v1.0.0-beta.12
.

Related resources

Copyright

Copyright (c) 2018 Shopify. See LICENSE.md for further details.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.