Handlebars 为你提供了一个能够毫无挫折感的高效率书写 语义化的模板 所必需的一切。javascript
Mustache 模板和 Handlebars 是兼容的,因此你能够把Mustache模板拿来导入到Handlebars中,并开始使用Handlebars所提供的更丰富的功能。html
Handlebars模板看起来就像是正常的Html,并使用了嵌入的 handlebars 表达式。java
<div class="entry"> <h1>{{title}}</h1> <div class="body"> {{body}} </div> </div>
handlebars表达式,是以 {{
开始,跟一些内容,而后以 }}
结束。
更多资料:表达式express
你能够经过<script>
标签把一段模板加载到浏览器中。segmentfault
<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的指向)less
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>
更多资料:执行post
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 支持简单的路径,就像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>
全部注释都必须有 }}
,一些多行注释可使用 {{!-- --}}
语法。
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
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
helperif
表达式能够选择性的渲染一些区块。若是它的参数返回 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
helperunless
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
helperlog
helper 能够在执行模板的时候输出当前上下文的状态。
{{log "Look at me!"}}
这样会把委托信息发送给 Handlebars.logger.log
,并且这个函数能够重写来实现自定义的log。
转载请注明来自[超2真人]
本文连接:http://www.peichao01.com/static_content/doc/html/introduce-handlebars.html