Create a read-only sorted version of a backbone collection that stays in sync.
var sorted = originalCollection;sorted;// orsorted;// orsorted;sorted;// also chainablesorted;// or pass in the initial sort directionsorted;
- nothing or
null, resets the sorting to the same order as the superset
- a string, sorts by a model key
- a function that accepts a model and returns a value
direction must be one of:
"desc". If it's not provided it
will default to
// sort by the 'age' property descendingsorted;// equivalent to thissorted;// but we can also do arbitrary computation in the closuresorted;// Characters with accents get sorted to the end of the alphabet,// so let's sort based on the unaccented version.sorted;// Pass nothing as an option to remove all sortingsorted;
Remove all sorting. Equivalent to calling
Reverse the sort. The API is chainable, so this can be called directly
setSort if you want the sort to be descending.
If there is no current sort function then this does nothing.
// Sort by age descendingsorted;
Remove all ties to the superset and stop updating. Will now be garbage collected when it falls out of scope.
reset should fire as you expect.
sorted:add - Fired when a sort function is set
sorted:remove - Fired when a sort function is removed
`sorted:destroy' - Fired when the proxy is destroyed
Usage with Browserify
Install with npm, use with Browserify
> npm install backbone-sorted-collection
and in your code
var SortedCollection = ;
Usage with Bower
Install with Bower:
bower install backbone-sorted-collection
The component can be used as a Common JS module, an AMD module, or a global.
Usage as browser global
You can include
backbone-sorted-collection.js directly in a script tag. Make
sure that it is loaded after underscore and backbone. It's exported as
on the global object.
<script src="underscore.js"></script><script src="backbone.js"></script><script src="backbone-sorted-collection.js"></script>
Install Node (comes with npm) and Bower.
From the repo root, install the project's development dependencies:
npm install bower install
Testing relies on the Karma test-runner. If you'd like to use Karma to automatically watch and re-run the test file during development, it's easiest to globally install Karma and run it from the CLI.
npm install -g karma karma start
To run the tests in Firefox, just once, as CI would: