Handlebars2.js
Just making happiness for handlebars.js
Badges
Install
Install handlebars2:
# Either globally yarn global add handlebars2# Or locally (preferred) yarn add handlebars2 --save--dev
or, If you use npm
:
npm i handlebars2 -gnpm i handlebars2 --save-dev
Quick Start
Import in your project:
// ES6 Module // Or, if you use CommonJSconst Handlebars2 = // Go hacking!
API
Handlebars2.render(template, context)
template
- type: {string}
- description: template string
context
- type: {object}
- description: context used to render template
const template = '{{ name }}'Handlebars2 // => Handlebars2
Handlebars2.renderPartial(partialName)
partialName
- type: {string}
- description: render a partial registered by
Handlebars2.registerPartial
Handlebars2Handlebars2 // => Handlebars2
built-in helpers
partial
A helper for using Handlebars.registerPartial
in your template.
slot
A helper for using Handlebars.renderPartial
in your template.
example:
{{#partial "p1"}} {{ name }}{{/partial}} {{#slot "p1"}}{{/slot}}
const ctx = name: 'hbs2'
Rendering result will be hbs2
.
json
A helper used to JSON stringify
the giving input.
example:
{{json data}}
const context = data: statusCode: 200 msg: 'success'
Rendering result will be '{"statusCode":200,"msg":"success"}'
.
trim
A helper used to trim
the giving input.
camelize
A helper used to camelize
the hyphenated giving input.
example:
{{camelize name}}
const context = name: 'camel-case'
Rendering result will be 'camelCase'
.
hyphenate
Opposite to camelize, A helper used to hyphenate
the camelized giving input.
example:
{{hyphenate name}}
const context = name: 'camelCase'
Rendering result will be 'camel-case'
.
split
A helper used to combine the camelized giving input with specified hyphen. A helper used to combine the camelized giving input with specified hyphen.
example:
{{ split name sep=sep }}
const context = name: 'camelCase' sep: '_'
Rendering result will be 'camel_case'
.
If not giving
sep
, default is' '
normalizeurl
A helper used to normalize the URL.
http://www.v2js.com => v2js.com
https://www.v2js.com => v2js.com
www.v2js.com => v2js.com
nospace
A helper that outputs the content without any space.
nobreak
A helper that outputs the content without any break.
noindent
A helper that outputs the content without any line-first indent
noblankline
A helper that outputs the content without any blank line.
Contributing
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature
- Commit your changes:
git commit -am 'Add some feature'
- Push to the branch:
git push origin my-new-feature
- Submit a pull request :D
Author
handlebars2 © ULIVZ, Released under the MIT License.
Authored and maintained by ULIVZ with help from contributors (list).