helpers/handlebars-helpers helpers/handlebars-helpers

  • Stars
    star
    2,218
  • Rank 20,790 (Top 0.5 %)
  • Language
    JavaScript
  • License
    MIT License
  • Created over 11 years ago
  • Updated 4 months ago
Twitter logo Share LinkedIn logo Share Facebook logo Share
helpers/handlebars-helpers
github

helpers

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

188 handlebars helpers in ~20 categories. Can be used with Assemble, Ghost, YUI, express.js etc.

handlebars-helpers NPM version NPM monthly downloads NPM total downloads Linux Build Status Windows Build Status

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.

You might also be interested in template-helpers.

Install

Install with npm:

$ npm install --save handlebars-helpers

Install with yarn:

$ yarn add handlebars-helpers

Browser usage

See how to use handlebars-helpers in the browser.

Usage

The main export returns a function that needs to be called to expose the object of helpers.

Get all helpers

var helpers = require('handlebars-helpers')();
//=> returns object with all (130+) helpers

Get a specific helper collection

Helper collections are exposed as getters, so only the helpers you want will be required and loaded.

var helpers = require('handlebars-helpers');
var math = helpers.math();
//=> only the `math` helpers

var helpers = require('handlebars-helpers');
var array = helpers.array();
//=> only the `collections` helpers

Get multiple helpers collections

Helper collections are exposed as getters, so only the helpers you want will be required and loaded.

var helpers = require('handlebars-helpers')(['math', 'string']);
//=> only the `math` and `string` helpers

Optionally pass your own handlebars

var handlebars = require('handlebars');
var helpers = require('handlebars-helpers')({
  handlebars: handlebars
});

// or for a specific collection
var math = helpers.math({
  handlebars: handlebars
});

Helpers

Categories

Currently 189 helpers in 20 categories:

All helpers

array helpers

Visit the: code | unit tests | issues)

code helpers

Visit the: code | unit tests | issues)

collection helpers

Visit the: code | unit tests | issues)

comparison helpers

Visit the: code | unit tests | issues)

date helpers

Visit the: code | unit tests | issues)

fs helpers

Visit the: code | unit tests | issues)

html helpers

Visit the: code | unit tests | issues)

i18n helpers

Visit the: code | unit tests | issues)

inflection helpers

Visit the: code | unit tests | issues)

logging helpers

Visit the: code | unit tests | issues)

markdown helpers

Visit the: code | unit tests | issues)

match helpers

Visit the: code | unit tests | issues)

math helpers

Visit the: code | unit tests | issues)

misc helpers

Visit the: code | unit tests | issues)

number helpers

Visit the: code | unit tests | issues)

object helpers

Visit the: code | unit tests | issues)

path helpers

Visit the: code | unit tests | issues)

regex helpers

Visit the: code | unit tests | issues)

string helpers

Visit the: code | unit tests | issues)

url helpers

Visit the: code | unit tests | issues)

array

{{after}}

Returns all of the items in an array after the specified index. Opposite of before.

Params

  • array {Array}: Collection
  • n {Number}: Starting index (number of items to exclude)
  • returns {Array}: Array exluding n items.

Example

<!-- array: ['a', 'b', 'c'] -->
{{after array 1}}
<!-- results in: '["c"]' -->

{{arrayify}}

Cast the given value to an array.

Params

  • value {any}
  • returns {Array}

Example

{{arrayify "foo"}}
<!-- results in: [ "foo" ] -->

{{before}}

Return all of the items in the collection before the specified count. Opposite of after.

Params

  • array {Array}
  • n {Number}
  • returns {Array}: Array excluding items after the given number.

Example

<!-- array: ['a', 'b', 'c'] -->
{{before array 2}}
<!-- results in: '["a", "b"]' -->

{{eachIndex}}

Params

  • array {Array}
  • options {Object}
  • returns {String}

Example

