Angular ng-sortable - Basic example of how it works

20,319

Solution 1

Minimal ng-sortable Setup (No need for bower. Bower is confusion for semis like me, too.).

This is the minimum setup to get a full sortable Array with ng-sortable, that worked for me.

Load necessary Javascripts

  1. Load angular.js

  2. Load ng-sortable.js (Find this in dist folder in downloaded .zip file https://github.com/a5hik/ng-sortable)

  3. Load your app.js
  4. Load the as.sortable into your app var app = angular.module('app', ['ngRoute', 'as.sortable']);

  5. Load your AppController.js

Load necessary Stylesheets

(Find both in dist folder in downloaded .zip file https://github.com/a5hik/ng-sortable)

  1. Load ng-sortable.css
  2. Load ng-sortable.style.css

  3. Create ul with necessary attributes ( data-as-sortable data-ng-model="sortableList" )

  4. Add data-as-sortable-item to li

  5. Insert div with data-as-sortable-item-handle into li

<!DOCTYPE html>
<html>
    <head>
        <title>NG-Sortable</title>
        <script type="text/javascript" src="js/angular/angular.js"></script>
        <script type="text/javascript" src="js/sortable/ng-sortable.js"></script>
        <script type="text/javascript" src="js/app.js"></script>
        <script type="text/javascript" src="js/AppController.js"></script>

        <link rel="stylesheet" type="text/css" href="css/ng-sortable.css">
        <link rel="stylesheet" type="text/css" href="css/ng-sortable.style.css">
    </head>
    <body ng-app="app" ng-controller="AppController">
        <ul data-as-sortable data-ng-model="sortableList">
            <li ng-repeat="item in sortableList" data-as-sortable-item>
                <div data-as-sortable-item-handle>
                    index: {{$index}} | id: {{item.id}} | title: {{item.title}}
                </div>
            </li>
        </ul>
    </body>
</html>
// app.js (Your file)
var app = angular.module('app', ['ngRoute', 'as.sortable']);
// AppController.js (Your file)
app.controller('AppController', [
    '$scope',
    function ( $scope) {


        $scope.sortableList = [
            {
                id : "id-000",
                title : "item 000"
            },
            {
                id : "id-001",
                title : "item 001"
            },
            {
                id : "id-002",
                title : "item 002"
            }

        ];

    }
]);

Solution 2

It would help if we knew what you mean by "setting it up" (whether you mean actually adding it to the project, or how to use it). It would also help if we knew what stack, if any, you were installing this on.

To Install
The install instructions are under the "Usage" section of their Git page.

  1. Run bower install ng-sortable or bower install ng-sortable -save if you're using yeoman
  2. Add the paths to ng-sortable.min.js,ng-sortable.min.css, and ng-sortable.style.min.css to your project, where you add these is dependent on what stack you're using.
  3. Add ui.sortable as a dependency to your app or module. Again, where this goes is dependent on your stack.

To Use

<ul data-as-sortable data-ng-model="array">
    <li ng-repeat="item in array" data-as-sortable-item>
        <div data-as-sortable-item-handle>
             {{item.data}}
        </div>
    </li>
</ul>

Where "array" is the array of items you're sorting. This will work out of the box, but if you need custom logic, change data-as-sortable to data-as-sortable="CustomLogic" Where "CustomLogic" is a method in your controller that overrides the default behavior. For more details on how to add custom logic check their Git page under the section "Callbacks" and "Usage".

Share:
20,319
FrancescoMussi
Author by

FrancescoMussi

Full-stack developer based in Riga, Latvia. Hope Socrates is proud of my Socratic badge on StackOverflow.

Updated on April 15, 2020

Comments

  • FrancescoMussi
    FrancescoMussi about 4 years

    SITUATION:

    Hello guys! In my app i have a sort of kanban: there are some columns, each containing a list of items.

    I need to drag and drop items among columns and reorder them inside the same column.

    I have tried before three angular modules related with drag and drop (first two) and reordering (third):

    ngDraggable: https://github.com/fatlinesofcode/ngDraggable

    Angular dragdrop: https://github.com/codef0rmer/angular-dragdrop

    Angular ui-sortable: https://github.com/angular-ui/ui-sortable

    They are nice, with good documentation, but it seems not possible to drag and drop and reorder at the same time. Then i found another module:

    ng-sortable: https://github.com/a5hik/ng-sortable

    It seems to be exactly what i need. But the documentation is not so clear. I am not able to understand how to set it up.


    QUESTION:

    Can you show me please how to set it up? There is a plunker with a good and clear example?

    Thank you!

  • Marcus
    Marcus over 8 years
    Is it possible to omit the ng-repeat and simply have x number of unique elements sortable?
  • Spenhouet
    Spenhouet about 8 years
    Good example but sadly it doesn't work for me. I used ng-sortable 1.3.2 and angular 1.5.0 and belief to have everything as you described.
  • Lilith Daemon
    Lilith Daemon about 8 years
    Please try and refrain from answering using only a link. While a link can often be a part of a good answer, you should contain all relevant information within your post.
  • Aerus
    Aerus over 7 years
    This works for me, angular 1.5.6 and ng-sortable 1.3.6.
  • Tim Aagaard
    Tim Aagaard over 7 years
    @Marcus yes, you can manually output what ng-repeat is doing, or better yet, keep using ng-repeat and just pass in an array comprised of only the items you want sortable
  • benjaminhull
    benjaminhull over 5 years
    Not sure why the downvotes here - perfectly good example of how to use the package, as requested in the question.