https://github.com/helpers/helper-collection
Async collection helper for assemble.
https://github.com/helpers/helper-collection
assemble collection handlebars helper
Last synced: 8 months ago
JSON representation
Async collection helper for assemble.
- Host: GitHub
- URL: https://github.com/helpers/helper-collection
- Owner: helpers
- License: mit
- Created: 2017-01-25T19:31:36.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-02-11T01:04:18.000Z (over 8 years ago)
- Last Synced: 2024-04-09T16:22:58.851Z (over 1 year ago)
- Topics: assemble, collection, handlebars, helper
- Language: JavaScript
- Size: 9.77 KB
- Stars: 4
- Watchers: 6
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/contributing.md
- License: LICENSE
Awesome Lists containing this project
README
# helper-collection [](https://www.npmjs.com/package/helper-collection) [](https://npmjs.org/package/helper-collection) [](https://npmjs.org/package/helper-collection) [](https://travis-ci.org/helpers/helper-collection)
> Collection helper for assemble (or any other https://github.com/jonschlinkert/templates application)
## Install
Install with [npm](https://www.npmjs.com/):
```sh
$ npm install --save helper-collection
```
## Usage
Register the helper with [assemble](https://github.com/assemble/assemble):
```js
var assemble = require('assemble');
var app = assemble();
app.helper('collection', require('helper-collection'));
```
**Add some templates**
```js
// add some "pages" ("pages" is a built-in collection)
app.page('foo.hbs', {content: 'this is foo', data: {title: 'Foo'}});
app.page('bar.hbs', {content: 'this is bar', data: {title: 'Bar'}});
app.page('baz.hbs', {content: 'this is baz', data: {title: 'Baz'}});
// add some "posts" ("posts" is not built-in,
// so we need to create it first)
app.create('posts'); //<= that's it :)
// now we can add some posts
app.post('aaa.hbs', {content: 'this is aaa', data: {title: 'AAA'}});
app.post('bbb.hbs', {content: 'this is bbb', data: {title: 'BBB'}});
app.post('ccc.hbs', {content: 'this is ccc', data: {title: 'CCC'}});
```
### Usage inside templates
By default, the `collection` helper will get the name of the current collection being rendered. With [assemble](https://github.com/assemble/assemble), this would most likely be "pages".
```handlebars
- {{item.data.title}}
{{#collection}}
{{#each items as |item|}}
{{/each}}
{{/collection}}
```
**Specify a collection**
Or specify the collection to iterate over:
```handlebars
- {{item.data.title}}
{{#collection "posts"}}
{{#each items as |item|}}
{{/each}}
{{/collection}}
```
**Sort items**
Or specify the collection to iterate over:
```handlebars
- {{item.data.title}}
{{#collection}}
{{#each (sortBy items "data.title") as |item|}}
{{/each}}
{{/collection}}
```
**Dynamic selection**
Dynamically specify the collection to iterate over from the assemble config or front-matter (this is the real advantage of this helper over assemble's built-in helpers, since dynamically naming the collection allows you to define this logic in a partial somewhere, then use it for several collections - like "docs", "posts", and "pages").
In this example, `someCollectionName` represents a custom variable that you might define somewhere on the context, like front-matter.
```handlebars
- {{item.data.title}}
{{#collection someCollectionName}}
{{#each items as |item|}}
{{/each}}
{{/collection}}
```
## About
### Related projects
* [handlebars-helper-each](https://www.npmjs.com/package/handlebars-helper-each): Handlebars each helper, sync and async. | [homepage](https://github.com/helpers/handlebars-helper-each "Handlebars each helper, sync and async.")
* [handlebars-helpers](https://www.npmjs.com/package/handlebars-helpers): More than 130 Handlebars helpers in ~20 categories. Helpers can be used with Assemble, Generate… [more](https://github.com/assemble/handlebars-helpers) | [homepage](https://github.com/assemble/handlebars-helpers "More than 130 Handlebars helpers in ~20 categories. Helpers can be used with Assemble, Generate, Verb, Ghost, gulp-handlebars, grunt-handlebars, consolidate, or any node.js/Handlebars project.")
* [template-helpers](https://www.npmjs.com/package/template-helpers): Generic JavaScript helpers that can be used with any template engine. Handlebars, Lo-Dash, Underscore, or… [more](https://github.com/jonschlinkert/template-helpers) | [homepage](https://github.com/jonschlinkert/template-helpers "Generic JavaScript helpers that can be used with any template engine. Handlebars, Lo-Dash, Underscore, or any engine that supports helper functions.")
### Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
Please read the [contributing guide](.github/contributing.md) for advice on opening issues, pull requests, and coding standards.
### Building docs
_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
To generate the readme, run the following command:
```sh
$ npm install -g verbose/verb#dev verb-generate-readme && verb
```
### Running tests
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
```sh
$ npm install && npm test
```
### Author
**Jon Schlinkert**
* [github/jonschlinkert](https://github.com/jonschlinkert)
* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)
### License
Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).
MIT
***
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.4.2, on February 10, 2017._