\n \n
\n\n \n off
\n \n\n {% block main %}{% endblock %}\n
\n ![\"\"](\"https://user-images.githubusercontent.com/643944/35602291-99e2c56e-0605-11e8-847f-95f1f6be1610.jpg\")
\n\n\n\n# Development\n\n**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.\n\n**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.\n\n---\n\nGet complete control over drag and drop behaviour with Draggable! Draggable abstracts\nnative browser events into a comprehensive API to create a custom drag and drop experience.\n`Draggable` comes with additional modules: `Sortable`, `Droppable`, `Swappable`. Draggable\nitself does not perform any sorting behaviour while dragging, but does the heavy lifting, e.g.\ncreates mirror, emits events, manages sensor events, makes elements draggable.\n\nThe additional modules are built on top of `Draggable` and therefore provide a similar API\ninterface, for more information read the documentation below.\n\n**Features**\n\n- Works with native drag, mouse, touch and force touch events\n- Can extend dragging behaviour by hooking into draggables event life cycle\n- Can extend drag detection by adding sensors to draggable\n- The library is targeted ES6 first\n\n## Table of Contents\n\n- [Install](#install)\n- [Documentation](#documentation)\n- [Contributing](#contributing)\n- [Roadmap](#roadmap)\n- [Copyright](#copyright)\n\n## Install\n\nYou can install the library via npm.\n\n```bash\nnpm install @shopify/draggable --save\n```\n\nor via yarn:\n\n```bash\nyarn add @shopify/draggable\n```\n\nor via CDN\n\n```html\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n```\n\n## Browser Compatibility\n\nCheck the \"browserlist\" property in [package.json](https://github.com/Shopify/draggable/blob/main/package.json#L88) for more info\n\n|  |  |  |  |  |\n| ---------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |\n| Last 3 versions ✔ | Last 3 versions ✔ | Last 3 versions ✔ | Last 3 versions ✔ | Last 3 versions ✔ |\n\n## Documentation\n\nYou can find the documentation for each module within their respective directories.\n\n- [Draggable](src/Draggable)\n - [DragEvent](src/Draggable/DragEvent)\n - [DraggableEvent](src/Draggable/DraggableEvent)\n - [Plugins](src/Draggable/Plugins)\n - [Announcement](src/Draggable/Plugins/Announcement)\n - [Focusable](src/Draggable/Plugins/Focusable)\n - [Mirror](src/Draggable/Plugins/Mirror)\n - [MirrorEvent](src/Draggable/Plugins/Mirror/MirrorEvent)\n - [Scrollable](src/Draggable/Plugins/Scrollable)\n - [Sensors](src/Draggable/Sensors)\n - [DragSensor](src/Draggable/Sensors/DragSensor)\n - [ForceTouchSensor](src/Draggable/Sensors/ForceTouchSensor)\n - [MouseSensor](src/Draggable/Sensors/MouseSensor)\n - [Sensor](src/Draggable/Sensors/Sensor)\n - [SensorEvent](src/Draggable/Sensors/SensorEvent)\n - [TouchSensor](src/Draggable/Sensors/TouchSensor)\n- [Droppable](src/Droppable)\n - [DroppableEvent](src/Droppable/DroppableEvent)\n- [Plugins](src/Plugins)\n - [Collidable](src/Plugins/Collidable)\n - [ResizeMirror](src/Plugins/ResizeMirror)\n - [Snappable](src/Plugins/Snappable)\n - [SwapAnimation](src/Plugins/SwapAnimation)\n - [SortAnimation](src/Plugins/SortAnimation)\n- [Sortable](src/Sortable)\n - [SortableEvent](src/Sortable/SortableEvent)\n- [Swappable](src/Swappable)\n - [SwappableEvent](src/Swappable/SwappableEvent)\n\n### TypeScript\n\nDraggable includes [TypeScript](http://typescriptlang.org) definitions.\n\n[Documentation](doc/typescript.md)\n\n## Running examples\n\nTo run the `examples` project locally, simply run the following from the `draggable` root:\n\n```bash\nyarn && yarn start\n```\n\nThis will start a server that hosts the contents of `examples/`. It also watches for file\nchanges from both `src/` and `examples/src` and reloads the browser.\n\n## Contributing\n\nContributions are more than welcome, the code base is still new and needs more love.\n\nFor more information, please checkout the [contributing document](https://github.com/Shopify/draggable/blob/main/CONTRIBUTING.md).\n\n## Related resources\n\n- [Ember CLI Shim](https://github.com/timrourke/ember-cli-shopify-draggable-shim) on Github by [@timrourke](https://github.com/timrourke)\n- [Ember CLI Shim](https://www.npmjs.com/package/ember-cli-shopify-draggable-shim) on NPM by [@timrourke](https://github.com/timrourke)\n\n## Copyright\n\nCopyright (c) 2018-present Shopify. See LICENSE.md for further details.\n"
},
{
"path": "babel.config.js",
"content": "module.exports = function (api) {\n api.cache(true);\n\n return {\n presets: [\n [\n '@babel/preset-env',\n {useBuiltIns: 'entry', corejs: '3.0', bugfixes: true},\n ],\n ['@babel/preset-typescript'],\n ],\n plugins: [['@babel/plugin-proposal-decorators', {version: '2023-05'}]],\n assumptions: {\n setPublicClassFields: true,\n privateFieldsAsProperties: true,\n // nothing accesses `document.all`:\n noDocumentAll: true,\n // nothing relies on class constructors invoked without `new` throwing:\n noClassCalls: true,\n // nothing should be relying on tagged template strings being frozen:\n mutableTemplateObject: true,\n // nothing is relying on Function.prototype.length:\n ignoreFunctionLength: true,\n // nothing is relying on mutable re-exported bindings:\n constantReexports: true,\n // don't bother marking Module records non-enumerable:\n enumerableModuleMeta: true,\n // nothing uses [[Symbol.toPrimitive]]:\n // (see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toPrimitive)\n ignoreToPrimitiveHint: true,\n // nothing relies on spread copying Symbol keys: ({...{ [Symbol()]: 1 }})\n objectRestNoSymbols: true,\n // nothing relies on `new (() => {})` throwing:\n noNewArrows: true,\n // transpile object spread to assignment instead of defineProperty():\n setSpreadProperties: true,\n // nothing should be using custom iterator protocol:\n skipForOfIteratorClosing: true,\n // nothing inherits from a constructor function with explicit return value:\n superIsCallableConstructor: true,\n // nothing relies on CJS-transpiled namespace imports having all properties prior to module execution completing:\n noIncompleteNsImportDetection: true,\n },\n };\n};\n"
},
{
"path": "config/typescript/rollup-plugin-includepaths.d.ts",
"content": "declare module 'rollup-plugin-includepaths' {\n interface Options {\n include: {[key: string]: string};\n paths: string[];\n extensions: string[];\n }\n export = includePaths;\n function includePaths(object: Options);\n}\n"
},
{
"path": "doc/typescript.md",
"content": "# Default usage\n\n```typescript\nimport {Sortable} from '@shopify/draggable';\n\nconst sortable = new Sortable(document.querySelectorAll('ul'), {\n draggable: 'li',\n});\n\n// The type of the first argument is SortableEventNames\nsortable.on('sortable:sort', (evt) => {\n // The type of evt is SortableSortEvent\n});\n\n// The type of the first argument is SortableEventNames\nsortable.on('drag:out:container', (evt) => {\n // The type of evt is DragOutContainerEvent\n});\n```\n\n# Using plugins\n\nWhen creating an instance with plugins with events, you need to manually specify the event names.\n\n```typescript\nimport {Droppable, Plugins} from '@shopify/draggable';\n\n// 1. import the event names you need\nimport type {\n DroppableEventNames,\n CollidableEventNames,\n} from \"@shopify/draggable\";\n\n// 2. Specify the event names when create the instance\nconst droppable = new Droppableoff
\n \n3 item capacity
\n