https://github.com/workmanw/ember-computed-sortby
Computed property implementation of `Ember.Array.sortBy`.
https://github.com/workmanw/ember-computed-sortby
ember ember-addon
Last synced: about 1 year ago
JSON representation
Computed property implementation of `Ember.Array.sortBy`.
- Host: GitHub
- URL: https://github.com/workmanw/ember-computed-sortby
- Owner: workmanw
- License: mit
- Created: 2015-09-11T21:04:10.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2017-05-04T18:09:15.000Z (about 9 years ago)
- Last Synced: 2025-03-18T14:53:50.112Z (over 1 year ago)
- Topics: ember, ember-addon
- Language: JavaScript
- Homepage:
- Size: 80.1 KB
- Stars: 16
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Ember-computed-sortby
Addon to make sorting a little easier for Ember.js when the sort order is immutable. This addon was originally a proof of concept for [emberjs/rfcs#87](https://github.com/emberjs/rfcs/pull/87). However that RFC was rejected, so this will continue to live on as an addon.
## Documentation
A computed property which returns a new sorted array of content from the
a dependent array. The sort order is defined by the second, and any subsequent,
string arguments. Adding a suffix of ':desc' to any of those string arguments
will cause that order to be applied as descending.
Example:
```javascript
import sortBy from 'ember-computed-sortby';
let ToDoList = Ember.Object.extend({
// using standard ascending sort
sortedTodos: sortBy('todos', 'name'),
// using descending sort
sortedTodosDesc: sortBy('todos', 'name:desc'),
// using secondary sort
sortedPriority: sortBy('todos', 'priority', 'name')
});
let todoList = ToDoList.create({todos: [
{ name: 'Unit Test', priority: 2 },
{ name: 'Documentation', priority: 3 },
{ name: 'Integration Test', priority: 2 },
{ name: 'Release', priority: 1 }
]});
todoList.get('sortedTodos'); // [{ name:'Documentation', priority:3 }, { name: 'Integration Test', priority: 2 }, { name:'Release', priority:1 }, { name:'Unit Test', priority:2 }]
todoList.get('sortedTodosDesc'); // [{ name:'Unit Test', priority:2 }, { name:'Release', priority:1 }, { name: 'Integration Test', priority: 2 }, { name:'Documentation', priority:3 }]
todoList.get('priorityTodos'); // [{ name:'Release', priority:1 }, { name: 'Integration Test', priority: 2 }, { name:'Unit Test', priority:2 }, { name:'Documentation', priority:3 }]
```
Method documentation:
```
@method sort
@for Ember.computed
@param {String} itemsKey
@param {String} property name(s) to sort on. Append ':desc' to trigger sort to be applied as descending.
@return {Ember.ComputedProperty} computes a new sorted array based on the sort property array
@public
```
## Installing this addon
From within your Ember CLI project directory:
```
ember install ember-computed-sortby
```
## Running Tests
### Setup
* `git clone` this repository
* `yarn install`
### Testing
* `ember test`
* `ember test --server`