danharper / handlebars-helpers Goto Github PK

View Code? Open in Web Editor NEW

274.0 13.0 55.0 56 KB

A small collection of useful helpers for Handlebars.js

License: Do What The F*ck You Want To Public License

JavaScript 95.03% HTML 4.97%

handlebars-helpers's Introduction

Handlebars Helpers

A small collection of useful helpers for Handlebars.js.

This version includes a (very) large API change. Use version 1.1.0 if you'd prefer the "classic" style.

To use, just include helpers.js after you include Handlebars. Or, if you're using AMD/Node, just require the file.

Provided Helpers

The old if_eq, if_gt, unless_gte etc. helpers are now replaced with a much cleaner is helper.

Comparisons

Given one argument, is acts exactly like if:

{{#is x}} ... {{else}} ... {{/is}}

Given two arguments, is compares the two are equal (a non-strict, == comparison, so 5 == '5' is true)

{{#is x y}} ... {{else}} ... {{/is}}

Given three arguments, the second argument becomes the comparator.

{{#is x "not" y}} ... {{else}} ... {{/is}}
{{#is 5 ">=" 2}} ... {{else}} ... {{/is}}

Several comparators are built-in:

== (same as not providing a comparator)
!=
not (alias for !=)
===
!==
>
>=
<
<=
in (check a value exists in either a comma-separated string, or an array, see below)

// Loose equality checking
{{#is x y}} ... {{else}} ... {{/is}}
{{#is x "==" y}} ... {{else}} ... {{/is}}

{{#is x "!=" y}} ... {{else}} ... {{/is}}
{{#is x "not" y}} ... {{else}} ... {{/is}}

// Strict equality checking
{{#is x "===" y}} ... {{else}} ... {{/is}}
{{#is x "!==" y}} ... {{else}} ... {{/is}}

// Greater/Less Than
{{#is x ">" y}} ... {{else}} ... {{/is}}
{{#is x ">=" y}} ... {{else}} ... {{/is}}

{{#is x "<" y}} ... {{else}} ... {{/is}}
{{#is x "<=" y}} ... {{else}} ... {{/is}}

// In comma separated list, or array
{{#is x "in" "foo,bar"}} ... {{else}} ... {{/is}}
{{#is x "in" anArray}} ... {{else}} ... {{/is}}

Registering Custom `is` comparators

You can extend the provided comparators by registering your own, like so:

// in browser
HandlebarsHelpersRegistry.add('same', function (left, right) { return left === right; });

// with AMD/Node
var HandlebarsHelpersRegistry = require('path/to/helpers');
HandlebarsHelpersRegistry.add('same', function (left, right) { return left === right; });

// usage
var template = '{{#is x "same" y}} Are the same {{else}} Not the same {{/is}}';
Handlebars.compile(template)({ x: 5, y: '5' }); // => " Not the same "

Logging

Log one or multiple values to the console:

{{log foo bar}}

Log one or multiple values to the console, with the current context:

{{debug foo bar}}

nl2br

Convert new lines (\r\n, \n\r, \r, \n) to line breaks

{{nl2br description}}

handlebars-helpers's People

Contributors

Stargazers

Watchers

handlebars-helpers's Issues

doesn't work on IE8

this line...

eR.add('in', function (left, right) {
if (!isArray(right)) {
right = right.split(',');
}
return right.indexOf(left) !== -1;
});

will break in IE8. You should shim this or use underscore/lodash to fix this.

add loggable back into mobapp models

> and < comparing operators don't work with latest Handlebars 1.2.0

Trying to use {{#is x ">" y}}true{{/is}} results in error saying "Error: Unknown operator "& gt;""

Missing license

AFAICS there is no documented license attached to Handlebars-Helpers, which IMHO makes it nearly impossible to use in a legal fashion.

use external helpers

use https://github.com/danharper/Handlebars-Helpers rather than our own code

Using a env variable in file path helper

Is there a way to introduce enviroment variable in the path of file helper?

Add support for Require JS AMD and Node JS

It will be much better if you add RequireJS AMD and Node JS support in your plugin.
It makes your code much like drop in and use it.

I discovered that the nl2br helper function returns a Handlebars.SafeString which isn't being escaped during rendering. While this is necessary to leave the inserted br-Tags untouched, it can cause security issues (e. g. XSS) if the INPUT string is not escaped. In my opinion this should be done before the replacement is performed:

Handlebars.registerHelper('nl2br', function(text) {
    text = Handlebars.Utils.escapeExpression(text);
    var nl2br = (text + '').replace(/([^>\r\n]?)(\r\n|\n\r|\r|\n)/g, '$1' + '<br>' + '$2');
    return new Handlebars.SafeString(nl2br);
});

Greater than always returning true

I am using a simple greater than if statement:

{{#if_gt total_transactions compare="10"}}
    <p>In here</p>
{{/if_gt}}

But I am always getting into the if statement, even though total_transactions is less than 10.

Any ideas?

Handlers lose model depth

Hi, thanks for this extension. I have a problem using my template code along with your handler:

{{#each model._revs_info}}
{{debug ../model}}
{{#if_eq status compare="available"}}
{{debug ../model}}
{{rev}}
{{/if_eq}}
{{/each}}

The first {{debug ../model}} statement works perfectly but the second doesn't. {{debug}} definition: http://thinkvitamin.com/code/handlebars-js-part-3-tips-and-tricks/

I am sure that I am missing something basic. Thanks for your help in advance.

Best, Sameer