What could be more logical awesome than no logic at all?
Shamless port of http://github.com/defunkt/mustache by Jan Lehnardt [email protected].
Thanks @defunkt for the awesome code.
You can use mustache.js rendering stuff in various scenarios. E.g. you can render templates in your browser, or rendering server-side stuff with node.js, use it for rendering stuff in CouchDB's views.
A quick example how to use mustache.js:
var view = {
title: "Joe",
calc: function() {
return 2 + 4;
}
}
var template = "{{title}} spends {{calc}}";
var html = Mustache.to_html(template, view);
template
is a simple string with mustache tags and view
is a JavaScript object containing the.
There are several types of tags currently implemented in mustache.js.
Tags are always surrounded by mustaches like this {{foobar}}
.
var view = {name: "Joe", say_hello: function(){ return "hello" }}
template = "{{say_hello}}, {{name}}"
Conditional sections begin with {{#condition}}
and end with {{/condition}}
. When condition
evaluates to true, the section is rendered, otherwise the hole block will output nothing at all. condition
may be a function returning true/false or a simple boolean.
var view = {condition: function() {
// [...your code goes here...]
return true;
}}
{{#condition}}
I will be visible if condition is true
{{/condition}}
Enumerable Sections use the same syntax as condition sections do. {{#shopping_items}}
and {{/shopping_items}}
. Actually the view decides how mustache.js renders the section. If the view returns an array, it will iterator over the items. Use {{.}}
to access the current item inside the enumeration section.
var view = {name: "Joe's shopping card",
items: ["bananas", "apples"]}
var template = "{{name}}: <ul> {{#items}}<li>{{.}}</li>{{/items}} </ul>"
Outputs:
Joe's shopping card: <ul><li>bananas</li><li>apples</li></ul>
mustache.js supports a quite powerful but yet simple view partial mechanism. Use the following syntax for partials: {{>partial_name}}
var view = {
name: "Joe",
winnings: {
value: 1000,
taxed_value: function() {
return this.value - (this.value * 0.4);
}
}
};
var template = "Welcome, {{name}}! {{>winnings}}"
var partials = {winnings: "You just won ${{value}} (which is ${{taxed_value}} after tax)"};
var output = Mustache.to_html(template, view, partials)
output will be:
Welcome, Joe! You just won $1000 (which is $600 after tax)
You invoke a partial with {{>winnings}}
. Invoking the partial winnings
will tell
mustache.js to look for a object in the context's property winnings
. It will then
use that object as the context for the template found in partials
for winnings
.
mustache.js does escape all values when using the standard double mustache syntax. Characters which will be escaped: & \ " < >
. To disable escaping, simply use tripple mustaches like {{{unescaped_variable}}}
.
Example: Using {{variable}}
inside a template for 5 > 2
will result in 5 > 2
, where as the usage of {{{variable}}}
will result in 5 > 2
.
To stream template results out of mustache.js, you can pass an optional send()
callback to the to_html()
call:
Mustache.to_html(template, view, partials, function(line) {
print(line);
});
See examples/
for more goodies and read the original mustache docs