Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

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

License

NotificationsYou must be signed in to change notification settings

helpers/handlebars-helpers

Repository files navigation

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 intemplate-helpers.

Install

Install withnpm:

$ npm install --save handlebars-helpers

Install withyarn:

$ yarn add handlebars-helpers

Browser usage

See how touse 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

varhelpers=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.

varhelpers=require('handlebars-helpers');varmath=helpers.math();//=> only the `math` helpersvarhelpers=require('handlebars-helpers');vararray=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.

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

Optionally pass your own handlebars

varhandlebars=require('handlebars');varhelpers=require('handlebars-helpers')({handlebars:handlebars});// or for a specific collectionvarmath=helpers.math({handlebars:handlebars});

Helpers

Categories

Currently189 helpers in20 categories:

All helpers

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)

Visit the:code |unit tests |issues)

Visit the:code |unit tests |issues)

Visit the:code |unit tests |issues)

Visit the:code |unit tests |issues)

array

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

Params

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

Example

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

Cast the givenvalue 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 ofafter.

Params

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

Example

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

Params

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

Example

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

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

Params

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

Example

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

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

Params

  • array{Array}
  • n{Number}: Number of items to return, starting at0.
  • 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:

  • index
  • total
  • isFirst
  • isLastAlso,@index is exposed as a private variable, and additionalprivate 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'}]-->{{#forEachaccounts}}  <ahref="mailto:{{email}}"title="Send an email to{{name}}">{{name}}  </a>{{#unlessisLast}},{{/unless}}{{/forEach}}

Block helper that renders the block if an array has the givenvalue. 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']-->{{#inArrayarray"d"}}  foo{{else}}  bar{{/inArray}}<!-- results in: 'bar'-->

Returns true ifvalue is an es5 array.

Params

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

Example

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

Returns the item fromarray at indexidx.

Params

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

Example

<!-- array: ['a', 'b', 'c']-->{{itemAtarray1}}<!-- 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']-->{{joinarray}}<!-- results in: 'a, b, c'-->{{joinarray'-'}}<!-- results in: 'a-b-c'-->

Returns true if the the length of the givenvalue is equalto the givenlength. Can be used as a block or inline helper.

Params

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

Returns the last item, or lastn items of an array or string. Opposite offirst.

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']-->{{lastvalue}}<!-- results in: ['e']-->{{lastvalue2}}<!-- results in: ['d', 'e']-->{{lastvalue3}}<!-- 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'];-->{{lengthmyArray}}<!-- results in: 5--><!-- results in: myObject = {'a': 'a', 'b': 'b'};-->{{lengthmyObject}}<!-- results in: 2-->

Alias forequalsLength

Returns a new array, created by callingfunction on each element of the givenarray. For example,

Params

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

Example

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

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

Params

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

Example

//{{pluckitems"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'-->{{reversevalue}}<!-- results in: 'dcba'--><!-- value: ['a', 'b', 'c', 'd']-->{{reversevalue}}<!-- 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}: Iteratee
  • {Options}: Handlebars provided options object
  • returns{String}

Example

