GitHub - angular-ui/ui-sortable at v0.10.x-stable (original) (raw)

UI.Sortable directive

This directive allows you to sort array with drag & drop.

Requirements

• JQuery
• JQueryUI
• AngularJS 1.0.x

Note for AngularJS 1.2 users: Use the separate branch angular1.2.

Usage

Load the script file: sortable.js in your application:

Add the sortable module as a dependency to your application module:

var myAppModule = angular.module('MyApp', ['ui.sortable'])

Apply the directive to your form elements:

• {{ item }}

Developing Notes:

• ng-model is required, so that the directive knows which model to update.
• ui-sortable element should only contain one ng-repeat and not any other elements (above or below).
  Otherwise the index matching of the generated DOM elements and the ng-model's items will break.
• ui-sortable lists containing many 'types' of items can be implemented by using dynamic template loading with ng-include, to determine how each model item should be rendered.

Options

All the jQueryUI Sortable options can be passed through the directive.

myAppModule.controller('MyController', function($scope) { $scope.items = ["One", "Two", "Three"];

$scope.sortableOptions = { update: function(e, ui) { ... }, axis: 'x' }; });

• {{ item }}

Canceling

Inside the update callback, you can check the item that is dragged and cancel the sorting.

$scope.sortableOptions = { update: function(e, ui) { if (ui.item.scope().item == "can't be moved") { ui.item.parent().sortable('cancel'); } } };

Note: update occurs before any model/scope changes but after the DOM position has been updated. So ui.item.scope and the directive's ng-model, are equal to the scope before the drag start.

Reporting Issues

The following pen's are provided as a good starting point to demonstrate issues, proposals and use cases. Feel free to edit any of them for your needs (don't forget to also update the libraries used to your version).

• Simple Demo
• Connected Lists

Testing

We use Karma and jshint to ensure the quality of the code. The easiest way to run these checks is to use grunt:

npm install -g grunt-cli npm install && bower install grunt

The karma task will try to open Firefox and Chrome as browser in which to run the tests. Make sure this is available or change the configuration in test\karma.conf.js

Grunt Serve

We have one task to serve them all !

It's equal to run separately:

• grunt connect:server : giving you a development server at http://127.0.0.1:8000/.
• grunt karma:server : giving you a Karma server to run tests (at http://localhost:9876/ by default). You can force a test on this server with grunt karma:unit:run.
• grunt watch : will automatically test your code and build your demo. You can demo generation with grunt build:gh-pages.