README

sortera

Sortera is a standalone, minimalistic yet powerful, javascript library that makes any HTML-table interactively sortable.

Highligts

Small footprint
Highly optimized code
Not relying on any third party libraries of any kind
Multi column sorting
Adapts to the application, supporting the following techiques
- Stand-alone usage
- Registers itself as a jQuery-plugin if jQuery is present
- AMD export (Dojo Toolkit, RequireJS, ScriptManJS)
- CommonJS-style export

Sortera works by attaching events to the table headers of an existing table, hence your table need to have a html <thead> </thead> section, or <th> instead of <td> for column headers. See example tables to the rights.

For full documentation, see hexagon.github.io/sortera

Examples

Standalone usage

// Example usage.
var element = document.getElementById('#thetable');

sortera(theTable, {
  sortOrder:    [           // sortOrder        Array of columns to sort
    {col: 1, order: 1}      // sortOrder.col    Zero indexed column index
                            // sortOrder.order  1 = Ascending, -1 = Descending
  ],    
  multi:        true,
  ignore:       [5,2]
});

For a full implementation and demo, see hexagon.github.io/sortera/examples/usage.standalone.html

As jQuery plugin

// Example usage, jQuery plugin mode.
$('#thetable').sortera({
  sortOrder:    [           // sortOrder        Array of columns to sort
    {col: 1, order: 1}      // sortOrder.col    Zero indexed column index
                            // sortOrder.order  1 = Ascending, -1 = Descending
  ],    
  multi:        true,
  ignore:       [5,2]
});

For a full implementation and demo, see hexagon.github.io/sortera/examples/usage.jquery.html

Installation

cdn

Copy and paste one of the following script tags.

Minified

<script src="//cdn.56k.guru/js/sortera/latest/sortera.min.js"></script>

Full

<script src="//cdn.56k.guru/js/sortera/latest/sortera.js"></script>

Manual

Download latest zipball
Unpack
Grab sortera.js (or sortera.min.js) from the lib/ folder

Bower

bower install sortera

npm

npm install sortera

License

MIT

( Just use it, I really don't care what you do with it. )

Usage no npm install needed!