groupBy
an angularJS group-by filter, that supports deep document grouping
Getting started
Prerequisites
If you do not have nodejs installed on your machine, download and install NodeJS.
Installation
Install ng-group-by npm package ng-group-by:
With Bower:
$ cd <project path>
bower install --save ng-group-by
With NPM:
$ cd <project path>
npm install --save ng-group-by
How to use
-
Import the
dist/ng-group-by.min.js
script and include the moduleng-group-by
into app.js -
OR
require('ng-group-by')
into app.js. -
Use it as an angular filter:
var ctrlteamPlayers = name: 'Jozy Altidore' team: 'Toronto FC' name: 'Matt Hedges' team: 'FC Dallas' name: 'Clint Dempsey' team: 'Seattle Sounders FC' name: 'Jesse Gonzalez' team: 'FC Dallas' name: 'Michael Bradley' team: 'Toronto FC' ; // groupBy filter will transform the data into Array of Group Objects. i.e. {key: <GROUP_BY_VALUE>, date: <ARRAY OF OBJECTS>}/*[ { "key": "Toronto FC", "data": [ { "name": "Jozy Altidore", "team": "Toronto FC" }, { "name": "Michael Bradley", "team": "Toronto FC" } ] }, { "key": "FC Dallas", "data": [ { "name": "Matt Hedges", "team": "FC Dallas" }, { "name": "Jesse Gonzalez", "team": "FC Dallas" } ] }, { "key": "Seattle Sounders FC", "data": [ { "name": "Clint Dempsey", "team": "Seattle Sounders FC" } ] } ]*/
<!--to group by all players by team--> {{team.key}} <!-- Team Name i.e. Toronto FC, FC Dallas or Seattle Sounders FC --> ... <!--Want deep document level group byEx. Player Object look like this {name: 'Jozy Altidore', team: {name: 'Toronto FC'}}-->...
Contributing
- If you planning add some feature please create issue before.
- Don't forget about tests.
Clone the project:
$ git clone$ npm install$ bower install
Run the tests:
$ mocha
Deploy:
Run the build task, update version before(bower,package)
$ gulp build$ git tag v*.*.*$ git push origin master --tags
Issues
If you do find an issue or have a question consider posting it on the Issues.