Handlebars.js 中文文档

使用Handlebars，你可以轻松创建语义化模板，Mustache模板和Handlebars是兼容的，所以你可以将Mustache导入Handlebars以使用 Handlebars 强大的功能。

开始

Handlebars模板看起来和HTML一样，只是嵌入了 handlebars 表达式

<div class="entry">
<h1>{{title}}</h1>
<div class="body">
{{body}}
</div>
</div>

handlebars表达式以

{{

开头，中间写一些内容，以

}}

结尾。

更多内容：表达式

你可以使用

<script>

标签引入handlebars模板：

<script id="entry-template" type="text/x-handlebars-template">
template content
</script>

在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);

得到的结果是：

<div class="entry">
<h1>My New Post</h1>
<div class="body">
This is my first post!
</div>
</div>

更多内容：执行handlebars

HTML编码

在handlebars里，

{{expression}}

会返回一个经过编码的HTML，如果你不希望被编码，可以使用

{{{

<div class="entry">
<h1>{{title}}</h1>
<div class="body">
{{{body}}}
</div>
</div>

使用这样的数据上下文：

{
title: "All about <p> Tags",
body: "<p>This is a post about <p> tags</p>"
}

结果是：

<div class="entry">
<h1>All About <p> Tags</h1>
<div class="body">
<p>This is a post about <p> tags</p>
</div>
</div>

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 = '<a href="' + url + '">' + text + '</a>';

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 = "<ul>";

for(var i=0, l=items.length; i<l; i++) {
out = out + "<li>" + options.fn(items[i]) + "</li>";
}

return out + "</ul>";
});

执行后，得到：

<ul>
<li>Yehuda Katz</li>
<li>Carl Lerche</li>
<li>Alan Johnson</li>
</ul>

块表达式有很多特性，例如，可以创建一个

else

块（内置的if
helper就有else块）。另外，如果

options.fn(context)

对内容编码过了，handlebars就不会helper内容进行编码了，否则就编码两次了。

更多内容：块表达式

Handlebars 路径

Handlebars支持简单的路径

<p>{{name}}</p>

也支持嵌套路径，可以查找下一级的属性

<div class="entry">
<h1>{{title}}</h1>
<h2>By {{author.name}}</h2>

<div class="body">
{{body}}
</div>
</div>

此模板使用下面的数据：

var context = {
title: "My First Blog Post!",
author: {
id: 47,
name: "Yehuda Katz"
},
body: "My first post. Wheeeee!"
};

嵌套路径同样支持

../，

<h1>Comments</h1>

<div id="comments">
{{#each comments}}
<h2><a href="/posts/{{../permalink}}#{{id}}">{{title}}</a></h2>
<div>{{body}}</div>
{{/each}}
</div>

尽管链接在打印出的时候，是以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和数据命名冲突的问题。

<p>{{./name}} or {{this/name}} or {{this.name}}</p>

模板注释

{{!
}}

or

{{!-- --}}

你可以在 handlebars 里加注释：

<div class="entry">
{{! only output this author names if an author exists }}
{{#if author}}
<h1>{{firstName}} {{lastName}}</h1>
{{/if}}
</div>

注释不会出现在输出结果里，如果想要显示出来，可以使用html的注释（会被执行，然后以注释的形式显示，所以如果html注释内有错，还是会报错）

<div class="entry">
{{! 这个注释不会显示在输出结果中 }}
<!-- 会显示 -->
</div>

所有注释必须包含结束标签

}}

，多行注释可以使用

{{!--
--}}

Helpers

Handlebars Helpers可以读取到模板中的任何数据上下文，你可以使用

Handlebars.registerHelper

注册一个helpers。

<div class="post">
<h1>By {{fullName author}}</h1>
<div class="body">{{body}}</div>

<h1>Comments</h1>

{{#each comments}}
<h2>By {{fullName author}}</h2>
<div class="body">{{body}}</div>
{{/each}}
</div>

然后使用如下的数据上下文和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;
});

结果是：

<div class="post">
<h1>By Alan Johnson</h1>
<div class="body">I Love Handlebars</div>

<h1>Comments</h1>

<h2>By Yehuda Katz</h2>
<div class="body">Me Too!</div>
</div>

使用

this

可以访问到当前的上下文

<ul>
{{#each items}}
<li>{{agree_button}}</li>
{{/each}}
</ul>

使用如下的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(
"<button>I agree. I " + this.emotion + " " + this.name + "</button>"
);
});

结果是：

<ul>
<li><button>I agree. I love Handlebars</button></li>
<li><button>I agree. I enjoy Mustache</button></li>
<li><button>I agree. I want to learn Ember</button></li>
</ul>

如果你的helpers返回一个html片段，不想被编码。必须new一个

Handlebars.SafeString

返回出来。

内置的Helpers

The

with

Block
Helper

通常，Handlebars会将数据上下文传入编译方法：

var source   = "<p>{{lastName}}, {{firstName}}</p>";
var template = Handlebars.compile(source);
template({firstName: "Alan", lastName: "Johnson"});

结果：

<p>Johnson, Alan</p>

使用

with

可以改变当前的上下文

<div class="entry">
<h1>{{title}}</h1>

{{#with author}}
<h2>By {{firstName}} {{lastName}}</h2>
{{/with}}
</div>

数据上下文如下：

{
title: "My first post!",
author: {
firstName: "Charles",
lastName: "Jolley"
}
}

结果：

<div class="entry">
<h1>My first post!</h1>

<h2>By Charles Jolley</h2>
</div>

The

each

block
helper

你可以使用内置的

each

helper生成列表，可以使用

this

访问当前项。

<ul class="people_list">
{{#each people}}
<li>{{this}}</li>
{{/each}}
</ul>

数据上下文如下：

{
people: [
"Yehuda Katz",
"Alan Johnson",
"Charles Jolley"
]
}

结果：

<ul class="people_list">
<li>Yehuda Katz</li>
<li>Alan Johnson</li>
<li>Charles Jolley</li>
</ul>

你可以在任何上下文里，使用

this

引用当前的上下文

另外，还可以使用

{{else}}

块，当列表内容为空的时候会显示

{{else}}

的内容

{{#each paragraphs}}
<p>{{this}}</p>
{{else}}
<p class="empty">暂无内容</p>
{{/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.

<div class="entry">
{{#if author}}
<h1>{{firstName}} {{lastName}}</h1>
{{/if}}
</div>

如果使用的是空的数据上下文（例如

{}

），author会返回

undefined

，结果是：

<div class="entry">
</div>

当使用块表达式，可以使用{{else}}来指定一个“片段”，当结果是 falsy value 的时候呈现

<div class="entry">
{{#if author}}
<h1>{{firstName}} {{lastName}}</h1>
{{else}}
<h1>Unknown Author</h1>
{{/if}}
</div>

The

unless

block
helper

unless

的作用和

if

刚好相反，但表达式返回falsy
value的时候渲染block

<div class="entry">
{{#unless license}}
<h3 class="warning">WARNING: This entry does not have a license!</h3>
{{/unless}}
</div>

如果当前上下文的

license

返回一个falsy
value，Handlebars会输出警告信息，否则什么都不输出。

The

log

block
helper

log

helper允许执行模板的时候输出当前上下文的状态

{{log "Look at me!"}}

信息传给

Handlebars.logger.log

，重写这个函数可以实现自定义的log。

内置的工具

Handlebars提供各种工具方法，在

Handlebars.Util

命名空间下。

更多内容：Utilities

原文链接：http://keenwon.com/992.html