使用Handlebars,你可以轻松创建语义化模板,Mustache模板和Handlebars是兼容的,所以你可以将Mustache导入Handlebars以使用 Handlebars 强大的功能。
开始
Handlebars模板看起来和HTML一样,只是嵌入了 handlebars 表达式
{{title}}
handlebars表达式以{{开头,中间写一些内容,以}}结尾。
更多内容:表达式
你可以使用
在javascript中使用Handlebars.compile编译模板:
var source = $("#entry-template").html();
var template = Handlebars.compile(source);
你也可以预编译你的模板,然后只需引入更小的运行时库(handlebars.runtime.js),避免在浏览器中编译,提高性能,这在移动设备中显得更重要。
更多内容:预编译
传入数据上下文(context),handlebars会执行并生成HTML:
var context = {title: "My New Post", body: "This is my first post!"}
var html = template(context);
得到的结果是:
My New Post
更多内容:执行handlebars
HTML编码
在handlebars里,{{expression}}会返回一个经过编码的HTML,如果你不希望被编码,可以使用{{{
{{title}}
使用这样的数据上下文:
{
title: "All about
Tags",
body: "
This is a post about <p> tags
"
}
结果是:
All About <p> Tags
This is a post about <p> tags
handlebars不会编码Handlebars.SafeString。如果你自定义一个helper,返回一段HTML代码,你需要返回new Handlebars.SafeString(result)。此时,你需要手动对内容进行编码:
Handlebars.registerHelper('link', function(text, url) {
text = Handlebars.Utils.escapeExpression(text);
url = Handlebars.Utils.escapeExpression(url);
var result = '' + text + '';
return new Handlebars.SafeString(result);
});
这里将会对传入的参数进行编码,返回值是“安全的”,所以就算你不使用{{{,handlebars也不会再次编码了。
块表达式
块表达式允许你定义helper,用不同的数据上下文(context)调用一段模板。下面我们定义一个生成列表的helper:
{{#list people}}{{firstName}} {{lastName}}{{/list}}
如果我们的数据是这样的:
{
people: [
{firstName: "Yehuda", lastName: "Katz"},
{firstName: "Carl", lastName: "Lerche"},
{firstName: "Alan", lastName: "Johnson"}
]
}
我们创建一个叫list的helper来生成列表,helper接受people作为第一个参数,一个option对象(hash)作为第二个参数。option包含一个属性fn,他可以调用一个context就像普通模板一样。
Handlebars.registerHelper('list', function(items, options) {
var out = "
- ";
for(var i=0, l=items.length; i "; return out + "
}
";
});
执行后,得到:
- Yehuda Katz
- Carl Lerche
- Alan Johnson
块表达式有很多特性,例如,可以创建一个else块(内置的if helper就有else块)。另外,如果options.fn(context)对内容编码过了,handlebars就不会helper内容进行编码了,否则就编码两次了。
更多内容:块表达式
Handlebars 路径
Handlebars支持简单的路径
{{name}}
也支持嵌套路径,可以查找下一级的属性
{{title}}
By {{author.name}}
此模板使用下面的数据:
var context = {
title: "My First Blog Post!",
author: {
id: 47,
name: "Yehuda Katz"
},
body: "My first post. Wheeeee!"
};
嵌套路径同样支持../,
Comments
尽管链接在打印出的时候,是以comments为上下文的,但是它可以访问到上一级的上下文(context)找到permalink。
../引用上一级的作用域,直接看一下上面模板对应的数据就明白了
var data = {
permalink:'http://keenwon.com',
comments: [
{id:1,title:'链接1',body:'链接1'},
{id:2,title:'链接2',body:'链接2'}
]
};
Handlebars可以通过this引用解决helpers和数据命名冲突的问题。
{{./name}} or {{this/name}} or {{this.name}}
模板注释 {{! }} or {{!-- --}}
你可以在 handlebars 里加注释:
{{#if author}}
{{firstName}} {{lastName}}
{{/if}}
注释不会出现在输出结果里,如果想要显示出来,可以使用html的注释(会被执行,然后以注释的形式显示,所以如果html注释内有错,还是会报错)
所有注释必须包含结束标签}},多行注释可以使用{{!-- --}}
Helpers
Handlebars Helpers可以读取到模板中的任何数据上下文,你可以使用Handlebars.registerHelper注册一个helpers。
By {{fullName author}}
Comments
{{#each comments}}
By {{fullName author}}
{{/each}}
然后使用如下的数据上下文和Helpers:
var context = {
author: {firstName: "Alan", lastName: "Johnson"},
body: "I Love Handlebars",
comments: [{
author: {firstName: "Yehuda", lastName: "Katz"},
body: "Me too!"
}]
};
Handlebars.registerHelper('fullName', function(person) {
return person.firstName + " " + person.lastName;
});
结果是:
By Alan Johnson
Comments
By Yehuda Katz
使用this可以访问到当前的上下文
- {{#each items}}
- {{agree_button}}
{{/each}}
使用如下的Helpers和数据上下文
var context = {
items: [
{name: "Handlebars", emotion: "love"},
{name: "Mustache", emotion: "enjoy"},
{name: "Ember", emotion: "want to learn"}
]
};
Handlebars.registerHelper('agree_button', function() {
return new Handlebars.SafeString(
""
);
});
结果是:
如果你的helpers返回一个html片段,不想被编码。必须new一个Handlebars.SafeString返回出来。
内置的Helpers
The with Block Helper
通常,Handlebars会将数据上下文传入编译方法:
var source = "
{{lastName}}, {{firstName}}
";
var template = Handlebars.compile(source);
template({firstName: "Alan", lastName: "Johnson"});
结果:
Johnson, Alan
使用with可以改变当前的上下文
{{title}}
{{#with author}}
By {{firstName}} {{lastName}}
{{/with}}
数据上下文如下:
{
title: "My first post!",
author: {
firstName: "Charles",
lastName: "Jolley"
}
}
结果:
My first post!
By Charles Jolley
The each block helper
你可以使用内置的each helper生成列表,可以使用this访问当前项。
- {{#each people}}
- {{this}}
{{/each}}
数据上下文如下:
{
people: [
"Yehuda Katz",
"Alan Johnson",
"Charles Jolley"
]
}
结果:
- Yehuda Katz
- Alan Johnson
- Charles Jolley
你可以在任何上下文里,使用this引用当前的上下文
另外,还可以使用{{else}}块,当列表内容为空的时候会显示{{else}}的内容
{{#each paragraphs}}
{{this}}
{{else}}
暂无内容
{{/each}}
在each中循环每一项的时候,可以使用{{@index}}获取当前的序号。
{{#each array}}
{{@index}}: {{this}}
{{/each}}
对于object,可以使用{{key}}获取当前的key。
{{#each object}}
{{@key}}: {{this}}
{{/each}}
在迭代的过程中,可以使用@first和@last判断当前的第一步和最后一步,对于object,只有@first可用。
The if block helper
可以使用if helper有条件的渲染block,如果是false, undefined, null, "" 或者 [](a “falsy” value),Handlebars不会渲染此block.
{{firstName}} {{lastName}}
{{/if}}
如果使用的是空的数据上下文(例如{}),author会返回undefined,结果是:
当使用块表达式,可以使用{{else}}来指定一个“片段”,当结果是 falsy value 的时候呈现
{{firstName}} {{lastName}}
{{else}}
Unknown Author
{{/if}}
The unless block helper
unless的作用和if刚好相反,但表达式返回falsy value的时候渲染block
WARNING: This entry does not have a license!
{{/unless}}
如果当前上下文的license返回一个falsy value,Handlebars会输出警告信息,否则什么都不输出。
The log block helper
log helper允许执行模板的时候输出当前上下文的状态
{{log "Look at me!"}}
信息传给Handlebars.logger.log,重写这个函数可以实现自定义的log。
内置的工具
Handlebars提供各种工具方法,在Handlebars.Util命名空间下。
{{title}}
{{/each}}