Demo

Try out the demo!

Install

You can get it on npm.

npm install angular-dragula --save

Or bower, too. _{(note that it's called angular-dragula.js in bower)}

bower install angular-dragula.js --save

Setup

You'll need to pass in angularDragula to your module when booting up your application. angular-dragula takes your angular instance and uses it to register its own module, service, and directive.

var angular = require('angular');
var angularDragula = require('angular-dragula');

var app = angular.module('my-app', [angularDragula(angular)]);

Usage

This package isn't very different from dragula itself. I'll mark the differences here, but please refer to the documentation for dragula if you need to learn more about dragula itself.

Directive

There's a dragula directive (as seen in the demo) that allows you to group containers together, as long as they belong to the same scope. That grouping of containers is called a bag.

<div dragula='"bag-one"'></div>
<div dragula='"bag-one"'></div>
<div dragula='"bag-two"'></div>

If you need to configure the drake (there's only one drake per bag), you'll have to use the dragulaService.

app.controller('ExampleCtrl', ['$scope', 'dragulaService',
  function ($scope, dragulaService) {
    dragulaService.options($scope, 'third-bag', {
      removeOnSpill: true
    });
  }
]);

Events

Whenever a drake instance created with the dragula directive emits an event, that event is replicated on the Angular $scope where the drake has an associated bag, and prefixed with the name on its bag.

<div dragula='"evented-bag"'></div>

app.controller('ExampleCtrl', ['$scope', function ($scope) {
  $scope
    .$on('evented-bag.over', function (e, el) {
      el.addClass('over');
    })
    .$on('evented-bag.out', function (e, el) {
      el.removeClass('over');
    });
]);

Note that these derived events don't expose the DOM elements directly. The elements get wrapped in angular.element calls.

`dragulaService`

This service exposes a few different methods with which you can interact with dragula in the Angular way.

`dragulaService.add(scope, name, drake)`

Creates a bag scoped under scope and identified by name. You should provide the entire drake instance. Typically, the directive takes care of this step.

`dragulaService.options(scope, name, options)`

Sets the options used to instantiate a drake. Refer to the documentation for dragula to learn more about the options themselves.

`dragulaService.find(scope, name)`

Returns the bag for a drake instance. Contains the following properties.

name is the name that identifies the bag under scope
drake is the raw drake instance itself

`dragulaService.destroy(scope, name)`

Destroys a drake instance named name scoped under scope.

License

MIT

ololo-psh / angular-dragula