helper-sort-items
v0.1.0
Published
Helper for filtering and sorting an assemble collection based on an array of strings.
Downloads
55
Maintainers
Readme
helper-sort-items
Helper for filtering and sorting an assemble collection based on an array of strings.
Install
Install with npm:
$ npm install --save helper-sort-items
Usage
This is designed with assemble collections in mind, but it's generic enough that it should work with an array of strings too.
Example
The following example shows how to sort and filter the items in an assemble collection.
var assemble = require('assemble');
var app = assemble();
app.helper('sortItems', require('helper-sort-items'));
app.pages('templates/*.hbs');
Given that four pages have been loaded: foo.hbs
, bar.hbs
, baz.hbs
, and some-file.hbs
, the following:
<!-- in "some-file.hbs" -->
{{#pages}}
{{#each (sortItems items) as |item|}}
{{item.basename}}
{{/each}}
{{/pages}}
When rendered with these options:
var locals = {order: ['baz', 'bar', 'foo']};
app.render('some-file.hbs', locals, function(err, view) {
if (err) {
console.log(err);
process.exit(1);
}
console.log(view.contents.toString());
});
Would result in:
baz.hbs
bar.hbs
foo.hbs
Sort order
You can also pass the sort order as the last argument as a comma-separated string:
{{#pages}}
{{#each (sortItems items "baz,foo,bar") as |item|}}
{{item.basename}}
{{/each}}
{{/pages}}
Or when used as a handlebars helper, you can pass the sort order on the options hash as a comma-separated string:
{{#pages}}
{{#each (sortItems items order="baz,foo,bar") as |item|}}
{{item.basename}}
{{/each}}
{{/pages}}
About
Related projects
- handlebars-helpers: More than 130 Handlebars helpers in ~20 categories. Helpers can be used with Assemble, Generate… more | homepage
- template-helpers: Generic JavaScript helpers that can be used with any template engine. Handlebars, Lo-Dash, Underscore, or… more | homepage
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Please read the contributing guide for advice on opening issues, pull requests, and coding standards.
Building docs
(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)
To generate the readme, run the following command:
$ 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:
$ npm install && npm test
Author
Jon Schlinkert
License
Copyright © 2017, Jon Schlinkert. MIT
This file was generated by verb-generate-readme, v0.4.2, on February 19, 2017.