<!-- array: [1, 'b', 3]-->{{#somearrayisString}}  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 givenarray. If an array of objects is passed, you may optionally pass akey 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']-->{{sortarray}}<!-- results in: '["a", "b", "c"]'-->

Sort anarray. If an array of objects is passed, you may optionally pass akey 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'}]-->{{sortByarray"a"}}<!-- results in: '[{"a":"aaa"}, {"a":"zzz"}]'-->

Use the items in the arrayafter the specified index as context inside a block. Opposite ofwithBefore.

Params

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

Example

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

Use the items in the arraybefore the specified index as context inside a block. Opposite ofwithAfter.

Params

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

Example

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

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

Params

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

Example

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

Block helper that groups array elements by given groupsize.

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']-->{{#withGrouparray4}}{{#eachthis}}{{.}}{{each}}  <br>{{/withGroup}}<!-- results in:--><!-- 'a','b','c','d'<br>--><!-- 'e','f','g','h'<br>-->

Use the last item orn items in an array as context inside a block. Opposite ofwithFirst.

Params

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

Example

<!-- array: ['a', 'b', 'c']-->{{#withLastarray}}{{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}: Specifyreverse="true" to reverse the array.
  • returns{String}

Example

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

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

Params

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

Example

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

code

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 givenparams

Params

  • params{Object}
  • returns{String}

Example

{{jsfiddleid="0dfk10ks"tabs="true"}}

collection

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: []-->{{#isEmptyarray}}AAA{{else}}BBB{{/isEmpty}}<!-- results in: 'AAA'--><!-- array: []-->{{isEmptyarray}}<!-- results in: true-->

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

Params

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

comparison

Helper that renders the block ifboth 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}-->{{#andgreatmagnificent}}A{{else}}B{{/and}}<!-- results in: 'A'-->

Render a block when a comparison of the first and thirdarguments returns true. The second argument isthearithemetic operator to use. You may alsooptionally 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.

Block helper that renders the block ifcollection has the givenvalue, using strict equality (===) for comparison, otherwise the inverse block is rendered (if specified). If astartIndex 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']-->{{#containsarray"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 ifa isequal tob.If an inverse block is specified it will be rendered when falsy.You may optionally use thecompare="" hash argument for thesecond value.

Params

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

Block helper that renders a block ifa isgreater thanb.

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

Params

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

Block helper that renders a block ifa isgreater than or equal tob.

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

Params

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

Block helper that renders a block ifvalue haspattern.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}

Returns true if the givenvalue is falsey. Uses thefalseylibrary for comparisons. Please see that library for more informationor to report bugs with this helper.

Params

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

Returns true if the givenvalue is truthy. Uses thefalseylibrary for comparisons. Please see that library for more informationor 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 object
  • returns{String}: Block, or inverse block if specified and falsey.

Example

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

Conditionally renders a block if the remainder is zero whena operand is divided byb. If an inverse block is specifiedit will be rendered when the remainder isnot zero.

Params

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

Block helper that renders a block ifvalue isan 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

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

Block helper that renders a block ifa isequal tob.If an inverse block is specified it will be rendered when falsy.Similar toeq but does not do strict equality.

Params

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

Block helper that renders a block ifa isnot equal tob.If an inverse block is specified it will be rendered when falsy.Similar tounlessEq but does not use strict equality forcomparisons.

Params

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

Block helper that renders a block ifa isless thanb.

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

Params

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

Block helper that renders a block ifa isless than or equal tob.

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

Params

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

Block helper that renders a block ifneither of the given valuesare truthy. If an inverse block is specified it will be renderedwhen falsy.

Params

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

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

Params

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

Block helper that renders a block ifany 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

{{#orabc}}  If any value is true this will be rendered.{{/or}}

Block helper that always renders the inverse blockunlessa isis equal tob.

Params

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

Block helper that always renders the inverse blockunlessa isis greater thanb.

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.

Block helper that always renders the inverse blockunlessa isis less thanb.

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.

Block helper that always renders the inverse blockunlessa isis greater than or equal tob.

Params

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

Block helper that always renders the inverse blockunlessa isis less than or equal tob.

Params

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

date

Get the current year.

Example

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

Usemoment as a helper. Seehelper-date for more details.

fs

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")}}

Return an array of files from the givendirectory.

Params

  • directory{String}
  • returns{Array}

html

Stringify attributes on the optionshash.

Params

  • options{Object}
  • returns{String}

Example

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

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

Params

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

Example

<!-- {stylesheets: ['foo.css', 'bar.css']}-->{{cssstylesheets}}<!-- 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

{{jsscripts}}

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

i18n helper. Seebutton-i18nfor a working example.

Params

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

inflection

Returns either thesingular orplural inflection of a word based on the givencount.

Params

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

Example

{{inflect0"string""strings"}}<!-- "strings"-->{{inflect1"string""strings"}}<!-- "string"-->{{inflect1"string""strings"true}}<!-- "1 string"-->{{inflect2"string""strings"}}<!-- "strings"-->{{inflect2"string""strings"true}}<!-- "2 strings"-->

Returns an ordinalized number as a string.

Params

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

Example

{{ordinalize1}}<!-- '1st'-->{{ordinalize21}}<!-- '21st'-->{{ordinalize29}}<!-- '29th'-->{{ordinalize22}}<!-- '22nd'-->

logging

logging-helpers.

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>-->

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

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$")}}

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

Return the magnitude ofa.

Params

  • a{Number}
  • returns{Number}

Return the sum ofa plusb.

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 theMath.ceil() of the given value.

Params

  • value{Number}
  • returns{Number}

Dividea byb

Params

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

Get theMath.floor() of the given value.

Params

  • value{Number}
  • returns{Number}

Return the difference ofa minusb.

Params

  • a{Number}
  • b{Number}

Get the remainder of a division operation.

Params

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

Return the product ofa timesb.

Params

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

Adda byb.

Params

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

Generate a random number between two values

Params

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

Get the remainder whena is divided byb.

Params

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

Round the given number.

Params

  • number{Number}
  • returns{Number}

Return the product ofa minusb.

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'-->

Multiply numbera by numberb.

Params

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

misc

Return the given value ofprop fromthis.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 givenvalue

Params

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

Example

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

Block helper that builds the context for the blockfrom the options hash.

Params

  • options{Object}: Handlebars provided options object.

number

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}

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.8005551212
  • returns{Number}: Formatted phone number:(800) 555-1212

Abbreviate numbers to the given number ofprecision. This is forgeneral 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

{{toExponentialnumberdigits}};

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 theNumber 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 to0.
  • 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 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 ofan object, exposing each key and value on the context.

Params

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

Block helper that iterates over theown properties ofan 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 fromthe 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}

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

Params

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

Return true ifkey is an own, enumerable property of the givencontext object.

Params

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

Example

{{hasOwncontextkey}}

Return true ifvalue is an object.

Params

  • value{String}
  • returns{Boolean}

Example

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

Parses the given string usingJSON.parse.

Params

  • string{String}: The string to parse

Example

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

Stringify an object usingJSON.stringify.

Params

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

Example

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

Deeply merge the properties of the givenobjects with thecontext 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.

path

Get the directory path segment from the givenfilepath.

Params

  • ext{String}
  • returns{String}

Example

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

Get the directory path segment from the givenfilepath.

Params

  • ext{String}
  • returns{String}

Example

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

Get the relative filepath froma tob.

Params

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

Example

{{relativeab}}

Get the file extension from the givenfilepath.

Params

  • ext{String}
  • returns{String}

Example

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

Get the "stem" from the givenfilepath.

Params

  • filepath{String}
  • returns{String}

Example

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

Get the file extension from the givenfilepath.

Params

  • filepath{String}
  • returns{String}

Example

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

Resolve an absolute path from the givenfilepath.

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'-->

regex

Convert the given string to a regular expression.

Params

  • str{String}
  • returns{RegExp}

Example

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

Returns true if the givenstr matches the given regex. A regex can be passed on the context, or using thetoRegex 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 the specifiedsuffix to the given string.

Params

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

Example

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

camelCase the characters in the givenstring.

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 whitespaceand 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 instring. 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 instring.

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 forlowercase.

Params

  • string{String}
  • returns{String}

Example

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

Truncates a string to the specifiedlength, 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 ifvalue 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 ofsubstring within the givenstring.

Params

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

Example

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

PascalCase the characters instring.

Params

  • string{String}
  • returns{String}

Example

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

path/case the characters instring.

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 string
  • returns{String}: Input string with spaces replaced by plus signs

Example

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

Prepends the givenstring with the specifiedprefix.

Params

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

Example

<!-- given that "val" is "bar"-->{{prependval"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 ofsubstring from the givenstr.

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 ofsubstring from the givenstr.

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 substringa with substringb.

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 substringa with substringb.

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 givenstring.

Params

  • string{String}
  • returns{String}

Example

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

Splitstring by the givencharacter.

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 specifiedlength. Also seeellipsis.

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 seetruncate.

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 foruppercase.

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 uppercase
  • options{Object}: Handlebars options object
  • returns{String}

Example

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

url

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

Params

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

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.

Decode a Uniform Resource Identifier (URI) component.

Params

  • str{String}
  • returns{String}

Alias forencodeURI.

Alias fordecodeURI.

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

Params

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

Parses aurl string into an object.

Params

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

Strip the query string from the givenurl.

Params

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

Strip protocol from aurl. 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'-->{{stripProtocolurl}}<!-- results in: '//foo.bar'-->

Utils

The following utils are exposed on.utils.

Change casing on the givenstring, 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}

History

v0.10.0 - 2017-11-17

changes

  • addsunique to array helpers
  • updatescss 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
  • removefileSize helper in favor of newbytes helper, which does the same thing, but returnsB instead ofbyte orbytes.
  • 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 toisEmpty, so it can now be used as an inline or block helper
  • addsraw 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
  • addspluck helper to array helpers
  • addsprepend andappend helpers to string helpers
  • addsisTruthy andisFalsey comparison helpers
  • addsescape andurl_encode andurl_decode URL helpers
  • addsattr helper to html helpers
  • addsyear helper to date helpers
  • addstypeOf andframe helpers to misc helpers
  • addsabs,minus,modulo,plus,times to math helpers
  • movesellipsis helper fromhtml helpers to string helpers
  • movestruncate helper fromhtml helpers to string helpers
  • movesreverse helper fromstring helpers to array helpers
  • differentiateeq andis helpers so thateq is strict equality andis is not
  • removesmm helper, usematch 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

  • Theor 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. Examplehelpers(['string', 'array']) will load only thestring andarray 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 thehandlebars-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 themd andmarkdown 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 athttp://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 byverb, 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&& npmtest

Author

Brian Woodward

Jon Schlinkert

License

Copyright © 2017,Jon Schlinkert.When this project was created some helpers were sourced fromSwag, by Elving Rodriguez.Released under theMIT License.

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

About

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

Topics

Resources

License

Security policy

Stars

Watchers

Forks

Sponsor this project

  •  
  •  

Packages

No packages published
[8]ページ先頭
©2009-2025 Movatter.jp