Currently in beta! While Draggable is very close to a full release, the API is still subject to change. We keep an updated CHANGELOG with every release, so when upgrading from a previous version, please check and see what has changed.
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:
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.
- 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
You can install the library via npm.
npm install @shopify/draggable --save
or via yarn:
yarn add @shopify/draggable
or via CDN
<!-- Entire bundle --> <script src="https://cdn.jsdelivr.net/npm/@firstname.lastname@example.org/lib/draggable.bundle.js"></script> <!-- legacy bundle for older browsers (IE11) --> <script src="https://cdn.jsdelivr.net/npm/@email@example.com/lib/draggable.bundle.legacy.js"></script> <!-- Draggable only --> <script src="https://cdn.jsdelivr.net/npm/@firstname.lastname@example.org/lib/draggable.js"></script> <!-- Sortable only --> <script src="https://cdn.jsdelivr.net/npm/@email@example.com/lib/sortable.js"></script> <!-- Droppable only --> <script src="https://cdn.jsdelivr.net/npm/@firstname.lastname@example.org/lib/droppable.js"></script> <!-- Swappable only --> <script src="https://cdn.jsdelivr.net/npm/@email@example.com/lib/swappable.js"></script> <!-- Plugins only --> <script src="https://cdn.jsdelivr.net/npm/@firstname.lastname@example.org/lib/plugins.js"></script>
|Latest ✔||Latest ✔||11+ ✔||Latest ✔||Latest ✔||Latest ✔|
|Package name||ES6 bundle sizes||ES5 bundle sizes|
You can find the documentation for each module within their respective directories.
To run the
examples project locally, simply run the following from the
yarn && yarn start
This will start a server that hosts the contents of
examples/. It also watches for file
changes from both
examples/src and reloads the browser.
Contributions are more than welcome, the code base is still new and needs more love.
For more information, please checkout the contributing document.
We are currently working on
v1.0.0-beta.7. Check out the project board to see tasks and follow progress on the release. Any Pull Requests should be pointed against the feature branch
Copyright (c) 2018 Shopify. See LICENSE.md for further details.