Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ggoodman/angular-drag-drop

Declarative drag and drop in Angular.js without any external dependencies
https://github.com/ggoodman/angular-drag-drop

Last synced: about 1 month ago
JSON representation

Declarative drag and drop in Angular.js without any external dependencies

Host: GitHub
URL: https://github.com/ggoodman/angular-drag-drop
Owner: ggoodman
License: mit
Created: 2015-01-05T20:01:25.000Z (almost 10 years ago)
Default Branch: master
Last Pushed: 2018-02-15T22:29:55.000Z (almost 7 years ago)
Last Synced: 2024-10-12T01:39:22.934Z (2 months ago)
Language: JavaScript
Size: 541 KB
Stars: 138
Watchers: 10
Forks: 46
Open Issues: 3
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

Angular drag-and-drop
=====================

[![Join the chat at https://gitter.im/ggoodman/angular-drag-drop](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/ggoodman/angular-drag-drop?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

Declarative drag and drop with zero dependencies in Angular.js

Installation
------------

Several installation options:
* npm: `npm install --save angular-drag-drop`
* Download from github: [angular-drag-drop.min.js](https://raw.github.com/ggoodman/angular-drag-drop/master/dist/angular-drag-drop.min.js)

Demo
----

[Dragular](http://bit.ly/17E25d2) - Drag tiles around like the famous
[Sliding Puzzle](http://en.wikipedia.org/wiki/Sliding_puzzle) using angular drag and drop.

Usage
-----

Using Webpack or Browserify:

```js
var Angular = require('angular');

var mod = Angular.module('yourModule', [
require('angular-drag-drop'),
]);

// Now use `drag-container`, `drop-container` and `drop-target` in your templates
```

### `drag-container`

Define a DOM element that will become draggable and determines what the data associated with the drag event is.

**Example**

```html

```

Attribute | Required? | Description
----------|-----------|------------
`drag-container` | Yes | Defines when the drag action is allowed or blocked for the draggable. Can be true or false.
`drag-data` | No | Bind the data to be associated with dragging this element. When not specified the jqLite element on which the directive is placed will be used as the $dragData.

The following callbacks are optional.
Each can allow you to inject two special objects, `$event` and `$dragData`.
`$event` is the original browser event.
This can be helpful for setting the browser-level drag data using `$event.dataTransfer.setData('mime/type', data)`)
or for setting the drag image / drop effect like `$event.dataTransfer.dropEffect = 'copy'`.
`$dragData` is the data associated with dragging this element.
It is optionally set by providing a reference via the `drag-container` attribute.

* `on-drag-start`
* `on-drag-end`

### `drop-container`

Define a DOM element that will accept draggable elements that match pass an optional acceptance callback.

**Example**

```html

```

Attribute | Required? | Description
----------|-----------|------------
`drop-accepts` | No | Define a call to check if the data being dragged is allowed

The following callbacks are optional.
Each can allow you to inject two special objects, `$event` and `$dragData`.
`$event` is the original browser event.
`$dragData` is the data associated with dragging this element.

* `on-drag-enter`
* `on-drag-over`
* `on-drag-leave`
* `on-drop`

### `drop-target`

Define a region of the parent `drop-container` that can independently accept drag and drop events in a logical region.

This module will only consider those logical regions that have `drop-targets` bound in determining which region
should receive events at any point in time. The algorithm to determine which logical region is active is based
on the proximity of the cursor to the virtual center-point of each logical region.

**Must be a child of a `drop-container`**

**Example**

```html

```

Attribute | Required? | Description
----------|-----------|------------
`drop-target` | Yes | Defines the logical region of the parent `drop-container` that will accept events. Can be one of: `center`, `top`, `top-right`, `right`, `bottom-right`, `bottom`, `bottom-left`, `left`, `top-left`

* `on-drag-enter`
* `on-drag-over`
* `on-drag-leave`
* `on-drop`

License
-------

Released under the terms of MIT License:

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.