语言指南 - 内置助手代码

优质
小牛编辑
138浏览
2023-12-01

#if

你可以使用 if 助手代码来根据条件渲染代码块。如果其参数返回 falseundefinednull""0 或者 [],Handlebars 将不会渲染该块。

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

当你将以下输入传递给上述模板时

input
{
  author: true,
  firstName: "Yehuda",
  lastName: "Katz"
}

将得出如下结果:

output
<div class="entry">
<h1>Yehuda Katz</h1>
</div>

如果输入是空的 JSONObject {},则 author 将变为 undefined 并且 if 条件失败。输出如下:

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

使用代码块时,如果表达式返回 false,你可以通过标注 else 的方式指定要运行的模板。

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

#unless

你可以将 unless 助手代码看作与 if 助手代码相反。如果表达式返回 false 则将渲染代码块。

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

如果在当前上下文中查找 license 返回 false,则 Handlebars 将提供警告。除此以外,它不会进行渲染。

#each

你可以使用内置的 each 助手代码遍历列表。在块内,你可以使用 this 来引用被迭代的元素。

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

当与此上下文一起使用时:

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

将导致:

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

你可以在任何上下文中使用 this 指针来引用当前上下文。

你可以选择提供一个 else,该代码块将只会在列表为空时显示。

template
{{#each paragraphs}}
<p>{{this}}</p>
{{else}}
<p class="empty">No content</p>
{{/each}}

当遍历 each 中的项目时,你可以选择通过 {{@index}} 引用当前循环的索引。

{{#each array}} {{@index}}: {{this}} {{/each}}

此外,对于对象迭代,可以使用 {{@key}} 引用当前的键名:

{{#each object}} {{@key}}: {{this}} {{/each}}

在数组上进行迭代时,通过 @first@last 变量记录迭代的第一项和最后一项。当遍历一个对象时,只有 @first 可用。嵌套 的每个块都可以通过基于深度的路径来访问迭代变量。例如,要访问父级的索引,可以使用 {{@../index}}

#with

with 助手代码允许你更改 template-part 的上下文表达式。

template
{{#with person}}
{{firstname}} {{lastname}}
{{/with}}

当与此上下文一起使用时:

input
{
  person: {
    firstname: "Yehuda",
    lastname: "Katz"
  }
}

将得到以下结果:

output
Yehuda Katz

with 还可与代码块参数一起使用来以定义当前代码块中的已知引用。例如,上面的例子可以转换成

template
{{#with city as | city |}}
  {{#with city.location as | loc |}}
    {{city.name}}: {{loc.north}} {{loc.east}}
  {{/with}}
{{/with}}

这使得复杂的模板可以提供比 n ../ 深度引用更清晰的代码。

你可以选择提供一个 {{else}} ,该代码块仅在传递的值为空时渲染。

template
{{#with city}}
{{city.name}} (not shown because there is no city)
{{else}}
No city found
{{/with}}
input
{
  person: {
    firstname: "Yehuda",
    lastname: "Katz"
  }
}

lookup

lookup 助手代码允许使用 Handlebars 变量进行动态的参数解析。

这对于解析数组索引的值非常有用。

template
{{#each people}}
   {{.}} lives in {{lookup ../cities @index}}
{{/each}}

它也可以用于基于输入的数据查找对象属性。以下是一个更复杂的示例:它在子表达式中使用 lookup 将上下文表达式更改为另一个 “ 属性-值” 的对象。

template
{{#each persons as | person |}}
    {{name}} lives in {{#with (lookup ../cities [resident-in])~}}
      {{name}} ({{country}})
    {{/with}}
{{/each}}

log

log 助手代码允许在执行模板时记录上下文的状态。

template
{{log 'this is a simple log output'}}

它将委托给 Handlebars.logger.log ,而 Handlebars.logger.log 可以被覆盖以执行自定义日志记录。

可以将任何数量的参数传递给此方法,并且所有参数都将转发给 logger。

template
{{log 'firstname' firstname 'lastname' lastname}}

可以使用 level 参数设置日志级别。支持的值为 debuginfowarnerrorinfo 是默认值)。

记录是基于 level 参数和在 Handlebars.logger.level 中设置的值(默认为 info)的条件。所有比选定级别更高的记录将被输 出。

template
{{log "debug logging" level="debug"}}
{{log "info logging" level="info"}}
{{log "info logging is the default"}}
{{log "logging a warning" level="warn"}}
{{log "logging an error" level="error"}}