Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shopify/draggable
The JavaScript Drag & Drop library your grandparents warned you about.
https://github.com/shopify/draggable
drag-and-drop draggable es6 javascript
Last synced: 6 days ago
JSON representation
The JavaScript Drag & Drop library your grandparents warned you about.
- Host: GitHub
- URL: https://github.com/shopify/draggable
- Owner: Shopify
- License: mit
- Created: 2017-09-27T15:31:23.000Z (about 7 years ago)
- Default Branch: main
- Last Pushed: 2024-06-26T19:13:17.000Z (6 months ago)
- Last Synced: 2024-12-16T11:12:53.268Z (6 days ago)
- Topics: drag-and-drop, draggable, es6, javascript
- Language: JavaScript
- Homepage: https://shopify.github.io/draggable
- Size: 6.17 MB
- Stars: 18,056
- Watchers: 617
- Forks: 1,087
- Open Issues: 147
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Authors: AUTHORS
Awesome Lists containing this project
README
[](https://www.npmjs.com/package/@shopify/draggable) [](https://github.com/Shopify/draggable/actions?query=branch%3Amain) [](https://github.com/Shopify/draggable/blob/main/CONTRIBUTING.md) 
# 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 `max.hoffmann (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](#install)
- [Documentation](#documentation)
- [Contributing](#contributing)
- [Roadmap](#roadmap)
- [Copyright](#copyright)
## Install
You can install the library via npm.
```bash
npm install @shopify/draggable --save
```
or via yarn:
```bash
yarn add @shopify/draggable
```
or via CDN
```html
import {
Draggable,
Sortable,
Droppable,
Swappable,
} from 'https://cdn.jsdelivr.net/npm/@shopify/draggable/build/esm/index.mjs';
import Draggable from 'https://cdn.jsdelivr.net/npm/@shopify/draggable/build/esm/Draggable/Draggable.mjs';
import Sortable from 'https://cdn.jsdelivr.net/npm/@shopify/draggable/build/esm/Sortable/Sortable.mjs';
import Droppable from 'https://cdn.jsdelivr.net/npm/@shopify/draggable/build/esm/Droppable/Droppable.mjs';
import Swappable from 'https://cdn.jsdelivr.net/npm/@shopify/draggable/build/esm/Swappable/Swappable.mjs';
import * as Plugins from 'https://cdn.jsdelivr.net/npm/@shopify/draggable/build/esm/Plugins/index.mjs';
console.log(window.Draggable);
```
## Browser Compatibility
Check the "browserlist" property in [package.json](https://github.com/Shopify/draggable/blob/main/package.json#L88) for more info
|  |  |  |  |  |
| ---------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| Last 3 versions ✔ | Last 3 versions ✔ | Last 3 versions ✔ | Last 3 versions ✔ | Last 3 versions ✔ |
## Documentation
You can find the documentation for each module within their respective directories.
- [Draggable](src/Draggable)
- [DragEvent](src/Draggable/DragEvent)
- [DraggableEvent](src/Draggable/DraggableEvent)
- [Plugins](src/Draggable/Plugins)
- [Announcement](src/Draggable/Plugins/Announcement)
- [Focusable](src/Draggable/Plugins/Focusable)
- [Mirror](src/Draggable/Plugins/Mirror)
- [MirrorEvent](src/Draggable/Plugins/Mirror/MirrorEvent)
- [Scrollable](src/Draggable/Plugins/Scrollable)
- [Sensors](src/Draggable/Sensors)
- [DragSensor](src/Draggable/Sensors/DragSensor)
- [ForceTouchSensor](src/Draggable/Sensors/ForceTouchSensor)
- [MouseSensor](src/Draggable/Sensors/MouseSensor)
- [Sensor](src/Draggable/Sensors/Sensor)
- [SensorEvent](src/Draggable/Sensors/SensorEvent)
- [TouchSensor](src/Draggable/Sensors/TouchSensor)
- [Droppable](src/Droppable)
- [DroppableEvent](src/Droppable/DroppableEvent)
- [Plugins](src/Plugins)
- [Collidable](src/Plugins/Collidable)
- [ResizeMirror](src/Plugins/ResizeMirror)
- [Snappable](src/Plugins/Snappable)
- [SwapAnimation](src/Plugins/SwapAnimation)
- [SortAnimation](src/Plugins/SortAnimation)
- [Sortable](src/Sortable)
- [SortableEvent](src/Sortable/SortableEvent)
- [Swappable](src/Swappable)
- [SwappableEvent](src/Swappable/SwappableEvent)
### TypeScript
Draggable includes [TypeScript](http://typescriptlang.org) definitions.
[Documentation](doc/typescript.md)
## Running examples
To run the `examples` project locally, simply run the following from the `draggable` root:
```bash
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](https://github.com/Shopify/draggable/blob/main/CONTRIBUTING.md).
## Related resources
- [Ember CLI Shim](https://github.com/timrourke/ember-cli-shopify-draggable-shim) on Github by [@timrourke](https://github.com/timrourke)
- [Ember CLI Shim](https://www.npmjs.com/package/ember-cli-shopify-draggable-shim) on NPM by [@timrourke](https://github.com/timrourke)
## Copyright
Copyright (c) 2018-present Shopify. See LICENSE.md for further details.