A drag and drop module for angularjs
JavaScript HTML CSS
Latest commit 99e649f Feb 14, 2016 @lorenzofox3 Merge pull request #10 from lloy0076/patch-1
Add Punctuation; Idiomatic English

readme.md

Build Status

lrDragNDrop

lrDragNDrop is a drag and drop module for Angularjs which allows to drag items from one collection and drop to another one; or reorder the items within the same collection.

It is "item oriented" which implies:

  • the directives must be used with the standard ngRepeat directive
  • "adorners" can be added
  • works only with non empty collections
  • you may want to have a look at angular-dragon-drop if you don't need this "item oriented" approach.

It is about 150 lines of code and has no dependency to third party library (except the framework itself).

See demo.

Getting Started

Add the module to your application using standard angularjs module management:

angular.module('myApp',['lrDragNDrop']);

Drag Source Directives

Add one the two following source directives to a repeated items collection to make a collection become a drag source:

<ul>
    <li ng-repeat="item in collection" lr-drag-src="anyNamespace">{{item}}</li>
</ul>

The model associated to the dragged item will be removed from the collection once it is dropped into a drop target with the same namespace (see below):

<ul>
    <li ng-repeat="item in collection" lr-drag-src-safe="anyNamespace">{{item}}</li>
</ul>

The model associated will not be removed from the source collection and a copy of the reference will be added to the target collection.

Note: if you don't specify a namespace, a "global" namespace will be assumed.

Drop Target Directive

<ul>
    <li ng-repeat="item in targetCollection" lr-drop-target="anyNamespace">{{item}}</li>
</ul>

The targetCollection will be able to get all the dragged items if there were taken from a source with the same namespace.

Note a target can be its own source (if you want to use drag and drop to reorder the items).

Drop Success Callback

<ul>
    <li ng-repeat="item in targetCollection" lr-drop-success="dropSuccess(e, item, collection)">{{item}}</li>
</ul>

Registers custom callback function that will be called after item will be dropped. Has to be used with lr-drop-target toghether.

Adorners

When a source item is dragged over a target element and if they share the same namespace a class name is added to the target element following this rule:

  • lr-drop-target-before, if the cursor position is above the diagonal going from the bottom left corner to the top right corner of the target element
  • lr-drop-target-after,if the cursor position is below the diagonal going from the bottom left corner to the top right corner of the target element

Note you can modify the source code quite easily to have something more elaborated to take the collection orientation into account.

Empty Collection

The directives are associated with the item elements and not with the collection container element. So if there is no element yet in the target collection you won't be able to use the drop target feature. However you can easily attach your own directive base on the lrDragStore service to the container element to support the drop for empty target collection.

Performance Tips

<ul>
    <li ng-repeat="item in targetCollection" lr-drag-data="targetCollection">{{item}}</li>
</ul>

If you have rather big collection than please use lr-drag-data attribute together with ng-repeat. This will internally prevent parsing ng-repeat block and execution of $eval.

Licence

lrDragNDrop module is under MIT license:

Copyright (C) 2013 Laurent Renard.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.