handlebars-group-by

> Handlebars helper which allows you to group lists by a property of each item.

[![NPM version][npm-img]][npm-url] [![Downloads][downloads-img]][npm-url] [![Build Status][travis-img]][travis-url] [![Coverage Status][coveralls-img]][coveralls-url]

Install

With Node.js:

$ npm install handlebars-group-by

With Bower:

$ bower install shannonmoeller/handlebars-group-by

Helper

$3

- list Array - Array whose items should be grouped together.
- by String - The name of the property by whose value items should be grouped.

Data:

``js
{
posts: [
{ year: 2014, title: 'foo', body: 'foo bar' },
{ year: 2014, title: 'bar', body: 'bar baz' },
{ year: 2014, title: 'baz', body: 'baz bat' },
{ year: 2015, title: 'bat', body: 'bat qux' },
{ year: 2015, title: 'qux', body: 'qux foo' }
]
}
`

Template:

`html
{{#group posts by="year"}}


{{ value }}

{{#each items}}


{{ title }}

{{ body }}

{{/each}}
{{/group}}
`

Output:

`html


2014

foo

foo bar

bar

bar baz

baz

baz bat

2015

bat

bat qux

qux

qux foo

`

Api

Helpers are registered by passing in your instance of Handlebars. This allows
you to selectively register the helpers on various instances of Handlebars.

$3

- handlebars Handlebars - An instance of Handlebars.

`js
var handlebars = require('handlebars'),
groupBy = require('handlebars-group-by');

groupBy(handlebars);
`

$3

- handlebars Handlebars - An instance of Handlebars.

Helpers are also exposed via a register method for use with Assemble.

`js
var handlebars = require('handlebars'),
groupBy = require('handlebars-group-by');

groupBy.register(handlebars);

// or

grunt.initConfig({
assemble: {
options: {
helpers: ['path/to/handlebars-group-by.js']
}
}
});
`

Contribute

[![Tasks][waffle-img]][waffle-url] [![Chat][gitter-img]][gitter-url] [![Tip][gittip-img]][gittip-url]

Standards for this project, including tests, code coverage, and semantics are enforced with a build tool. Pull requests must include passing tests with 100% code coverage and no linting errors.

$3

`sh
$ gulp test
``

License

MIT

[coveralls-img]: http://img.shields.io/coveralls/shannonmoeller/handlebars-group-by/master.svg?style=flat-square
[coveralls-url]: https://coveralls.io/r/shannonmoeller/handlebars-group-by
[downloads-img]: http://img.shields.io/npm/dm/handlebars-group-by.svg?style=flat-square
[gitter-img]: http://img.shields.io/badge/chat-shannonmoeller/handlebars--group-by-blue.svg?style=flat-square
[gitter-url]: https://gitter.im/shannonmoeller/handlebars-group-by
[gittip-img]: http://img.shields.io/gittip/shannonmoeller.svg?style=flat-square
[gittip-url]: https://www.gittip.com/shannonmoeller
[npm-img]: http://img.shields.io/npm/v/handlebars-group-by.svg?style=flat-square
[npm-url]: https://npmjs.org/package/handlebars-group-by
[travis-img]: http://img.shields.io/travis/shannonmoeller/handlebars-group-by.svg?style=flat-square
[travis-url]: https://travis-ci.org/shannonmoeller/handlebars-group-by
[waffle-img]: http://img.shields.io/github/issues/shannonmoeller/handlebars-group-by.svg?style=flat-square
[waffle-url]: http://waffle.io/shannonmoeller/handlebars-group-by