Neolithic Programming Machine
    Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    handlebars-group-bypublic

    handlebars-group-by

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

    NPM version Downloads Build Status Coverage Status

    Install

    With Node.js:

    $ npm install handlebars-group-by
    

    With Bower:

    $ bower install shannonmoeller/handlebars-group-by
    

    Helper

    {{#group [list] by=[property]}}

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

    Data:

    {
        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:

    {{#group posts by="year"}}
        <h1>{{ value }}</h1>
     
        {{#each items}}
            <h2>{{ title }}</h2>
            <p>{{ body }}</p>
     
        {{/each}}
    {{/group}}

    Output:

    <h1>2014</h1>
     
    <h2>foo</h2>
    <p>foo bar</p>
     
    <h2>bar</h2>
    <p>bar baz</p>
     
    <h2>baz</h2>
    <p>baz bat</p>
     
    <h1>2015</h1>
     
    <h2>bat</h2>
    <p>bat qux</p>
     
    <h2>qux</h2>
    <p>qux foo</p>

    Api

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

    groupBy(handlebars)

    • handlebars Handlebars - An instance of Handlebars.
    var handlebars = require('handlebars'),
        groupBy = require('handlebars-group-by');
     
    groupBy(handlebars);

    groupBy.register(handlebars)

    • handlebars Handlebars - An instance of Handlebars.

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

    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 Chat Tip

    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.

    Test

    $ gulp test

    License

    MIT

    install

    npm i handlebars-group-by

    Downloadsweekly downloads

    29

    version

    1.0.1

    license

    MIT

    repository

    githubgithub

    last publish

    collaborators

    • avatar