@budibase/handlebars-helpers
Advanced tools
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.
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 with yarn:
$ yarn add @budibase/handlebars-helpers
The main export returns a function that needs to be called to expose the object of helpers.
Get all helpers
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.
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.
var helpers = require('@budibase/handlebars-helpers')(['math', 'string']);
//=> only the `math` and `string` helpers
Optionally pass your own handlebars
var handlebars = require('handlebars');
var helpers = require('@budibase/handlebars-helpers')({
handlebars: handlebars
});
// or for a specific collection
var math = helpers.math({
handlebars: handlebars
});
Currently 189 helpers in 20 categories:
Visit the: code | unit tests | issues)
Visit the: code | unit tests | issues)
Visit the: code | unit tests | issues)
Visit the: code | unit tests | issues)
Visit the: code | unit tests | issues)
Visit the: code | unit tests | issues)
Visit the: code | unit tests | issues)
Visit the: code | unit tests | issues)
Visit the: code | unit tests | issues)
Visit the: code | unit tests | issues)
Visit the: code | unit tests | issues)
Visit the: code | unit tests | issues)
Visit the: code | unit tests | issues)
Visit the: code | unit tests | issues)
Visit the: code | unit tests | issues)
Visit the: code | unit tests | issues)
Returns all of the items in an array after the specified index. Opposite of before.
Params
array {Array}: Collectionn {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"]' -->
Cast the given value to an array.
Params
value {any}returns {Array}Example
{{arrayify "foo"}}
<!-- results in: [ "foo" ] -->
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"]' -->
Params
array {Array}options {Object}returns {String}Example
<!-- array: ['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h'] -->
{{#eachIndex array}}
{{item}} is {{index}}
{{/eachIndex}}
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' -->
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"]' -->
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:
indextotalisFirstisLast
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': 'john@example.com'},
{'name': 'Malcolm', 'email': 'malcolm@example.com'},
{'name': 'David', 'email': 'david@example.com'}
] -->
{{#forEach accounts}}
<a href="mailto:{{ email }}" title="Send an email to {{ name }}">
{{ name }}
</a>{{#unless isLast}}, {{/unless}}
{{/forEach}}
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' -->
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 -->
Returns the item from array at index idx.
Params
array {Array}idx {Number}returns {any} valueExample
<!-- array: ['a', 'b', 'c'] -->
{{itemAt array 1}}
<!-- results in: 'b' -->
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' -->
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}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'] -->
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 -->
Alias for equalsLength
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"]' -->
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 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'] -->
Block helper that returns the block if the callback returns true for some value in the given array.
Params
array {Array}iter {Function}: Iterateereturns {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 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"]' -->
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"}]' -->
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" -->
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' -->
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' -->
Block helper that groups array elements by given group size.
Params
array {Array}: The array to iterate oversize {Number}: The desired length of each array "group"options {Object}: Handlebars optionsreturns {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> -->
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' -->
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' -->
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' -->
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')}}
Embed a GitHub Gist using only the id of the Gist
Params
id {String}returns {String}Example
{{gist "12345"}}
Generate the HTML for a jsFiddle link with the given params
Params
params {Object}returns {String}Example
{{jsfiddle id="0dfk10ks" tabs="true"}}
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 -->
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 overoptions {Object}returns {String}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 objectreturns {String}Example
<!-- {great: true, magnificent: true} -->
{{#and great magnificent}}A{{else}}B{{/and}}
<!-- results in: 'A' -->
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 objectreturns {String}: Block, or if specified the inverse block is rendered if falsey.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}}
Returns the first value that is not undefined, otherwise the "default" value is returned.
Params
value {any}defaultValue {any}returns {String}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 objectreturns {String}: Block, or inverse block if specified and falsey.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 objectreturns {String}: Block, or inverse block if specified and falsey.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 objectreturns {String}: Block, or inverse block if specified and falsey.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 objectreturns {String}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}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}Return true if the given value is an even number.
Params
number {Number}options {Object}: Handlebars provided options objectreturns {String}: Block, or inverse block if specified and falsey.Example
{{#ifEven value}}
render A
{{else}}
render B
{{/ifEven}}
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
options {Object}: Handlebars provided options objectreturns {String}: Block, or inverse block if specified and falsey.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 objectreturns {String}: Block, or inverse block if specified and falsey.Example
{{#ifOdd value}}
render A
{{else}}
render B
{{/ifOdd}}
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 objectreturns {String}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 objectreturns {String}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 objectreturns {String}: Block, or inverse block if specified and falsey.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 objectreturns {String}: Block, or inverse block if specified and falsey.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 objectreturns {String}: Block, or inverse block if specified and falsey.Returns true if val is falsey. Works as a block or inline helper.
Params
val {String}options {Object}: Handlebars provided options objectreturns {String}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 argumentsoptions {Object}: Handlebars options objectreturns {String}: Block, or inverse block if specified and falsey.Example
{{#or a b c}}
If any value is true this will be rendered.
{{/or}}
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 objectreturns {String}: Inverse block by default, or block if falsey.Block helper that always renders the inverse block unless a is
is greater than b.
Params
a {Object}: The default valueb {Object}: The value to compareoptions {Object}: Handlebars provided options objectreturns {String}: Inverse block by default, or block if falsey.Block helper that always renders the inverse block unless a is
is less than b.
Params
a {Object}: The default valueb {Object}: The value to compareoptions {Object}: Handlebars provided options objectreturns {String}: Block, or inverse block if specified and falsey.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 objectreturns {String}: Block, or inverse block if specified and falsey.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 objectreturns {String}: Block, or inverse block if specified and falsey.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>
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"> -->
Generate one or more <script></script> tags with paths/urls to javascript or coffeescript files.
Params
context {Object}returns {String}Example
{{js scripts}}
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' -->
Block helper for creating unordered lists (<ul></ul>)
Params
context {Object}options {Object}returns {String}Block helper for creating ordered lists (<ol></ol>)
Params
context {Object}options {Object}returns {String}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 helper. See button-i18n for a working example.
Params
key {String}options {Object}returns {String}Returns either the singular or plural inflection of a word based on the given count.
Params
count {Number}singular {String}: The singular formplural {String}: The plural formincludeCount {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" -->
Returns an ordinalized number as a string.
Params
val {String}: The value to ordinalize.returns {String}: The ordinalized numberExample
{{ordinalize 1}}
<!-- '1st' -->
{{ordinalize 21}}
<!-- '21st' -->
{{ordinalize 29}}
<!-- '29th' -->
{{ordinalize 22}}
<!-- '22nd' -->
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 matchesExample
{{match (readdir "foo") "*.js"}}
{{match (readdir "foo") (toRegex "\\.js$")}}
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 -->
Return the magnitude of a.
Params
a {Number}returns {Number}Return the sum of a plus b.
Params
a {Number}b {Number}returns {Number}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' -->
Get the Math.ceil() of the given value.
Params
value {Number}returns {Number}Divide a by b
Params
a {Number}: numeratorb {Number}: denominatorGet the Math.floor() of the given value.
Params
value {Number}returns {Number}Return the difference of a minus b.
Params
a {Number}b {Number}Get the remainder of a division operation.
Params
a {Number}b {Number}returns {Number}Return the product of a multiply b.
Params
a {Number}: factorb {Number}: multiplierreturns {Number}Add a by b.
Params
a {Number}: factorb {Number}: multiplierGenerate a random number between two values
Params
min {Number}max {Number}returns {String}Get the remainder when a is divided by b.
Params
a {Number}: ab {Number}: bRound the given number.
Params
number {Number}returns {Number}Return the product of a minus b.
Params
a {Number}b {Number}returns {Number}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' -->
Params
a {Number}: factorb {Number}: multiplierreturns {Number}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` -->
Block helper that renders the block without taking any arguments.
Params
options {Object}returns {String}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'
Block helper that builds the context for the block from the options hash.
Params
options {Object}: Handlebars provided options object.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 B13661855 => 13.66 MB825399 => 825.39 kB1396 => 1.4 kBParams
number {Number|String}returns {String}Add commas to numbers
Params
num {Number}returns {Number}Convert a string or number to a formatted phone number.
Params
num {Number|String}: The phone number to format, e.g. 8005551212returns {Number}: Formatted phone number: (800) 555-1212Abbreviate numbers to the given number of precision. This is for
general numbers, not size in bytes.
Params
number {Number}precision {Number}returns {String}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}};
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'
Params
number {Number}returns {Number}Params
number {Number}returns {Number}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'
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}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}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}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}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 objectoptions {Object}: The handlebars options object, if used as a block helper.returns {String}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 objectreturns {String}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}}
Return true if value is an object.
Params
value {String}returns {Boolean}Example
{{isObject "foo"}}
//=> false
Parses the given string using JSON.parse.
Params
string {String}: The string to parseExample
<!-- string: '{"foo": "bar"}' -->
{{JSONparse string}}
<!-- results in: { foo: 'bar' } -->
Stringify an object using JSON.stringify.
Params
obj {Object}: Object to stringifyreturns {String}Example
<!-- object: { foo: 'bar' } -->
{{JSONstringify object}}
<!-- results in: '{"foo": "bar"}' -->
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 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.Get the directory path segment from the given filepath.
Params
ext {String}returns {String}Example
{{absolute "docs/toc.md"}}
<!-- results in: 'docs' -->
Get the directory path segment from the given filepath.
Params
ext {String}returns {String}Example
{{dirname "docs/toc.md"}}
<!-- results in: 'docs' -->
Get the relative filepath from a to b.
Params
a {String}b {String}returns {String}Example
{{relative a b}}
Get the file extension from the given filepath.
Params
ext {String}returns {String}Example
{{basename "docs/toc.md"}}
<!-- results in: 'toc.md' -->
Get the "stem" from the given filepath.
Params
filepath {String}returns {String}Example
{{stem "docs/toc.md"}}
<!-- results in: 'toc' -->
Get the file extension from the given filepath.
Params
filepath {String}returns {String}Example
{{extname "docs/toc.md"}}
<!-- results in: '.md' -->
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' -->
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' -->
Convert the given string to a regular expression.
Params
str {String}returns {RegExp}Example
{{toRegex "foo"}}
<!-- results in: /foo/ -->
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 -->
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 the characters in the given string.
Params
string {String}: The string to camelcase.returns {String}Example
{{camelcase "foo bar baz"}};
<!-- results in: 'fooBarBaz' -->
Capitalize the first word in a sentence.
Params
str {String}returns {String}Example
{{capitalize "foo bar baz"}}
<!-- results in: "Foo bar baz" -->
Capitalize all words in a string.
Params
str {String}returns {String}Example
{{capitalizeAll "foo bar baz"}}
<!-- results in: "Foo Bar Baz" -->
Center a string using non-breaking spaces
Params
str {String}spaces {String}returns {String}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' -->
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' -->
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' -->
Lowercase all of the characters in the given string. Alias for lowercase.
Params
string {String}returns {String}Example
{{downcase "aBcDeF"}}
<!-- results in: 'abcdef' -->
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…' -->
Replace spaces in a string with hyphens.
Params
str {String}returns {String}Example
{{hyphenate "foo bar baz qux"}}
<!-- results in: "foo-bar-baz-qux" -->
Return true if value is a string.
Params
value {String}returns {Boolean}Example
{{isString "foo"}}
<!-- results in: 'true' -->
Lowercase all characters in the given string.
Params
str {String}returns {String}Example
{{lowercase "Foo BAR baZ"}}
<!-- results in: 'foo bar baz' -->
Return the number of occurrences of substring within the given string.
Params
str {String}substring {String}returns {Number}: Number of occurrencesExample
{{occurrences "foo bar foo bar baz" "foo"}}
<!-- results in: 2 -->
PascalCase the characters in string.
Params
string {String}returns {String}Example
{{pascalcase "foo bar baz"}}
<!-- results in: 'FooBarBaz' -->
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' -->
Replace spaces in the given string with pluses.
Params
str {String}: The input stringreturns {String}: Input string with spaces replaced by plus signsExample
{{plusify "foo bar baz"}}
<!-- results in: 'foo+bar+baz' -->
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' -->
Render a block without processing mustache templates inside the block.
Params
options {Object}returns {String}Example
{{{{#raw}}}}
{{foo}}
{{{{/raw}}}}
<!-- results in: '{{foo}}' -->
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' -->
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 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' -->
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 a string.
Params
str {String}returns {String}Example
{{reverse "abcde"}}
<!-- results in: 'edcba' -->
Sentence case the given string
Params
str {String}returns {String}Example
{{sentence "hello world. goodbye world."}}
<!-- results in: 'Hello world. Goodbye world.' -->
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 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'] -->
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}}
Title case the given string.
Params
str {String}returns {String}Example
{{titleize "this is title case"}}
<!-- results in: 'This Is Title Case' -->
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' -->
Removes extraneous whitespace from the beginning of a string.
Params
string {String}: The string to trim.returns {String}Example
{{trim " ABC "}}
<!-- results in: 'ABC ' -->
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 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' -->
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' -->
Uppercase all of the characters in the given string. Alias for uppercase.
Params
string {String}returns {String}Example
{{upcase "aBcDeF"}}
<!-- results in: 'ABCDEF' -->
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 uppercaseoptions {Object}: Handlebars options objectreturns {String}Example
{{uppercase "aBcDeF"}}
<!-- results in: 'ABCDEF' -->
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 stringreturns {String}: The endcoded stringEscape 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.Decode a Uniform Resource Identifier (URI) component.
Params
str {String}returns {String}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}Parses a url string into an object.
Params
str {String}: URL stringreturns {String}: Returns stringified JSONStrip the query string from the given url.
Params
url {String}returns {String}: the url without the queryStringStrip 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 strippedExample
<!-- url = 'http://foo.bar' -->
{{stripProtocol url}}
<!-- results in: '//foo.bar' -->
The following utils are exposed on .utils.
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'
Generate a random number
Params
min {Number}max {Number}returns {Number}Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
(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 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
Brian Woodward
Jon Schlinkert
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.
FAQs
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.
We found that @budibase/handlebars-helpers demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket’s threat research team has detected six malicious npm packages typosquatting popular libraries to insert SSH backdoors.
Security News
MITRE's 2024 CWE Top 25 highlights critical software vulnerabilities like XSS, SQL Injection, and CSRF, reflecting shifts due to a refined ranking methodology.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.