<!-- array: ['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h'] -->
{{#eachIndex array}}
  {{item}} is {{index}}
{{/eachIndex}}

{{filter}}

Block helper that filters the given array and renders the block for values that evaluate to true, otherwise the inverse block is returned.

Params

  • array {Array}
  • value {any}
  • options {Object}
  • returns {String}

Example

<!-- array: ['a', 'b', 'c'] -->
{{#filter array "foo"}}AAA{{else}}BBB{{/filter}}
<!-- results in: 'BBB' -->

{{first}}

Returns the first item, or first n items of an array.

Params

  • array {Array}
  • n {Number}: Number of items to return, starting at 0.
  • returns {Array}

Example

{{first "['a', 'b', 'c', 'd', 'e']" 2}}
<!-- results in: '["a", "b"]' -->

{{forEach}}

Iterates over each item in an array and exposes the current item in the array as context to the inner block. In addition to the current array item, the helper exposes the following variables to the inner block:

  • index
  • total
  • isFirst
  • isLast Also, @index is exposed as a private variable, and additional private variables may be defined as hash arguments.

Params

  • array {Array}
  • returns {String}

Example

<!-- accounts = [
{'name': 'John', 'email': '[email protected]'},
{'name': 'Malcolm', 'email': '[email protected]'},
{'name': 'David', 'email': '[email protected]'}
] -->

{{#forEach accounts}}
  <a href="mailto:{{ email }}" title="Send an email to {{ name }}">
    {{ name }}
  </a>{{#unless isLast}}, {{/unless}}
{{/forEach}}

{{inArray}}

Block helper that renders the block if an array has the given value. Optionally specify an inverse block to render when the array does not have the given value.

Params

  • array {Array}
  • value {any}
  • options {Object}
  • returns {String}

Example

<!-- array: ['a', 'b', 'c'] -->
{{#inArray array "d"}}
  foo
{{else}}
  bar
{{/inArray}}
<!-- results in: 'bar' -->

{{isArray}}

Returns true if value is an es5 array.

Params

  • value {any}: The value to test.
  • returns {Boolean}

Example

{{isArray "abc"}}
<!-- results in: false -->

<!-- array: [1, 2, 3] -->
{{isArray array}}
<!-- results in: true -->

{{itemAt}}

Returns the item from array at index idx.

Params

  • array {Array}
  • idx {Number}
  • returns {any} value

Example

<!-- array: ['a', 'b', 'c'] -->
{{itemAt array 1}}
<!-- results in: 'b' -->

{{join}}

Join all elements of array into a string, optionally using a given separator.

Params

  • array {Array}
  • separator {String}: The separator to use. Defaults to ,.
  • returns {String}

Example

<!-- array: ['a', 'b', 'c'] -->
{{join array}}
<!-- results in: 'a, b, c' -->

{{join array '-'}}
<!-- results in: 'a-b-c' -->

{{equalsLength}}

Returns true if the the length of the given value is equal to the given length. Can be used as a block or inline helper.

Params

  • value {Array|String}
  • length {Number}
  • options {Object}
  • returns {String}

{{last}}

Returns the last item, or last n items of an array or string. Opposite of first.

Params

  • value {Array|String}: Array or string.
  • n {Number}: Number of items to return from the end of the array.
  • returns {Array}

Example

<!-- var value = ['a', 'b', 'c', 'd', 'e'] -->

{{last value}}
<!-- results in: ['e'] -->

{{last value 2}}
<!-- results in: ['d', 'e'] -->

{{last value 3}}
<!-- results in: ['c', 'd', 'e'] -->

{{length}}

Returns the length of the given string or array.

Params

  • value {Array|Object|String}
  • returns {Number}: The length of the value.

Example

{{length '["a", "b", "c"]'}}
<!-- results in: 3 -->

<!-- results in: myArray = ['a', 'b', 'c', 'd', 'e']; -->
{{length myArray}}
<!-- results in: 5 -->

<!-- results in: myObject = {'a': 'a', 'b': 'b'}; -->
{{length myObject}}
<!-- results in: 2 -->

{{lengthEqual}}

Alias for equalsLength

{{map}}

Returns a new array, created by calling function on each element of the given array. For example,

Params

  • array {Array}
  • fn {Function}
  • returns {String}

Example

<!-- array: ['a', 'b', 'c'], and "double" is a
fictitious function that duplicates letters -->
{{map array double}}
<!-- results in: '["aa", "bb", "cc"]' -->

{{pluck}}

Map over the given object or array or objects and create an array of values from the given prop. Dot-notation may be used (as a string) to get nested properties.

Params

  • collection {Array|Object}
  • prop {Function}
  • returns {String}

Example

// {{pluck items "data.title"}}
<!-- results in: '["aa", "bb", "cc"]' -->

{{reverse}}

Reverse the elements in an array, or the characters in a string.

Params

  • value {Array|String}
  • returns {Array|String}: Returns the reversed string or array.

Example

<!-- value: 'abcd' -->
{{reverse value}}
<!-- results in: 'dcba' -->
<!-- value: ['a', 'b', 'c', 'd'] -->
{{reverse value}}
<!-- results in: ['d', 'c', 'b', 'a'] -->

{{some}}

Block helper that returns the block if the callback returns true for some value in the given array.

Params

  • array {Array}
  • iter {Function}: Iteratee
  • {Options}: Handlebars provided options object
  • returns {String}

Example

<!-- array: [1, 'b', 3] -->
{{#some array isString}}
  Render me if the array has a string.
{{else}}
  Render me if it doesn't.
{{/some}}
<!-- results in: 'Render me if the array has a string.' -->

{{sort}}

Sort the given array. If an array of objects is passed, you may optionally pass a key to sort on as the second argument. You may alternatively pass a sorting function as the second argument.

Params

  • array {Array}: the array to sort.
  • key {String|Function}: The object key to sort by, or sorting function.

Example

<!-- array: ['b', 'a', 'c'] -->
{{sort array}}
<!-- results in: '["a", "b", "c"]' -->

{{sortBy}}

Sort an array. If an array of objects is passed, you may optionally pass a key to sort on as the second argument. You may alternatively pass a sorting function as the second argument.

Params

  • array {Array}: the array to sort.
  • props {String|Function}: One or more properties to sort by, or sorting functions to use.

Example

<!-- array: [{a: 'zzz'}, {a: 'aaa'}] -->
{{sortBy array "a"}}
<!-- results in: '[{"a":"aaa"}, {"a":"zzz"}]' -->

{{withAfter}}

Use the items in the array after the specified index as context inside a block. Opposite of withBefore.

Params

  • array {Array}
  • idx {Number}
  • options {Object}
  • returns {Array}

Example

<!-- array: ['a', 'b', 'c', 'd', 'e'] -->
{{#withAfter array 3}}
  {{this}}
{{/withAfter}}
<!-- results in: "de" -->

{{withBefore}}

Use the items in the array before the specified index as context inside a block. Opposite of withAfter.

Params

  • array {Array}
  • idx {Number}
  • options {Object}
  • returns {Array}

Example

<!-- array: ['a', 'b', 'c', 'd', 'e'] -->
{{#withBefore array 3}}
  {{this}}
{{/withBefore}}
<!-- results in: 'ab' -->

{{withFirst}}

Use the first item in a collection inside a handlebars block expression. Opposite of withLast.

Params

  • array {Array}
  • idx {Number}
  • options {Object}
  • returns {String}

Example

<!-- array: ['a', 'b', 'c'] -->
{{#withFirst array}}
  {{this}}
{{/withFirst}}
<!-- results in: 'a' -->

{{withGroup}}

Block helper that groups array elements by given group size.

Params

  • array {Array}: The array to iterate over
  • size {Number}: The desired length of each array "group"
  • options {Object}: Handlebars options
  • returns {String}

Example

<!-- array: ['a','b','c','d','e','f','g','h'] -->
{{#withGroup array 4}}
  {{#each this}}
    {{.}}
  {{each}}
  <br>
{{/withGroup}}
<!-- results in: -->
<!-- 'a','b','c','d'<br> -->
<!-- 'e','f','g','h'<br> -->

{{withLast}}

Use the last item or n items in an array as context inside a block. Opposite of withFirst.

Params

  • array {Array}
  • idx {Number}: The starting index.
  • options {Object}
  • returns {String}

Example

<!-- array: ['a', 'b', 'c'] -->
{{#withLast array}}
  {{this}}
{{/withLast}}
<!-- results in: 'c' -->

{{withSort}}

Block helper that sorts a collection and exposes the sorted collection as context inside the block.

Params

  • array {Array}
  • prop {String}
  • options {Object}: Specify reverse="true" to reverse the array.
  • returns {String}

Example

<!-- array: ['b', 'a', 'c'] -->
{{#withSort array}}{{this}}{{/withSort}}
<!-- results in: 'abc' -->

{{unique}}

Block helper that return an array with all duplicate values removed. Best used along with a each helper.

Params

  • array {Array}
  • options {Object}
  • returns {Array}

Example

<!-- array: ['a', 'a', 'c', 'b', 'e', 'e'] -->
{{#each (unique array)}}{{.}}{{/each}}
<!-- results in: 'acbe' -->

code

{{embed}}

Embed code from an external file as preformatted text.

Params

  • filepath {String}: filepath to the file to embed.
  • language {String}: Optionally specify the language to use for syntax highlighting.
  • returns {String}

Example

{{embed 'path/to/file.js'}}
<!-- optionally specify the language to use -->
{{embed 'path/to/file.hbs' 'html')}}

{{gist}}

Embed a GitHub Gist using only the id of the Gist

Params

  • id {String}
  • returns {String}

Example

{{gist "12345"}}

{{jsfiddle}}

Generate the HTML for a jsFiddle link with the given params

Params

  • params {Object}
  • returns {String}

Example

{{jsfiddle id="0dfk10ks" tabs="true"}}

collection

{{isEmpty}}

Inline, subexpression, or block helper that returns true (or the block) if the given collection is empty, or false (or the inverse block, if supplied) if the colleciton is not empty.

Params

  • collection {Object}
  • options {Object}
  • returns {String}

Example

<!-- array: [] -->
{{#isEmpty array}}AAA{{else}}BBB{{/isEmpty}}
<!-- results in: 'AAA' -->

<!-- array: [] -->
{{isEmpty array}}
<!-- results in: true -->

{{iterate}}

Block helper that iterates over an array or object. If an array is given, .forEach is called, or if an object is given, .forOwn is called, otherwise the inverse block is returned.

Params

  • collection {Object|Array}: The collection to iterate over
  • options {Object}
  • returns {String}

comparison

{{and}}

Helper that renders the block if both of the given values are truthy. If an inverse block is specified it will be rendered when falsy. Works as a block helper, inline helper or subexpression.

Params

  • a {any}
  • b {any}
  • options {Object}: Handlebars provided options object
  • returns {String}

Example

<!-- {great: true, magnificent: true} -->
{{#and great magnificent}}A{{else}}B{{/and}}
<!-- results in: 'A' -->

{{compare}}

Render a block when a comparison of the first and third arguments returns true. The second argument is the arithemetic operator to use. You may also optionally specify an inverse block to render when falsy.

Params

  • a {}
  • operator {}: The operator to use. Operators must be enclosed in quotes: ">", "=", "<=", and so on.
  • b {}
  • options {Object}: Handlebars provided options object
  • returns {String}: Block, or if specified the inverse block is rendered if falsey.

{{contains}}

Block helper that renders the block if collection has the given value, using strict equality (===) for comparison, otherwise the inverse block is rendered (if specified). If a startIndex is specified and is negative, it is used as the offset from the end of the collection.

Params

  • collection {Array|Object|String}: The collection to iterate over.
  • value {any}: The value to check for.
  • [startIndex=0] {Number}: Optionally define the starting index.
  • options {Object}: Handlebars provided options object.

Example

<!-- array = ['a', 'b', 'c'] -->
{{#contains array "d"}}
  This will not be rendered.
{{else}}
  This will be rendered.
{{/contains}}

{{default}}

Returns the first value that is not undefined, otherwise the "default" value is returned.

Params

  • value {any}
  • defaultValue {any}
  • returns {String}

{{eq}}

Block helper that renders a block if a is equal to b. If an inverse block is specified it will be rendered when falsy. You may optionally use the compare="" hash argument for the second value.

Params

  • a {String}
  • b {String}
  • options {Object}: Handlebars provided options object
  • returns {String}: Block, or inverse block if specified and falsey.

{{gt}}

Block helper that renders a block if a is greater than b.

If an inverse block is specified it will be rendered when falsy. You may optionally use the compare="" hash argument for the second value.

Params

  • a {String}
  • b {String}
  • options {Object}: Handlebars provided options object
  • returns {String}: Block, or inverse block if specified and falsey.

{{gte}}

Block helper that renders a block if a is greater than or equal to b.

If an inverse block is specified it will be rendered when falsy. You may optionally use the compare="" hash argument for the second value.

Params

  • a {String}
  • b {String}
  • options {Object}: Handlebars provided options object
  • returns {String}: Block, or inverse block if specified and falsey.

{{has}}

Block helper that renders a block if value has pattern. If an inverse block is specified it will be rendered when falsy.

Params

  • val {any}: The value to check.
  • pattern {any}: The pattern to check for.
  • options {Object}: Handlebars provided options object
  • returns {String}

{{isFalsey}}

Returns true if the given value is falsey. Uses the falsey library for comparisons. Please see that library for more information or to report bugs with this helper.

Params

  • val {any}
  • options {Options}
  • returns {Boolean}

{{isTruthy}}

Returns true if the given value is truthy. Uses the falsey library for comparisons. Please see that library for more information or to report bugs with this helper.

Params

  • val {any}
  • options {Options}
  • returns {Boolean}

{{ifEven}}

Return true if the given value is an even number.

Params

  • number {Number}
  • options {Object}: Handlebars provided options object
  • returns {String}: Block, or inverse block if specified and falsey.

Example

{{#ifEven value}}
  render A
{{else}}
  render B
{{/ifEven}}

{{ifNth}}

Conditionally renders a block if the remainder is zero when a operand is divided by b. If an inverse block is specified it will be rendered when the remainder is not zero.

Params

  • {}: {Number}
  • {}: {Number}
  • options {Object}: Handlebars provided options object
  • returns {String}: Block, or inverse block if specified and falsey.

{{ifOdd}}

Block helper that renders a block if value is an odd number. If an inverse block is specified it will be rendered when falsy.

Params

  • value {Object}
  • options {Object}: Handlebars provided options object
  • returns {String}: Block, or inverse block if specified and falsey.

Example

{{#ifOdd value}}
  render A
{{else}}
  render B
{{/ifOdd}}

{{is}}

Block helper that renders a block if a is equal to b. If an inverse block is specified it will be rendered when falsy. Similar to eq but does not do strict equality.

Params

  • a {any}
  • b {any}
  • options {Object}: Handlebars provided options object
  • returns {String}

{{isnt}}

Block helper that renders a block if a is not equal to b. If an inverse block is specified it will be rendered when falsy. Similar to unlessEq but does not use strict equality for comparisons.

Params

  • a {String}
  • b {String}
  • options {Object}: Handlebars provided options object
  • returns {String}

{{lt}}

Block helper that renders a block if a is less than b.

If an inverse block is specified it will be rendered when falsy. You may optionally use the compare="" hash argument for the second value.

Params

  • context {Object}
  • options {Object}: Handlebars provided options object
  • returns {String}: Block, or inverse block if specified and falsey.

{{lte}}

Block helper that renders a block if a is less than or equal to b.

If an inverse block is specified it will be rendered when falsy. You may optionally use the compare="" hash argument for the second value.

Params

  • a {Sring}
  • b {Sring}
  • options {Object}: Handlebars provided options object
  • returns {String}: Block, or inverse block if specified and falsey.

{{neither}}

Block helper that renders a block if neither of the given values are truthy. If an inverse block is specified it will be rendered when falsy.

Params

  • a {any}
  • b {any}
  • options {}: Handlebars options object
  • returns {String}: Block, or inverse block if specified and falsey.

{{not}}

Returns true if val is falsey. Works as a block or inline helper.

Params

  • val {String}
  • options {Object}: Handlebars provided options object
  • returns {String}

{{or}}

Block helper that renders a block if any of the given values is truthy. If an inverse block is specified it will be rendered when falsy.

Params

  • arguments {...any}: Variable number of arguments
  • options {Object}: Handlebars options object
  • returns {String}: Block, or inverse block if specified and falsey.

Example

{{#or a b c}}
  If any value is true this will be rendered.
{{/or}}

{{unlessEq}}

Block helper that always renders the inverse block unless a is is equal to b.

Params

  • a {String}
  • b {String}
  • options {Object}: Handlebars provided options object
  • returns {String}: Inverse block by default, or block if falsey.

{{unlessGt}}

Block helper that always renders the inverse block unless a is is greater than b.

Params

  • a {Object}: The default value
  • b {Object}: The value to compare
  • options {Object}: Handlebars provided options object
  • returns {String}: Inverse block by default, or block if falsey.

{{unlessLt}}

Block helper that always renders the inverse block unless a is is less than b.

Params

  • a {Object}: The default value
  • b {Object}: The value to compare
  • options {Object}: Handlebars provided options object
  • returns {String}: Block, or inverse block if specified and falsey.

{{unlessGteq}}

Block helper that always renders the inverse block unless a is is greater than or equal to b.

Params

  • a {any}
  • b {any}
  • options {Object}: Handlebars provided options object
  • returns {String}: Block, or inverse block if specified and falsey.

{{unlessLteq}}

Block helper that always renders the inverse block unless a is is less than or equal to b.

Params

  • a {any}
  • b {any}
  • options {Object}: Handlebars provided options object
  • returns {String}: Block, or inverse block if specified and falsey.

date

{{year}}

Get the current year.

Example

{{year}}
<!-- 2017 -->

{{moment}}

Use moment as a helper. See helper-date for more details.

fs

{{read}}

Read a file from the file system. This is useful in composing "include"-style helpers using sub-expressions.

Params

  • filepath {String}
  • returns {String}

Example

{{read "a/b/c.js"}}
{{someHelper (read "a/b/c.md")}}

{{readdir}}

Return an array of files from the given directory.

Params

  • directory {String}
  • returns {Array}

html

{{attr}}

Stringify attributes on the options hash.

Params

  • options {Object}
  • returns {String}

Example

<!-- value = 'bar' -->
<div{{attr foo=value}}></div>
<!-- results in: <div foo="bar"></div>

{{css}}

Add an array of <link> tags. Automatically resolves relative paths to options.assets if passed on the context.

Params

  • list {String|Array}: One or more stylesheet urls.
  • returns {String}

Example

<!-- {stylesheets: ['foo.css', 'bar.css']} -->
{{css stylesheets}}

<!-- results in: -->
<!-- <link type="text/css" rel="stylesheet" href="foo.css"> -->
<!-- <link type="text/css" rel="stylesheet" href="bar.css"> -->

{{js}}

Generate one or more <script></script> tags with paths/urls to javascript or coffeescript files.

Params

  • context {Object}
  • returns {String}

Example

{{js scripts}}

{{sanitize}}

Strip HTML tags from a string, so that only the text nodes are preserved.

Params

  • str {String}: The string of HTML to sanitize.
  • returns {String}

Example

{{sanitize "<span>foo</span>"}}
<!-- results in: 'foo' -->

{{ul}}

Block helper for creating unordered lists (<ul></ul>)

Params

  • context {Object}
  • options {Object}
  • returns {String}

{{ol}}

Block helper for creating ordered lists (<ol></ol>)

Params

  • context {Object}
  • options {Object}
  • returns {String}

{{thumbnailImage}}

Returns a <figure> with a thumbnail linked to a full picture

Params

  • context {Object}: Object with values/attributes to add to the generated elements:
  • context.alt {String}
  • context.src {String}
  • context.width {Number}
  • context.height {Number}
  • returns {String}: HTML <figure> element with image and optional caption/link.

i18n

{{i18n}}

i18n helper. See button-i18n for a working example.

Params

  • key {String}
  • options {Object}
  • returns {String}

inflection

{{inflect}}

Returns either the singular or plural inflection of a word based on the given count.

Params

  • count {Number}
  • singular {String}: The singular form
  • plural {String}: The plural form
  • includeCount {String}
  • returns {String}

Example

{{inflect 0 "string" "strings"}}
<!-- "strings" -->
{{inflect 1 "string" "strings"}}
<!-- "string" -->
{{inflect 1 "string" "strings" true}}
<!-- "1 string" -->
{{inflect 2 "string" "strings"}}
<!-- "strings" -->
{{inflect 2 "string" "strings" true}}
<!-- "2 strings" -->

{{ordinalize}}

Returns an ordinalized number as a string.

Params

  • val {String}: The value to ordinalize.
  • returns {String}: The ordinalized number

Example

{{ordinalize 1}}
<!-- '1st' -->
{{ordinalize 21}}
<!-- '21st' -->
{{ordinalize 29}}
<!-- '29th' -->
{{ordinalize 22}}
<!-- '22nd' -->

logging

logging-helpers.

markdown

{{markdown}}

Block helper that converts a string of inline markdown to HTML.

Params

  • context {Object}
  • options {Object}
  • returns {String}

Example

{{#markdown}}
# Foo
{{/markdown}}
<!-- results in: <h1>Foo</h1> -->

{{md}}

Read a markdown file from the file system and inject its contents after converting it to HTML.

Params

  • context {Object}
  • options {Object}
  • returns {String}

Example

{{md "foo/bar.md"}}

match

{{match}}

Returns an array of strings that match the given glob pattern(s). Options may be passed on the options hash or locals.

Params

  • files {Array|String}
  • patterns {Array|String}: One or more glob patterns.
  • locals {Object}
  • options {Object}
  • returns {Array}: Array of matches

Example

{{match (readdir "foo") "*.js"}}
{{match (readdir "foo") (toRegex "\\.js$")}}

{{isMatch}}

Returns true if a filepath contains the given pattern. Options may be passed on the options hash or locals.

Params

  • filepath {String}
  • pattern {String}
  • options {Object}
  • returns {Boolean}

Example

{{isMatch "foo.md" "*.md"}}
<!-- results in: true -->

math

{{abs}}

Return the magnitude of a.

Params

  • a {Number}
  • returns {Number}

{{add}}

Return the sum of a plus b.

Params

  • a {Number}
  • b {Number}
  • returns {Number}

{{avg}}

Returns the average of all numbers in the given array.

Params

  • array {Array}: Array of numbers to add up.
  • returns {Number}

Example

{{avg "[1, 2, 3, 4, 5]"}}
<!-- results in: '3' -->

{{ceil}}

Get the Math.ceil() of the given value.

Params

  • value {Number}
  • returns {Number}

{{divide}}

Divide a by b

Params

  • a {Number}: numerator
  • b {Number}: denominator

{{floor}}

Get the Math.floor() of the given value.

Params

  • value {Number}
  • returns {Number}

{{minus}}

Return the difference of a minus b.

Params

  • a {Number}
  • b {Number}

{{modulo}}

Get the remainder of a division operation.

Params

  • a {Number}
  • b {Number}
  • returns {Number}

{{multiply}}

Return the product of a times b.

Params

  • a {Number}: factor
  • b {Number}: multiplier
  • returns {Number}

{{plus}}

Add a by b.

Params

  • a {Number}: factor
  • b {Number}: multiplier

{{random}}

Generate a random number between two values

Params

  • min {Number}
  • max {Number}
  • returns {String}

{{remainder}}

Get the remainder when a is divided by b.

Params

  • a {Number}: a
  • b {Number}: b

{{round}}

Round the given number.

Params

  • number {Number}
  • returns {Number}

{{subtract}}

Return the product of a minus b.

Params

  • a {Number}
  • b {Number}
  • returns {Number}

{{sum}}

Returns the sum of all numbers in the given array.

Params

  • array {Array}: Array of numbers to add up.
  • returns {Number}

Example

{{sum "[1, 2, 3, 4, 5]"}}
<!-- results in: '15' -->

{{times}}

Multiply number a by number b.

Params

  • a {Number}: factor
  • b {Number}: multiplier
  • returns {Number}

misc

{{option}}

Return the given value of prop from this.options.

Params

  • prop {String}
  • returns {any}

Example

<!-- context = {options: {a: {b: {c: 'ddd'}}}} -->
{{option "a.b.c"}}
<!-- results => `ddd` -->

{{noop}}

Block helper that renders the block without taking any arguments.

Params

  • options {Object}
  • returns {String}

{{typeOf}}

Get the native type of the given value

Params

  • value {any}
  • returns {String}: Returns the type of value.

Example

{{typeOf 1}}
//=> 'number'
{{typeOf "1"}}
//=> 'string'
{{typeOf "foo"}}
//=> 'string'

{{withHash}}

Block helper that builds the context for the block from the options hash.

Params

  • options {Object}: Handlebars provided options object.

number

{{bytes}}

Format a number to it's equivalent in bytes. If a string is passed, it's length will be formatted and returned.

Examples:

  • 'foo' => 3 B
  • 13661855 => 13.66 MB
  • 825399 => 825.39 kB
  • 1396 => 1.4 kB

Params

  • number {Number|String}
  • returns {String}

{{addCommas}}

Add commas to numbers

Params

  • num {Number}
  • returns {Number}

{{phoneNumber}}

Convert a string or number to a formatted phone number.

Params

  • num {Number|String}: The phone number to format, e.g. 8005551212
  • returns {Number}: Formatted phone number: (800) 555-1212

{{toAbbr}}

Abbreviate numbers to the given number of precision. This is for general numbers, not size in bytes.

Params

  • number {Number}
  • precision {Number}
  • returns {String}

{{toExponential}}

Returns a string representing the given number in exponential notation.

Params

  • number {Number}
  • fractionDigits {Number}: Optional. An integer specifying the number of digits to use after the decimal point. Defaults to as many digits as necessary to specify the number.
  • returns {Number}

Example

{{toExponential number digits}};

{{toFixed}}

Formats the given number using fixed-point notation.

Params

  • number {Number}
  • digits {Number}: (Optional) The number of digits to appear after the decimal point; this may be a value between 0 and 20. If this argument is omitted, it is treated as 0.
  • returns {String}: A string representing the given number using fixed-point notation.

Example

{{toFixed "1.1234" 2}}
//=> '1.12'

{{toFloat}}

Params

  • number {Number}
  • returns {Number}

{{toInt}}

Params

  • number {Number}
  • returns {Number}

{{toPrecision}}

Returns a string representing the Number object to the specified precision.

Params

  • number {Number}
  • precision {Number}: (Optional) An integer specifying the number of significant digits. If precison is not between 1 and 100 (inclusive), it will be coerced to 0.
  • returns {String}: A string representing a Number object in fixed-point or exponential notation rounded to precision significant digits.

Example

{{toPrecision "1.1234" 2}}
//=> '1.1'

object

{{extend}}

Extend the context with the properties of other objects. A shallow merge is performed to avoid mutating the context.

Params

  • objects {Object}: One or more objects to extend.
  • returns {Object}

{{forIn}}

Block helper that iterates over the properties of an object, exposing each key and value on the context.

Params

  • context {Object}
  • options {Object}
  • returns {String}

{{forOwn}}

Block helper that iterates over the own properties of an object, exposing each key and value on the context.

Params

  • obj {Object}: The object to iterate over.
  • options {Object}
  • returns {String}

{{toPath}}

Take arguments and, if they are string or number, convert them to a dot-delineated object property path.

Params

  • prop {String|Number}: The property segments to assemble (can be multiple).
  • returns {String}

{{get}}

Use property paths (a.b.c) to get a value or nested value from the context. Works as a regular helper or block helper.

Params

  • prop {String}: The property to get, optionally using dot notation for nested properties.
  • context {Object}: The context object
  • options {Object}: The handlebars options object, if used as a block helper.
  • returns {String}

{{getObject}}

Use property paths (a.b.c) to get an object from the context. Differs from the get helper in that this helper will return the actual object, including the given property key. Also, this helper does not work as a block helper.

Params

  • prop {String}: The property to get, optionally using dot notation for nested properties.
  • context {Object}: The context object
  • returns {String}

{{hasOwn}}

Return true if key is an own, enumerable property of the given context object.

Params

  • key {String}
  • context {Object}: The context object.
  • returns {Boolean}

Example

{{hasOwn context key}}

{{isObject}}

Return true if value is an object.

Params

  • value {String}
  • returns {Boolean}

Example

{{isObject "foo"}}
//=> false

{{JSONparse}}

Parses the given string using JSON.parse.

Params

  • string {String}: The string to parse

Example

<!-- string: '{"foo": "bar"}' -->
{{JSONparse string}}
<!-- results in: { foo: 'bar' } -->

{{JSONstringify}}

Stringify an object using JSON.stringify.

Params

  • obj {Object}: Object to stringify
  • returns {String}

Example

<!-- object: { foo: 'bar' } -->
{{JSONstringify object}}
<!-- results in: '{"foo": "bar"}' -->

{{merge}}

Deeply merge the properties of the given objects with the context object.

Params

  • object {Object}: The target object. Pass an empty object to shallow clone.
  • objects {Object}
  • returns {Object}

{{pick}}

Pick properties from the context object.

Params

  • properties {Array|String}: One or more properties to pick.
  • context {Object}
  • options {Object}: Handlebars options object.
  • returns {Object}: Returns an object with the picked values. If used as a block helper, the values are passed as context to the inner block. If no values are found, the context is passed to the inverse block.

path

{{absolute}}

Get the directory path segment from the given filepath.

Params

  • ext {String}
  • returns {String}

Example

{{absolute "docs/toc.md"}}
<!-- results in: 'docs' -->

{{dirname}}

Get the directory path segment from the given filepath.

Params

  • ext {String}
  • returns {String}

Example

{{dirname "docs/toc.md"}}
<!-- results in: 'docs' -->

{{relative}}

Get the relative filepath from a to b.

Params

  • a {String}
  • b {String}
  • returns {String}

Example

{{relative a b}}

{{basename}}

Get the file extension from the given filepath.

Params

  • ext {String}
  • returns {String}

Example

{{basename "docs/toc.md"}}
<!-- results in: 'toc.md' -->

{{stem}}

Get the "stem" from the given filepath.

Params

  • filepath {String}
  • returns {String}

Example

{{stem "docs/toc.md"}}
<!-- results in: 'toc' -->

{{extname}}

Get the file extension from the given filepath.

Params

  • filepath {String}
  • returns {String}

Example

{{extname "docs/toc.md"}}
<!-- results in: '.md' -->

{{resolve}}

Resolve an absolute path from the given filepath.

Params

  • filepath {String}
  • returns {String}

Example

{{resolve "docs/toc.md"}}
<!-- results in: '/User/dev/docs/toc.md' -->

{{segments}}

Get specific (joined) segments of a file path by passing a range of array indices.

Params

  • filepath {String}: The file path to split into segments.
  • returns {String}: Returns a single, joined file path.

Example

{{segments "a/b/c/d" "2" "3"}}
<!-- results in: 'c/d' -->

{{segments "a/b/c/d" "1" "3"}}
<!-- results in: 'b/c/d' -->

{{segments "a/b/c/d" "1" "2"}}
<!-- results in: 'b/c' -->

regex

{{toRegex}}

Convert the given string to a regular expression.

Params

  • str {String}
  • returns {RegExp}

Example

{{toRegex "foo"}}
<!-- results in: /foo/ -->

{{test}}

Returns true if the given str matches the given regex. A regex can be passed on the context, or using the toRegex helper as a subexpression.

Params

  • str {String}
  • returns {RegExp}

Example

{{test "bar" (toRegex "foo")}}
<!-- results in: false -->
{{test "foobar" (toRegex "foo")}}
<!-- results in: true -->
{{test "foobar" (toRegex "^foo$")}}
<!-- results in: false -->

string

{{append}}

Append the specified suffix to the given string.

Params

  • str {String}
  • suffix {String}
  • returns {String}

Example

<!-- given that "item.stem" is "foo" -->
{{append item.stem ".html"}}
<!-- results in:  'foo.html' -->

{{camelcase}}

camelCase the characters in the given string.

Params

  • string {String}: The string to camelcase.
  • returns {String}

Example

{{camelcase "foo bar baz"}};
<!-- results in:  'fooBarBaz' -->

{{capitalize}}

Capitalize the first word in a sentence.

Params

  • str {String}
  • returns {String}

Example

{{capitalize "foo bar baz"}}
<!-- results in:  "Foo bar baz" -->

{{capitalizeAll}}

Capitalize all words in a string.

Params

  • str {String}
  • returns {String}

Example

{{capitalizeAll "foo bar baz"}}
<!-- results in:  "Foo Bar Baz" -->

{{center}}

Center a string using non-breaking spaces

Params

  • str {String}
  • spaces {String}
  • returns {String}

{{chop}}

Like trim, but removes both extraneous whitespace and non-word characters from the beginning and end of a string.

Params

  • string {String}: The string to chop.
  • returns {String}

Example

{{chop "_ABC_"}}
<!-- results in:  'ABC' -->

{{chop "-ABC-"}}
<!-- results in:  'ABC' -->

{{chop " ABC "}}
<!-- results in:  'ABC' -->

{{dashcase}}

dash-case the characters in string. Replaces non-word characters and periods with hyphens.

Params

  • string {String}
  • returns {String}

Example

{{dashcase "a-b-c d_e"}}
<!-- results in:  'a-b-c-d-e' -->

{{dotcase}}

dot.case the characters in string.

Params

  • string {String}
  • returns {String}

Example

{{dotcase "a-b-c d_e"}}
<!-- results in:  'a.b.c.d.e' -->

{{downcase}}

Lowercase all of the characters in the given string. Alias for lowercase.

Params

  • string {String}
  • returns {String}

Example

{{downcase "aBcDeF"}}
<!-- results in:  'abcdef' -->

{{ellipsis}}

Truncates a string to the specified length, and appends it with an elipsis, ….

Params

  • str {String}
  • length {Number}: The desired length of the returned string.
  • returns {String}: The truncated string.

Example

{{ellipsis (sanitize "<span>foo bar baz</span>"), 7}}
<!-- results in:  'foo bar…' -->
{{ellipsis "foo bar baz", 7}}
<!-- results in:  'foo bar…' -->

{{hyphenate}}

Replace spaces in a string with hyphens.

Params

  • str {String}
  • returns {String}

Example

{{hyphenate "foo bar baz qux"}}
<!-- results in:  "foo-bar-baz-qux" -->

{{isString}}

Return true if value is a string.

Params

  • value {String}
  • returns {Boolean}

Example

{{isString "foo"}}
<!-- results in:  'true' -->

{{lowercase}}

Lowercase all characters in the given string.

Params

  • str {String}
  • returns {String}

Example

{{lowercase "Foo BAR baZ"}}
<!-- results in:  'foo bar baz' -->

{{occurrences}}

Return the number of occurrences of substring within the given string.

Params

  • str {String}
  • substring {String}
  • returns {Number}: Number of occurrences

Example

{{occurrences "foo bar foo bar baz" "foo"}}
<!-- results in:  2 -->

{{pascalcase}}

PascalCase the characters in string.

Params

  • string {String}
  • returns {String}

Example

{{pascalcase "foo bar baz"}}
<!-- results in:  'FooBarBaz' -->

{{pathcase}}

path/case the characters in string.

Params

  • string {String}
  • returns {String}

Example

{{pathcase "a-b-c d_e"}}
<!-- results in:  'a/b/c/d/e' -->

{{plusify}}

Replace spaces in the given string with pluses.

Params

  • str {String}: The input string
  • returns {String}: Input string with spaces replaced by plus signs

Example

{{plusify "foo bar baz"}}
<!-- results in:  'foo+bar+baz' -->

{{prepend}}

Prepends the given string with the specified prefix.

Params

  • str {String}
  • prefix {String}
  • returns {String}

Example

<!-- given that "val" is "bar" -->
{{prepend val "foo-"}}
<!-- results in:  'foo-bar' -->

{{raw}}

Render a block without processing mustache templates inside the block.

Params

  • options {Object}
  • returns {String}

Example

{{{{#raw}}}}
{{foo}}
{{{{/raw}}}}
<!-- results in:  '{{foo}}' -->

{{remove}}

Remove all occurrences of substring from the given str.

Params

  • str {String}
  • substring {String}
  • returns {String}

Example

{{remove "a b a b a b" "a "}}
<!-- results in:  'b b b' -->

{{removeFirst}}

Remove the first occurrence of substring from the given str.

Params

  • str {String}
  • substring {String}
  • returns {String}

Example

{{remove "a b a b a b" "a"}}
<!-- results in:  ' b a b a b' -->

{{replace}}

Replace all occurrences of substring a with substring b.

Params

  • str {String}
  • a {String}
  • b {String}
  • returns {String}

Example

{{replace "a b a b a b" "a" "z"}}
<!-- results in:  'z b z b z b' -->

{{replaceFirst}}

Replace the first occurrence of substring a with substring b.

Params

  • str {String}
  • a {String}
  • b {String}
  • returns {String}

Example

{{replace "a b a b a b" "a" "z"}}
<!-- results in:  'z b a b a b' -->

{{reverse}}

Reverse a string.

Params

  • str {String}
  • returns {String}

Example

{{reverse "abcde"}}
<!-- results in:  'edcba' -->

{{sentence}}

Sentence case the given string

Params

  • str {String}
  • returns {String}

Example

{{sentence "hello world. goodbye world."}}
<!-- results in:  'Hello world. Goodbye world.' -->

{{snakecase}}

snake_case the characters in the given string.

Params

  • string {String}
  • returns {String}

Example

{{snakecase "a-b-c d_e"}}
<!-- results in:  'a_b_c_d_e' -->

{{split}}

Split string by the given character.

Params

  • string {String}: The string to split.
  • returns {String} character: Default is an empty string.

Example

{{split "a,b,c" ","}}
<!-- results in:  ['a', 'b', 'c'] -->

{{startsWith}}

Tests whether a string begins with the given prefix.

Params

  • prefix {String}
  • testString {String}
  • options {String}
  • returns {String}

Example

{{#startsWith "Goodbye" "Hello, world!"}}
  Whoops
{{else}}
  Bro, do you even hello world?
{{/startsWith}}

{{titleize}}

Title case the given string.

Params

  • str {String}
  • returns {String}

Example

{{titleize "this is title case"}}
<!-- results in:  'This Is Title Case' -->

{{trim}}

Removes extraneous whitespace from the beginning and end of a string.

Params

  • string {String}: The string to trim.
  • returns {String}

Example

{{trim " ABC "}}
<!-- results in:  'ABC' -->

{{trimLeft}}

Removes extraneous whitespace from the beginning of a string.

Params

  • string {String}: The string to trim.
  • returns {String}

Example

{{trim " ABC "}}
<!-- results in:  'ABC ' -->

{{trimRight}}

Removes extraneous whitespace from the end of a string.

Params

  • string {String}: The string to trim.
  • returns {String}

Example

{{trimRight " ABC "}}
<!-- results in:  ' ABC' -->

{{truncate}}

Truncate a string to the specified length. Also see ellipsis.

Params

  • str {String}
  • limit {Number}: The desired length of the returned string.
  • suffix {String}: Optionally supply a string to use as a suffix to denote when the string has been truncated. Otherwise an ellipsis (…) will be used.
  • returns {String}: The truncated string.

Example

truncate("foo bar baz", 7);
<!-- results in:  'foo bar' -->
truncate(sanitize("<span>foo bar baz</span>", 7));
<!-- results in:  'foo bar' -->

{{truncateWords}}

Truncate a string to have the specified number of words. Also see truncate.

Params

  • str {String}
  • limit {Number}: The desired length of the returned string.
  • suffix {String}: Optionally supply a string to use as a suffix to denote when the string has been truncated.
  • returns {String}: The truncated string.

Example

truncateWords("foo bar baz", 1);
<!-- results in:  'foo…' -->
truncateWords("foo bar baz", 2);
<!-- results in:  'foo bar…' -->
truncateWords("foo bar baz", 3);
<!-- results in:  'foo bar baz' -->

{{upcase}}

Uppercase all of the characters in the given string. Alias for uppercase.

Params

  • string {String}
  • returns {String}

Example

{{upcase "aBcDeF"}}
<!-- results in:  'ABCDEF' -->

{{uppercase}}

Uppercase all of the characters in the given string. If used as a block helper it will uppercase the entire block. This helper does not support inverse blocks.

Params

  • str {String}: The string to uppercase
  • options {Object}: Handlebars options object
  • returns {String}

Example

{{uppercase "aBcDeF"}}
<!-- results in:  'ABCDEF' -->

url

{{encodeURI}}

Encodes a Uniform Resource Identifier (URI) component by replacing each instance of certain characters by one, two, three, or four escape sequences representing the UTF-8 encoding of the character.

Params

  • str {String}: The un-encoded string
  • returns {String}: The endcoded string

{{escape}}

Escape the given string by replacing characters with escape sequences. Useful for allowing the string to be used in a URL, etc.

Params

  • str {String}
  • returns {String}: Escaped string.

{{decodeURI}}

Decode a Uniform Resource Identifier (URI) component.

Params

  • str {String}
  • returns {String}

{{url_encode}}

Alias for encodeURI.

{{url_decode}}

Alias for decodeURI.

{{urlResolve}}

Take a base URL, and a href URL, and resolve them as a browser would for an anchor tag.

Params

  • base {String}
  • href {String}
  • returns {String}

{{urlParse}}

Parses a url string into an object.

Params

  • str {String}: URL string
  • returns {String}: Returns stringified JSON

{{stripQuerystring}}

Strip the query string from the given url.

Params

  • url {String}
  • returns {String}: the url without the queryString

{{stripProtocol}}

Strip protocol from a url. Useful for displaying media that may have an 'http' protocol on secure connections.

Params

  • str {String}
  • returns {String}: the url with http protocol stripped

Example

<!-- url = 'http://foo.bar' -->
{{stripProtocol url}}
<!-- results in: '//foo.bar' -->

Utils

The following utils are exposed on .utils.

{{changecase}}

Change casing on the given string, optionally passing a delimiter to use between words in the returned string.

Params

  • string {String}: The string to change.
  • returns {String}

Example

utils.changecase('fooBarBaz');
//=> 'foo bar baz'

utils.changecase('fooBarBaz' '-');
//=> 'foo-bar-baz'

{{random}}

Generate a random number

Params

  • min {Number}
  • max {Number}
  • returns {Number}

History

v0.10.0 - 2017-11-17

changes

  • adds unique to array helpers
  • updates css helper to ensure that path.join() is not called on an absolute URL.

v0.9.0 - 2017-07-03

changes

  • all unit tests now use assert instead of should
  • remove fileSize helper in favor of new bytes helper, which does the same thing, but returns B instead of byte or bytes.
  • JSONParse helper is no longer a block helper. It now returns an object, which can be used as a subexpression to achieve the same behavior as before.
  • adds better error handling for path helpers, since node.js errors are terrible. We have a better way to handle errors that will be implemented in a near future release.
  • adds inline helper support to isEmpty, so it can now be used as an inline or block helper
  • adds raw helper
  • adds regex helpers
  • adds inline helper support to most of the comparison helpers, so they can now be used as inline or block helpers
  • adds pluck helper to array helpers
  • adds prepend and append helpers to string helpers
  • adds isTruthy and isFalsey comparison helpers
  • adds escape and url_encode and url_decode URL helpers
  • adds attr helper to html helpers
  • adds year helper to date helpers
  • adds typeOf and frame helpers to misc helpers
  • adds abs, minus, modulo, plus, times to math helpers
  • moves ellipsis helper from html helpers to string helpers
  • moves truncate helper from html helpers to string helpers
  • moves reverse helper from string helpers to array helpers
  • differentiate eq and is helpers so that eq is strict equality and is is not
  • removes mm helper, use match instead

v0.8.4 - 2017-07-03

changes

  • removes strlen helper in favor of fixing the length helper

v0.8.3 - 2017-07-03

changes

  • adds strlen helper
  • adds itemAt helper
  • clean up code comments for array helpers

v0.8.2 - 2017-03-30

changes

  • documentation updates
  • fixes md helper to use sync by default

v0.8.1 - 2017-03-30

changes

  • fixes sorting in withSort helper. see #245
  • adds toPath helper
  • handle null inputs in number helpers
  • adds stripProtocol helper

v0.8.0 - 2017-01-25

changes

  • handle string arguments in list helpers
  • adds JSONParse helper as an alias for parseJSON

v0.7.6 - 2017-01-08

changes

  • fixes markdown helpers. see #226
  • documentation improvements and other minor fixes

v0.7.0 - 2016-07-16

changes

  • The or helper can now take a variable number of arguments

v0.6.0 - 2016-05-13

changes

  • the main export is now a function that takes a name or array of names of helper types to load. Example helpers(['string', 'array']) will load only the string and array helpers
  • helper types can alternatively be accessed as methods. example - helpers.path() will return all of the path helpers.
  • handlebars may be provided by the user. if not provided it will fall back to the handlebars-helpers handlebars
  • helpers are now as generic as possible, with little to no code related to assemble, grunt, etc.
  • helpers are lazy-loaded using getters for improved performance
  • Once tests are added for the md and markdown helpers, we'll have 100% unit test coverage on helpers

v0.3.3 - 2013-09-03

changes

  • Adds fileSize helper.
  • Adds startsWith helper.

v0.3.2 - 2013-08-20

changes

  • Adds glob helper.

v0.3.0 - 2013-07-30

changes

  • The project has been refactored, cleaned up, and full documentation has bee put up at http://assemble.io

v0.2.4 - 2013-05-11

changes

  • Adding object globbing utility functions to be used in helpers later.

v0.2.3 - 2013-05-11

changes

  • File globbing added to some helpers. Including md and some file helpers.

v0.2.0 - 2013-05-07

changes

  • A bunch of new tests for markdown and special helpers.
  • Refactored most of the rest of the helpers to separate functions from Handlebars registration.

v0.1.32 - 2013-05-02

changes

  • Updates utils and a number of helpers, including value, property, and stringify.

v0.1.31 - 2013-04-21

changes

  • Fixes relative helper

v0.1.30 - 2013-04-20

changes

  • Refactoring helpers-collection module to separate the functions from the Handlebars helper registration process.

v0.1.25 - 2013-04-16

changes

  • Adding defineSection and renderSection helpers to try to get sections populated in a layout from the page.

v0.1.21 - 2013-04-07

changes

  • Add markdown helpers back, add more tests.

v0.1.20 - 2013-04-06

changes

  • Generalized helpers structure, externalized utilities.

v0.1.11 - 2013-04-05

changes

  • New authors and gist helpers, general cleanup and new tests.

v0.1.10 - 2013-04-04

changes

  • Externalized utility javascript from helpers.js

v0.1.8 - 2013-03-28

changes

  • Gruntfile updated with mocha tests for 71 helpers, bug fixes.

v0.1.7 - 2013-03-18

changes

  • New path helper 'relative', for resolving relative path from one absolute path to another.

v0.1.3 - 2013-03-16

changes

  • New helpers, 'formatPhoneNumber' and 'eachProperty'

v0.1.2 - 2013-03-15

changes

  • Update README.md with documentation, examples.

[v0.1.0] - 2013-03-06

changes

  • First commit.

About

Related projects

  • assemble: Get the rocks out of your socks! Assemble makes you fast at creating web projects… more | homepage
  • template-helpers: Generic JavaScript helpers that can be used with any template engine. Handlebars, Lo-Dash, Underscore, or… more | homepage
  • utils: Fast, generic JavaScript/node.js utility functions. | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Contributors

Release history

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

Brian Woodward

Jon Schlinkert

License

Copyright © 2017, Jon Schlinkert. When this project was created some helpers were sourced from Swag, by Elving Rodriguez. Released under the MIT License.

This file was generated by verb-generate-readme, v0.6.0, on November 17, 2017.

More Repositories

1

helper-markdown

Markdown template helper. Uses remarkable to render markdown in templates. Should work with Handlebars, Lo-Dash or any template engine that supports helper functions.
JavaScript
38
star
2

handlebars-helper-repeat

{{repeat}} handlebars helper, for duplicating a block of content n times.
JavaScript
26
star
3

handlebars-helper-prettify

{{prettify}} handlebars helper, for formatting ("beautifying") HTML, CSS and JavaScript.
JavaScript
20
star
4

handlebars-helper-moment

{{moment}} handlebars helper. Combines the powers of Assemble, Handlebars.js and Moment.js into a great helper to master time.
HTML
19
star
5

handlebars-helper-partial

Handlebars helper, alternative to built-in partials. Like Assemble itself, this helper will automatically determine the correct context to use, or a context may be explicitly passed in as a second parameter.
JavaScript
16
star
6

handlebars-helper-include

Handlebars helper, alternative to built-in partials. Similar to handlebars-helper-partial, but this helper will allow wildcard (glob) patterns. Like Assemble itself, this helper will automatically determine the correct context to use, or a context may be explicitly passed in as a second parameter.
JavaScript
16
star
7

handlebars-helper-minify

{{minify}} handlebars helper, for minification of HTML with html-minifier.
JavaScript
15
star
8

handlebars-helpers-examples

Shows how to use helpers from handlebars-helpers with Assemble.
CoffeeScript
12
star
9

logging-helpers

Basic template helpers for printing messages out to the console. Useful for debugging context in templates. Should work with any template engine.
JavaScript
10
star
10

handlebars-helper-compose

{{compose}} handlebars helper. Similar to {{aggregate}}, but this is a block helper that extends the inner block's content with content from "external" files, while also extending the context with YAML front matter from those files. You may also optionally use wildcard (glob/minimatch) patterns.
JavaScript
10
star
11

liquid-filters

Liquid filters written in vanilla JavaScript, allowing them to be used with any template engine. WIP! Star/watch the project for updates.
JavaScript
8
star
12

example-pagination

Nothing to see yet, this repo will eventually contain examples and boilerplate code for adding paging and pagination to your projects with Assemble.
CSS
8
star
13

helper-html-table

Create an HTML table from JSON configuration.
JavaScript
7
star
14

handlebars-helper-i18n

Handlebars helper for i18n.
JavaScript
7
star
15

handlebars-helper-analytics

Handlebars helper for adding Google Analytics scripts to the head and/or footer of a webpage
JavaScript
7
star
16

handlebars-utils

Utils for handlebars helpers. Externalized from handlebars, to allow helpers to use the utils without having to depend on handlebars itself.
JavaScript
7
star
17

handlebars-helper-md

A new and improved {{md}] helper! Convert markdown to HTML. Use wildcard (glob) patterns for files. Like Assemble itself, this helper will automatically determine the correct context to use, or a context may be explicitly passed in as a second parameter.
JavaScript
7
star
18

helper-date

Format dates with date.js and moment.js. Uses date.js to parse human readable date phrases, and moment to format the rendered output. Should work with any Handlebars, Lo-Dash, underscore, or any template engine that allows helper functions to be registered. Also compatible with verb, assemble and Template.
JavaScript
7
star
19

generator-helper

Use yeoman to generate a handlebars helper that can easily be used with Assemble.
JavaScript
6
star
20

handlebars-helper-isActive

{{isactive}} handlebars helper. Adds an 'active' class to the 'current page'. Class can be customized.
JavaScript
6
star
21

helper-copyright

Template helper for adding a basic, one-line copyright statement, with formatting appropriate for LICENSE/LICENSE-MIT or README templates. Should work with any Handlebars, Lo-Dash, underscore, or any template engine that allows helper functions to be registered.
JavaScript
6
star
22

handlebars-helper-paginate

{{paginate}} handlebars helper. Made for Assemble, the static site generator for Node.js, Grunt.js and Yeoman.
JavaScript
6
star
23

helper-changelog

Template helper for generating a markdown-formatted changelog from an object, array or yaml file. Should work with Handlebars or Lo-Dash or any engine with support for helper functions.
JavaScript
6
star
24

helper-related

Template helper for generating a list of links to the homepages of related GitHub/npm projects.
JavaScript
5
star
25

handlebars-helper-asset

Handlebars helper for generating a relative path from the current file to the specified asset (CSS, JavaScript, image, icon etc.).
JavaScript
5
star
26

template-helper-apidocs

Template helper for automatically generating API docs from code comments. This is based on helper-apidocs, but specifically for applications built-with the Template library.
JavaScript
5
star
27

helper-geopattern

Template helper for generating a geometric SVG pattern for CSS backgrounds using btmills/geopattern
JavaScript
5
star
28

helper-uigradient

Template helper that generates the CSS for any of the gradients from Ghosh/uiGradients
JavaScript
5
star
29

handlebars-helper-lorem

{{lorem}} handlebars helper, for generating lorem lorem placeholder text.
JavaScript
5
star
30

handlebars-helper-aggregate

{{aggregate}} handlebars helper. inlines content from multiple files optionally using wildcard (globbing/minimatch) patterns. uses YAML front matter as context for each file. optionally pass in a sorting function.
JavaScript
5
star
31

helper-reflinks

Template helper for generating a list of markdown formatted reference links for all of the dependencies and devDependencies listed in package.json.
JavaScript
5
star
32

helper-apidocs

Template helper for automatically generating API docs from code comments. The sync version works with handlebars, lo-dash, or any template engine that supports helper functions.
JavaScript
5
star
33

task-utils

Utils for grunt.js projects.
JavaScript
4
star
34

handlebars-helper-disqus

{{disqus}} Handlebars helper. Simplifies adding [Disqus](https://disqus.com/) comments to your site.
JavaScript
4
star
35

handlebars-helpers-yfm

Helpers and examples for extracting, parsing, and passing context from YAML front matter into your templates. Useful if you need custom programming beyond what Assemble offers by default.
JavaScript
4
star
36

helpers-utils

DEPRECATED
JavaScript
4
star
37

helper-collection

Async collection helper for assemble.
JavaScript
4
star
38

handlebars-helper-jade

{{jade}} handlebars helper, for converting basic Jade templates to HTML.
JavaScript
4
star
39

helper-md

Markdown template helper. Uses remarkable to render markdown in templates. Should work with Handlebars, Lo-Dash or any template engine that supports helper functions.
JavaScript
4
star
40

helper-link-to

Templates helper that returns a link path from the current view to the another view.
JavaScript
4
star
41

helper-resolve

Template helper to resolve the path to a file in node_modules. This is mostly useful during development.
JavaScript
4
star
42

helper-octicon

Template helper for displaying octicon SVGs. Should work with any Handlebars, Lo-Dash, underscore or any template engine that allows helper functions to be registered. Also compatible with verb, assemble, and templates.
JavaScript
3
star
43

meta

General planning around helpers. Also the place to make requests and suggestions.
3
star
44

handlebars-helper-ghbtns

{{ghbtn}} handlebars helper. Add github buttons (http://ghbtns.com) to your site.
JavaScript
3
star
45

handlebars-helper-slugify

Convert strings into URL slugs.
JavaScript
3
star
46

handlebars-helper-uml

Embed UML diagrams in your handlebars template using www.websequencediagrams.com
JavaScript
3
star
47

helper-issue

Helper to create a URL that pre-populates a Github issue.
JavaScript
3
star
48

handlebars-helper-sitemap

Handlebars helpers and templates for generating a sitemap.
JavaScript
3
star
49

handlebars-helper-less

{{less}} handlebars helper. This helper allows you to use LESS inside style tags in your HTML. By default, the resulting CSS will be rendered inside the `<style>...</style>` tags of the rendered HTML, but you may alternatively define a destination path using the `dest` hash option of the helper.
JavaScript
3
star
50

helper-license

Template helper for dynamically generating a basic, one-line license statement based on the given context, e.g. `Released under the MIT license`. Should work with any Handlebars, Lo-Dash, underscore, or any template engine that allows helper functions to be registered.
JavaScript
3
star
51

helper-slugify

Slugify a URL, path or heading the same way that GitHub formats heading anchors.
JavaScript
2
star
52

handlebars-helper-rel

Handlebars helper for generating a relative link from the current page to the specified page.
JavaScript
2
star
53

handlebars-helper-condense

Remove extra newlines from HTML content.
JavaScript
2
star
54

requests

Guidelines for requesting or contributing new helpers to the helpers org.
2
star
55

handlebars-helper-autolink

{{autolink}} handlebars helper. Generate relative links from the "current page" to other dest pages.
JavaScript
2
star
56

helper-front-matter

Template helper for parsing front matter and passing the data to templates as context.
JavaScript
2
star
57

node-name

Basic utility methods for transforming and handling file paths.
JavaScript
2
star
58

handlebars-helper-unsplash

Handlebars helper to create image tags with unsplash.it properties.
JavaScript
2
star
59

handlebars-helper-variable

Handlebars block helper that adds variables to the context that can be used by following expressions in the same template.
JavaScript
2
star
60

helper-toc

Template helper for generating a table of contents using content from the file in which the helper is used, or for a glob of files.
JavaScript
2
star
61

handlebars-helper-post

{{post}} handlebars helper, for including a post, or a list of posts.
JavaScript
2
star
62

handlebars-helper-npm-downloads

Get the npm download counts for the specified repository.
JavaScript
2
star
63

helper-sort-items

Helper for filtering and sorting an assemble collection based on an array of strings.
JavaScript
2
star
64

async-helper-base

Used for creating template.js-compatible async helpers. Works with verb, assemble or any other template.js application.
JavaScript
2
star
65

strip-yfm

Strip YAML front matter from files.
JavaScript
2
star
66

helper-example

Opinionated template helper that inserts a code example from a filepath.
JavaScript
2
star
67

handlebars-helper-eachitems

{{eachItems}} handlebars helper.
JavaScript
2
star
68

helper-compile-async

Convenience method to compile async helpers and add common functionality to use with async-helpers.
JavaScript
2
star
69

handlebars-helper-feed

Handlebars helper for generating entries for RSS or atom feeds.
JavaScript
2
star
70

handlebars-helper-each

Handlebars each helper, can be used as a sync helper with any handlebars project (as normal) or as an async helper with assemble or libs that support async helpers.
JavaScript
2
star
71

helper-npm-downloads

Get the npm download counts for the specified repository.
JavaScript
2
star
72

helper-lookup-deps

Template helper for generating a list of markdown formatted reference links to Github repos for the tree of dependencies and devDependencies listed in package.json.
JavaScript
2
star
73

helper-dateformat

Date helper that uses node-dateformat to format dates. Works with Lo-Dash, Handlebars or any template engine that supports helper functions.
JavaScript
2
star
74

handlebars-helper-not

{{not}} handlebars helper. Conditionally render a block if the condition is false. This block helper is really just a semantic alternative to {{isnt}}
JavaScript
2
star
75

handlebars-helper-create-frame

Handlebars block helper for creating private variables that are accessible inside the block.
JavaScript
1
star
76

handlebars-helper-track

{{track}} handlebars helper. Simplify the process of adding Google analytics tracking codes to your web projects.
JavaScript
1
star
77

helper-concat

Template helper for concatenating a list of files using glob patterns. Should work with handlebars, lodash or any template engine that allows helper functions.
JavaScript
1
star
78

helper-lorem

Template helper for generator lorem-ipsum placeholder text. Should work with any template engine.
JavaScript
1
star
79

helper-ask-include

Async template helper that prompts the user to choose the `include` or `includes` to render.
JavaScript
1
star
80

handlebars-helper-pkg

{{pkg}} handlebars helper, for retrieving a value from your project's package.json
JavaScript
1
star
81

helper-glob

Template helper for globbing files. Works with handlebars, Lo-Dash or any template engine that supports helper functions.
JavaScript
1
star
82

helper-timeago

Date helper for displaying elapsed time in a human-readable format. Can be used as a JavaScript utility or template helper with handlebars, lo-dash or any template engine that supports helper functions.
JavaScript
1
star
83

handlebars-helper-br

{{br}} Handlebars helper. Adds `<br>` tags to generated HTML. Great for prototyping.
JavaScript
1
star
84

helper-glob-files

Generic template helper for creating an array of vinyl file objects from a glob pattern.
JavaScript
1
star
85

grunt-init-helper-mod

Grunt init template for creating a new helper module.
JavaScript
1
star
86

helper-git-hash

Template helper for getting the most recent commit hash from git history.
JavaScript
1
star
87

helper-require

Use any node module as a helper in templates. Should work with Handlebars, Lo-Dash, underscore, or any template engine that supports helper functions.
JavaScript
1
star
88

helper-read

Template helper for reading from the file system. Includes both async and sync versions.
JavaScript
1
star
89

handlebars-helper-twitter

Add {{tweet}} and {{follow}} buttons using handlebars helpers.
JavaScript
1
star
90

helper-ask

Async helper that prompts the user for a value and uses the answer as context for rendering the template.
JavaScript
1
star
91

helper-codelinks

Generate a list of links that take you to the first line of code for each method in a given directory. (this helper will replace verb-helper-reflinks)
JavaScript
1
star
92

helper-year

Template helper for adding the current year. Good for adding dates for licenses, copyrights, last modified date, comment dates, etc. Works with handlebars, lo-dash or any template engine that has support for helper functions.
JavaScript
1
star