Skip to content

Latest commit

 

History

History
112 lines (93 loc) · 4.46 KB

README.md

File metadata and controls

112 lines (93 loc) · 4.46 KB
Raw

myste1tainn / ngDraggable

ngDraggable is a drag-and-drop module for AngularJS capable of creating draggable-objects and drop-target on the fly. ngDraggable also support Non-HTML5 dragging More information on this will be on soon.

See myste1tainn/ngDraggable in action

Installation

  • Install with bower $ bower install myste1tainn/ngDraggable
  • Add ngDraggable as dependencies e.g. angular.module('myApp', ['ngDraggable'])

Composition

The module comprises of 2 controllers and 1 service namely: draggableObject, dropTarget, and $drag. Mostly, you'll be interacting with the service

Usage

  • For an element to be draggable, add draggable-object attribute.
  • For an element to be a drop target, add drop-target attribute.
<!-- This is drag-and-drop without data transferring -->
<div draggable-object>Drag Me!</div>
<div drop-target>Drop Here</div>
<!-- This is drag-and-drop with data transferring -->
<!-- This would mean you drag fruit and drop it into baskets -->
<div ng-repreat="basket in someCtrl.baskets">
	<div ng-repeat="fruit in basket.fruits" drop-target drop-model="basket.fruits">
		<div draggable-object drag-data="fruit" drag-model="basket.fruits">
			{{ fruit.name }}
		</div>
	</div>
</div>

Getting Controllers

You can access the controllers by using the $drag through service injection $drag.$getDraggedObject() and $drag.$getDropTarget() The return object will be currently-dragged-object and currently-dragovered-target respectively, otherwise they will be null.

.controller('myController', function($scope, $element, $attrs, $drag){
	var draggedObject = $drag.$getDraggedObject();
	var dropTarget = $drag.$getDropTarget();
})

Events

In myste1tainn/ngDraggable, you can listen to events on both the service and controllers If you only need to know the presence/absence of draggleObjects/dropTarget, then using $drag's events should be enough. To attach events listner do $drag.on('object.event', callback), to detach use .un instead.

Events on $drag

Event Name Description
draggable.get Any draggable-object is dragged.
draggable.lost Any draggable-object is drop.
droptarget.get Any draggable-object is dragged into any droptarget.
droptarget.lost Any draggable-object is dragged out of any droptarget.
droptarget.over Any draggable-object is dragged over any droptarget.

Events on draggedObject (Controller)

Event Name Description
dragstart The draggable-object is started being dragged.
drag The draggable-object is dragged around.
dragend The draggable-object is dropped.

Events on dropTarget (Controller)

Event Name Description
dragenter A draggable-object is dragged into the drop-target.
dragover A draggable-object is dragged over the drop-target.
dragleave A draggable-object is dragged out of the drop-target.

Features

  • Drag-and-Drop w/ or w/o data (Automatically transfer, if any)
  • Flexible drop-target specifying
  • Flexible draggable-object specifying

Coming Soon

  • Drag-and-Drop cross controller data transfer
  • Drag-and-Drop Reordering
  • Drag-and-Drop Animation
  • Support for HTML events listner attaching

License

The MIT License (MIT)

Copyright (c) 2015 Arnon Keereena

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.