handlebars.js README

The project's README from github.com/handlebars-lang/handlebars.js. As one markdown file: README.md.

CI Build Status jsDelivr Hits npm downloads npm version Bundle size Install size

Handlebars.js

Handlebars provides the power necessary to let you build semantic templates effectively with no frustration. Handlebars is largely compatible with Mustache templates. In most cases it is possible to swap out Mustache with Handlebars and continue using your current templates.

Checkout the official Handlebars docs site at handlebarsjs.com and try our live demo.

Installing

See our installation documentation.

Usage

In general, the syntax of Handlebars.js templates is a superset of Mustache templates. For basic syntax, check out the Mustache manpage.

Once you have a template, use the Handlebars.compile method to compile the template into a function. The generated function takes a context argument, which will be used to render the template.

var source =
  '<p>Hello, my name is {{name}}. I am from {{hometown}}. I have ' +
  '{{kids.length}} kids:</p>' +
  '<ul>{{#kids}}<li>{{name}} is {{age}}</li>{{/kids}}</ul>';
var template = Handlebars.compile(source);

var data = {
  name: 'Alan',
  hometown: 'Somewhere, TX',
  kids: [
    { name: 'Jimmy', age: '12' },
    { name: 'Sally', age: '4' },
  ],
};
var result = template(data);

// Would render:
// <p>Hello, my name is Alan. I am from Somewhere, TX. I have 2 kids:</p>
// <ul>
//   <li>Jimmy is 12</li>
//   <li>Sally is 4</li>
// </ul>

Full documentation and more examples are at handlebarsjs.com.

Precompiling Templates

Handlebars allows templates to be precompiled and included as javascript code rather than the handlebars template allowing for faster startup time. Full details are located here.

Differences Between Handlebars.js and Mustache

Handlebars.js adds a couple of additional features to make writing templates easier and also changes a tiny detail of how partials work.

Block expressions have the same syntax as mustache sections but should not be confused with one another. Sections are akin to an implicit each or with statement depending on the input data and helpers are explicit pieces of code that are free to implement whatever behavior they like. The mustache spec defines the exact behavior of sections. In the case of name conflicts, helpers are given priority.

Compatibility

There are a few Mustache behaviors that Handlebars does not implement.

Supported Environments

Handlebars has been designed to work in any ECMAScript 2020 environment. This includes

If you need to support older environments, use Handlebars version 4.

Performance

In a rough performance test, precompiled Handlebars.js templates (in the original version of Handlebars.js) rendered in about half the time of Mustache templates. It would be a shame if it were any other way, since they were precompiled, but the difference in architecture does have some big performance advantages. Justin Marney, a.k.a. gotascii, confirmed that with an independent test. The rewritten Handlebars (current version) is faster than the old version, with many performance tests being 5 to 7 times faster than the Mustache equivalent.

Benchmarks

The project includes a comprehensive benchmark suite (powered by tinybench) that measures compilation, execution, precompilation, and end-to-end performance across templates of varying size and complexity.

# Run benchmarks (auto-labels with current git branch)
pnpm run bench

# Run with a custom label
pnpm run bench -- --label my-optimization

# Filter templates by name (regex, case-insensitive)
pnpm run bench -- --grep "complex|recursive"

# Run only specific sections (regex, case-insensitive)
pnpm run bench -- --section precompil
pnpm run bench -- --section "compilation|precompil"

# Compare results
pnpm run bench:compare

# Or specify files explicitly
pnpm run bench:compare -- bench/results/bench-*-main.md bench/results/bench-*-feat.md

Results are saved as timestamped Markdown files in bench/results/. Each report includes ops/sec, avg latency, p50/p75/p99 percentiles, and sample counts.

Typical workflow for comparing branches:

git checkout main && pnpm run bench
git checkout my-feature && pnpm run bench
pnpm run bench:compare

When run without arguments, bench:compare auto-selects two result files: if a file labelled "main" exists it is always used as the baseline, otherwise the older file is the baseline. The comparison uses p75 latency for the diff to filter outliers, and marks changes with ! (>2%) and !! (>5%).

Upgrading

See release-notes.md for upgrade notes.

If you are using Handlebars in production, please regularly look for issues labeled possibly breaking. If this label is applied to an issue, it means that the requested change is probably not a breaking change, but since Handlebars is widely in use by a lot of people, there's always a chance that it breaks somebody's build.

Known Issues

See FAQ.md for known issues and common pitfalls.

Handlebars in the Wild

External Resources

Have a project using Handlebars? Send us a pull request!

License

Handlebars.js is released under the MIT license.

handlebars.js (handlebars-lang/handlebars.js)

Searching Database…

18.7K ·GitHub
Handlebars.js
Что это?Handlebars.js — это JavaScript-шаблонизатор, который позволяет создавать семантичные HTML-шаблоны: строки шаблонов с плейсхолдерами компилируются в функции рендеринга.
Это фреймворк или библиотека?Это библиотека, а не фреймворк: вы компилируете строку шаблона в функцию с помощью Handlebars.compile, а затем вызываете эту функцию с данными, чтобы получить готовый результат.
Как добавить это в проект?Установите через пакетный менеджер и следуйте документации по установке на официальном сайте, а затем компилируйте строки шаблонов с помощью Handlebars.compile.
От чего это зависит и где работает?Библиотека поставляется с несколькими небольшими зависимостями времени выполнения (@handlebars/parser, neo-async, source-map) и рассчитана на работу в любой среде ECMAScript 2020, включая Node.js, Chrome, Firefox, Safari и Edge.
Мои существующие шаблоны Mustache просто заработают или есть подводные камни?Handlebars в основном совместим с Mustache, но по умолчанию не выполняет рекурсивный поиск (нужен флаг совместимости, который снижает производительность), не поддерживает лямбды в стиле Mustache и альтернативные разделители, а также требует, чтобы управляющий символ сразу следовал за открывающими фигурными скобками.
Кто обычно использует это под капотом?Это встроенный движок шаблонов во многих других инструментах и фреймворках, например Ember.js, движках представлений Express (express-handlebars, hbs), генераторах статических сайтов (Assemble) и блог-платформе Ghost.
Чем Handlebars отличается от обычного Mustache?Handlebars добавляет к синтаксису Mustache вложенный поиск по путям, хелперы, блочные выражения, литеральные значения и комментарии с разделителями, а при конфликте имён даёт хелперам приоритет над секциями.
Можно ли предварительно скомпилировать шаблоны для более быстрого запуска?Да, шаблоны Handlebars можно заранее скомпилировать в обычный JavaScript вместо компиляции во время выполнения, что ускоряет запуск.
Handlebars действительно быстрее Mustache?По результатам тестов производительности проекта текущая переписанная версия Handlebars рендерит шаблоны в 5–7 раз быстрее эквивалентных шаблонов Mustache, особенно при предварительной компиляции.
Что делать, если нужна поддержка старых браузеров?Эта версия рассчитана на среды ECMAScript 2020; для более старых сред в README рекомендуется использовать Handlebars версии 4.
What are similar projects?mustache.js, NotionNext, nextra, core, react-boilerplate, workflow_templates, markdown-it, tui.editor
Which topics is it in?markup, templates, static-site-generator, template, i18n, vue, web-development, react, frontend, nodejs, library, javascript
Creator
handlebars-lang
Size
4.6 MB
Stars
18.7K
Updated
CommitJun 24Releasev4.7.10Oct 05
Age
16y
Commits · 90 Days