@budibase/handlebars-helpers

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.

- Install
- Usage
- Helpers
- Utils
- History
- About

Install

Install with yarn:

``sh
$ yarn add @budibase/handlebars-helpers
`

Usage

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

Get all helpers

`js
var helpers = require('@budibase/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.

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

var helpers = require('@budibase/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.

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

Optionally pass your own handlebars

`js
var handlebars = require('handlebars');
var helpers = require('@budibase/handlebars-helpers')({
handlebars: handlebars
});

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

Helpers

Categories

Currently 189 helpers in 20 categories:

* array (code | unit tests)
* code (code | unit tests)
* collection (code | unit tests)
* comparison (code | unit tests)
* html (code | unit tests)
* i18n (code | unit tests)
* inflection (code | unit tests)
* match (code | unit tests)
* math (code | unit tests)
* misc (code | unit tests)
* number (code | unit tests)
* object (code | unit tests)
* path (code | unit tests)
* regex (code | unit tests)
* string (code | unit tests)
* url (code | unit tests)

All helpers

$3

Visit the: code | unit tests | issues)

* after (code | tests)
* arrayify (code | tests)
* before (code | tests)
* eachIndex (code | tests)
* filter (code | tests)
* first (code | tests)
* forEach (code | tests)
* inArray (code | tests)
* isArray (code | tests)
* itemAt (code | tests)
* join (code | tests)
* equalsLength (code | [no tests])
* last (code | tests)
* length (code | tests)
* lengthEqual (code | tests)
* map (code | tests)
* pluck (code | tests)
* reverse (code | [no tests])
* some (code | tests)
* sort (code | tests)
* sortBy (code | tests)
* withAfter (code | tests)
* withBefore (code | tests)
* withFirst (code | tests)
* withGroup (code | tests)
* withLast (code | tests)
* withSort (code | tests)
* unique (code | tests)

$3

Visit the: code | unit tests | issues)

* embed (code | tests)
* gist (code | tests)
* jsfiddle (code | tests)

$3

Visit the: code | unit tests | issues)

* isEmpty (code | tests)
* iterate (code | tests)

$3

Visit the: code | unit tests | issues)

* and (code | tests)
* compare (code | tests)
* contains (code | tests)
* default (code | tests)
* eq (code | tests)
* gt (code | tests)
* gte (code | tests)
* has (code | tests)
* isFalsey (code | tests)
* isTruthy (code | tests)
* ifEven (code | tests)
* ifNth (code | tests)
* ifOdd (code | tests)
* is (code | tests)
* isnt (code | tests)
* lt (code | tests)
* lte (code | tests)
* neither (code | tests)
* not (code | [no tests])
* or (code | tests)
* unlessEq (code | tests)
* unlessGt (code | tests)
* unlessLt (code | tests)
* unlessGteq (code | tests)
* unlessLteq (code | tests)

$3

Visit the: code | unit tests | issues)

* attr (code | tests)
* css (code | tests)
* js (code | tests)
* sanitize (code | tests)
* ul (code | tests)
* ol (code | tests)
* thumbnailImage (code | tests)

$3

Visit the: code | unit tests | issues)

* i18n (code | tests)

$3

Visit the: code | unit tests | issues)

* inflect (code | tests)
* ordinalize (code | tests)

$3

Visit the: code | unit tests | issues)

* match (code | tests)
* isMatch (code | tests)
* mm (code | [no tests])

$3

Visit the: code | unit tests | issues)

* abs (code | [no tests])
* add (code | tests)
* avg (code | [no tests])
* ceil (code | tests)
* divide (code | tests)
* floor (code | tests)
* minus (code | [no tests])
* modulo (code | [no tests])
* multiply (code | tests)
* plus (code | [no tests])
* random (code | tests)
* remainder (code | tests)
* round (code | tests)
* subtract (code | tests)
* sum (code | tests)

$3

Visit the: code | unit tests | issues)

* frame (code | [no tests])
* option (code | tests)
* noop (code | tests)
* typeOf (code | [no tests])
* withHash (code | tests)

$3

Visit the: code | unit tests | issues)

* bytes (code | tests)
* addCommas (code | tests)
* phoneNumber (code | tests)
* toAbbr (code | tests)
* toExponential (code | tests)
* toFixed (code | tests)
* toFloat (code | tests)
* toInt (code | tests)
* toPrecision (code | tests)

$3

Visit the: code | unit tests | issues)

* extend (code | tests)
* forIn (code | tests)
* forOwn (code | tests)
* toPath (code | tests)
* get (code | tests)
* getObject (code | tests)
* hasOwn (code | tests)
* isObject (code | tests)
* JSONparse (code | tests)
* JSONstringify (code | [no tests])
* merge (code | tests)
* parseJSON (code | [no tests])
* pick (code | tests)
* stringify (code | tests)

$3

Visit the: code | unit tests | issues)

* absolute (code | tests)
* dirname (code | tests)
* relative (code | tests)
* basename (code | tests)
* stem (code | tests)
* extname (code | tests)
* resolve (code | [no tests])
* segments (code | tests)

$3

Visit the: code | unit tests | issues)

* toRegex (code | [no tests])
* test (code | [no tests])

$3

Visit the: code | unit tests | issues)

* append (code | [no tests])
* camelcase (code | tests)
* capitalize (code | tests)
* capitalizeAll (code | tests)
* center (code | tests)
* chop (code | tests)
* dashcase (code | tests)
* dotcase (code | tests)
* downcase (code | [no tests])
* ellipsis (code | tests)
* hyphenate (code | tests)
* isString (code | tests)
* lowercase (code | tests)
* occurrences (code | tests)
* pascalcase (code | tests)
* pathcase (code | tests)
* plusify (code | tests)
* prepend (code | [no tests])
* raw (code | [no tests])
* remove (code | [no tests])
* removeFirst (code | [no tests])
* replace (code | tests)
* replaceFirst (code | [no tests])
* reverse (code | tests)
* sentence (code | tests)
* snakecase (code | tests)
* split (code | tests)
* startsWith (code | tests)
* titleize (code | tests)
* trim (code | tests)
* trimLeft (code | [no tests])
* trimRight (code | [no tests])
* truncate (code | tests)
* truncateWords (code | [no tests])
* upcase (code | [no tests])
* uppercase (code | tests)

$3

Visit the: code | unit tests | issues)

* encodeURI (code | tests)
* escape (code | [no tests])
* decodeURI (code | tests)
* urlResolve (code | tests)
* urlParse (code | tests)
* stripQuerystring (code | tests)
* stripProtocol (code | [no tests])

*

array

$3

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

`handlebars

{{after array 1}}

`

$3

Cast the given value to an array.

Params

* value {any}
* returns {Array}

Example

`handlebars
{{arrayify "foo"}}

`

$3

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

`handlebars

{{before array 2}}

`

$3

Params

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

Example

`handlebars

{{#eachIndex array}}
{{item}} is {{index}}
{{/eachIndex}}
`

$3

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

`handlebars

{{#filter array "foo"}}AAA{{else}}BBB{{/filter}}

`

$3

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

`handlebars
{{first "['a', 'b', 'c', 'd', 'e']" 2}}

`

$3

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

`handlebars


{{#forEach accounts}}

{{ name }}
{{#unless isLast}}, {{/unless}}
{{/forEach}}
`

$3

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

`handlebars

{{#inArray array "d"}}
foo
{{else}}
bar
{{/inArray}}

`

$3

Returns true if value is an es5 array.

Params

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

Example

`handlebars
{{isArray "abc"}}



{{isArray array}}

`

$3

Returns the item from array at index idx.

Params

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

Example

`handlebars

{{itemAt array 1}}

`

$3

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

`handlebars

{{join array}}


{{join array '-'}}

`

$3

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}

$3

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

`handlebars


{{last value}}


{{last value 2}}


{{last value 3}}

`

$3

Returns the length of the given string or array.

Params

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

Example

`handlebars
{{length '["a", "b", "c"]'}}



{{length myArray}}



{{length myObject}}

`

$3

Alias for equalsLength

$3

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

`handlebars

{{map array double}}

`

$3

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

`handlebars
// {{pluck items "data.title"}}

`

$3

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

`handlebars

{{reverse value}}


{{reverse value}}

`

$3

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

`handlebars

{{#some array isString}}
Render me if the array has a string.
{{else}}
Render me if it doesn't.
{{/some}}

`

$3

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

`handlebars

{{sort array}}

`

$3

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

`handlebars

{{sortBy array "a"}}

`

$3

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

`handlebars

{{#withAfter array 3}}
{{this}}
{{/withAfter}}

`

$3

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

`handlebars

{{#withBefore array 3}}
{{this}}
{{/withBefore}}

`

$3

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

`handlebars

{{#withFirst array}}
{{this}}
{{/withFirst}}

`

$3

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

`handlebars

{{#withGroup array 4}}
{{#each this}}
{{.}}
{{each}}


{{/withGroup}}



`

$3

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

`handlebars

{{#withLast array}}
{{this}}
{{/withLast}}

`

$3

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

`handlebars

{{#withSort array}}{{this}}{{/withSort}}

`

$3

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

`handlebars

{{#each (unique array)}}{{.}}{{/each}}

`

code

$3

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

`handlebars
{{embed 'path/to/file.js'}}

{{embed 'path/to/file.hbs' 'html')}}
`

$3

Embed a GitHub Gist using only the id of the Gist

Params

* id {String}
* returns {String}

Example

`handlebars
{{gist "12345"}}
`

$3

Generate the HTML for a jsFiddle link with the given params

Params

* params {Object}
* returns {String}

Example

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

collection

$3

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

`handlebars

{{#isEmpty array}}AAA{{else}}BBB{{/isEmpty}}



{{isEmpty array}}

`

$3

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

$3

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

`handlebars

{{#and great magnificent}}A{{else}}B{{/and}}

`

$3

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.

$3

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

`handlebars

{{#contains array "d"}}
This will not be rendered.
{{else}}
This will be rendered.
{{/contains}}
`

$3

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

Params

* value {any}
* defaultValue {any}
* returns {String}

$3

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.

$3

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.

$3

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.

$3

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}

$3

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}

$3

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}

$3

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

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

$3

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.

$3

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

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

$3

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}

$3

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}

$3

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.

$3

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.

$3

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.

$3

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

Params

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

$3

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

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

$3

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.

$3

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.

$3

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.

$3

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.

$3

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.

html

$3

Stringify attributes on the options hash.

Params

* options {Object}
* returns {String}

Example

`handlebars