Handlebars 为你供应了一个能够毫无挫折感的高效率誊写 语义化的模板 所必须的统统。
Mustache 模板和 Handlebars 是兼容的,所以你能够把Mustache模板拿来导入到Handlebars中,并最先运用Handlebars所供应的更雄厚的功用。
最先
Handlebars模板看起来就像是平常的Html,并运用了嵌入的 handlebars 表达式。
<div class="entry">
<h1>{{title}}</h1>
<div class="body">
{{body}}
</div>
</div>
handlebars表达式,是以 {{
最先,跟一些内容,然后以 }}
完毕。
更多材料:表达式
你能够经由过程<script>
标签把一段模板加载到浏览器中。
<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);
还能够预编译模板。如许的话,就只须要一个更小的运行时库文件,而且对机能来讲是一个极大的勤俭,由于如许就没必要在浏览器中编译模板了。这点在挪动版的开辟中就更显的非常重要了。
更多材料:预编译
只需通报一个高低文context实行模板,即可获得返回的 HTML 的值
(译者注:平常来讲在 js 中高低文就决议了当前函数的this的指向)
var context = {title: "My New Post", body: "This is my first post!"}
var html = template(context);
获得下面的HTML
<div class="entry">
<h1>My New Post</h1>
<div class="body">
This is my first post!
</div>
</div>
Handlebars的 {{expression}}
表达式会返回一个 HTML编码 HTML-escape
过的值。假如不愿望Handlebars来编码这些值,运用三个大括号即可:{{{
。
<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 就不会再次编码它了。
块级表达式
块级表达式许可你定义一个helpers,并运用一个不同于当前的高低文(context)来挪用你模板的一部份。如今斟酌下这类状况,你须要一个helper来天生一段 HTML 列表:
{{#list people}}{{firstName}} {{lastName}}{{/list}}
并运用下面的高低文(数据):
{
people: [
{firstName: "Yehuda", lastName: "Katz"},
{firstName: "Carl", lastName: "Lerche"},
{firstName: "Alan", lastName: "Johnson"}
]
}
此时须要建立一个 名为 list
的 helper 来天生这段 HTML 列表。这个 helper 运用 people
作为第一个参数,另有一个 options
对象(hash哈希)作为第二个参数。这个 options 对象有一个叫 fn
的属性,你能够通报一个高低文给它(fn),就跟实行一个平常的 Handlebars 模板一样:
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>
块级的 helpers 另有许多其他的特征,比方能够建立一个 else
区块(比方,内置的 if helper 就是用 else)。
注重,由于在你实行 options.fn(context)
的时刻,这个 helper 已把内容编码一次了,所以 Handlebars 不会再对这个 helper 输出的值举行编码了。假如编码了,这些内容就会被编码两 次!
更多材料:块级Helpers
译文在此
Handlebars 途径
Handlebars 支撑简朴的途径,就像Mustache那样。
<p>{{name}}</p>
Handlebars 一样也支撑嵌套的途径,如许的话就能够在当前的高低文中查找内部嵌套的属性了。
<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!"
};
如许一来 Handlebars 就能够直接把JSON数据拿来用了。
巢状嵌套的 handlebars 途径也能够运用 ../
, 如许会把途径指向父级(上层)高低文。
<h1>Comments</h1>
<div id="comments">
{{#each comments}}
<h2><a href="/posts/{{../permalink}}#{{id}}">{{title}}</a></h2>
<div>{{body}}</div>
{{/each}}
</div>
只管 a 链接在输出时是以 comment 批评为高低文的,但它依然能够退回上一层的高低文(post高低文)并掏出permalink(牢固链接)值。
(译者注)高低文数据应当以下所示(源文档并没有给出)
var context = {
post: {
body:'这是文章内容',
permalink: 'http://xx.com/xx',
comments:[{
title:'这篇文章不错,赞一个'
},{
title:'好文要顶!'
}]
}
}
../
标识符示意对模板的父级作用域的援用,并不示意在高低文数据中的上一层。这是由于块级 helpers 能够以任何高低文来挪用一个块级表达式,所以这个【上一层】的观点用来指模板作用域的父级更有意义些。
Handlebars也许可经由过程一个 this
的援用来处理 helpers 和 数据字段间的名字争执:
<p>{{./name}} or {{this/name}} or {{this.name}}</p>
上面的这一种体式格局都会将 name
字段援用到当前高低文上,而不是 helper 上的同名属性。
模板解释:{{! }} 或 {{!– –}}
你能够在 handlebars 代码中加解释,就跟在代码中写解释一样。关于有肯定水平的逻辑的部份来讲,这却是一个很好的实践。
<div class="entry">
{{! only output this author names if an author exists }}
{{#if author}}
<h1>{{firstName}} {{lastName}}</h1>
{{/if}}
</div>
解释是不会终究输出到返回效果中的。假如你愿望把解释展现出来,就运用 HTML 的解释就好了。
<div class="entry">
{{! This comment will not be in the output }}
<!-- This comment will be in the output -->
</div>
一切解释都必须有 }}
,一些多行解释能够运用 {{!-- --}}
语法。
Helpers
Handlebars 的 helpers 在模板中能够接见任何的高低文。能够经由过程 Handlebars.registerHelper
要领注册一个 helper。
<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>
Helpers 会把当前的高低文作为函数中的 this
高低文。
<ul>
{{#each items}}
<li>{{agree_button}}</li>
{{/each}}
</ul>
当运用下面的 this高低文 和 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>
假如你不愿望你的 helper 返回的 HTML 值被编码,就请务必返回一个 new Handlebars.SafeString
内置的 Helpers
with
helper
平常状况下,Handlebars 模板在盘算值时,会把通报给模板的参数作为高低文。
var source = "<p>{{lastName}}, {{firstName}}</p>";
var template = Handlebars.compile(source);
template({firstName: "Alan", lastName: "Johnson"});
效果以下:
<p>Johnson, Alan</p>
不过也能够在模板的某个地区切换高低文,运用内置的 with
helper即可。
<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>
each
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
,当被轮回的是一个空列表的时刻会显现个中的内容。
{{#each paragraphs}}
<p>{{this}}</p>
{{else}}
<p class="empty">No content</p>
{{/each}}
在运用 each
来轮回列表的时刻,能够运用 {{@index}}
来示意当前轮回的索引值。
{{#each array}}
{{@index}}: {{this}}
{{/each}}
关于 object 范例的轮回,能够运用 {{@key}}
来示意:
{{#each object}}
{{@key}}: {{this}}
{{/each}}
if
helper
if
表达式能够选择性的衬着一些区块。假如它的参数返回 false
, undefined
, null
, ""
或 []
(译注:另有 0
)(都是JS中的“假”值),Handlebars 就不会衬着这一块内容:
<div class="entry">
{{#if author}}
<h1>{{firstName}} {{lastName}}</h1>
{{/if}}
</div>
当时用一个空对象({}
)作为高低文时,会获得:
<div class="entry">
</div>
在运用 if
表达式的时刻,能够合营 {{else}}
来运用,如许当参数返回 假 值时,能够衬着 else 区块:
<div class="entry">
{{#if author}}
<h1>{{firstName}} {{lastName}}</h1>
{{else}}
<h1>Unknown Author</h1>
{{/if}}
</div>
unless
helper
unless
helper 和 if
helper 是恰好相反的,当表达式返回假值时就会衬着其内容:
<div class="entry">
{{#unless license}}
<h3 class="warning">WARNING: This entry does not have a license!</h3>
{{/unless}}
</div>
假如在当前高低文中查找 license
返回假值,Handlebars 就会衬着这段正告信息。反之,就什么也不输出。
log
helper
log
helper 能够在实行模板的时刻输出当前高低文的状况。
{{log "Look at me!"}}
如许会把托付信息发送给 Handlebars.logger.log
,而且这个函数能够重写来完成自定义的log。
转载请说明来自[超2真人]
本文链接:http://www.peichao01.com/static_content/doc/html/introduce-handlebars.html