Home handlebars.filter

Handlebars Filter helper

{{filter str filtername}}

Content filtering helper for Handlebars

Version

1.0.1

Installation

npm install handlebars.filter

Registering the helper

var Handlebars = require("handlebars");
var Filter = require("handlebars.filter");
Filter.registerHelper(Handlebars);

Using the helper

Apply a filter to content

{{filter str filtername}}

Apply a filter to captured content

{{#filter filtername}}{{str}}{{/filter}}

Apply chained filters to content

{{filter str filter1 filter2}}

Using the filters

Assuming a context of {str: "the FOX and the hoUnd"}

Apply lowercase filter

{{filter str "lowercase"}}                  → «the fox and the hound»

See lowercase

Apply uppercase filter

{{filter str "uppercase"}}                  → «THE FOX AND THE HOUND»

See uppercase

Apply capitalize filter

{{filter str "capitalize"}}                 → «The FOX And The HoUnd»

See capitalize

Apply capitalize filter overriding any existing casing

{{filter str "capitalize" respect=false}}   → «The Fox And The Hound»

Apply titlecase filter

{{filter str "titlecase"}}                  → «The Fox and the Hound»

See titlecase

Apply markdown filter

{{filter "## Hello *World*!" "markdown"}}   → «<h2>Hello <em>World</em>!</h2>»

See markdown

See filter helper for more details

Additional methods

Filter.registerFilter

Filter.registerFilter(name, fn);

Register a named filter method

See handlebars.filter.registerFilter

Filter.registerHelper

Filter.registerHelper(handlebars);

Register Filter helper with Handlebars

See handlebars.filter.registerHelper

Tests

npm test

To see output generated by tests

npm run test:output