Trên GitHub, TryGhost/express-hbs đã đạt 457 sao, ngôn ngữ JavaScript. Express handlebars template engine with inheritance, partials, i18n and async helpers.
Tóm tắt dựng từ metadata GitHub của chính dự án — chưa có bài review TopGit. Trang sẽ tự động cập nhật khi bài review đầy đủ được xuất bản.
VÌ SAO CHƯA CÓ REVIEW
TopGit viết bài đầy đủ cho repo có nhiều sao nhất và được yêu cầu nhiều nhất. Trang này là snapshot trong thời gian chờ — xem README gốc ở tab READ ME.
Express Handlebars template engine for Express apps, with nested layouts,
named content blocks, cached partials, i18n helpers, and asynchronous helpers.
express-hbs exposes Express-compatible view engine functions and a shared
Handlebars instance. It is used by apps that want Handlebars templates with
layout inheritance and block-style content regions while keeping the familiar
app.engine() integration.
Requirements
Node.js 20 or later
the pinned pnpm version when working on this repository
v2.0.0
Version 2 was a rewrite and cleanup, with no known breaking changes. Lots of bugs were fixed which may have subtly changed behaviour.
Full details: https://github.com/TryGhost/express-hbs/releases/tag/2.0.0
v1.0.0 Breaking Changes
If you're upgrading from v0.8.4 to v1.0.0 there are some potentially breaking changes to be aware of:
Handlebars @v4.0.5 - please see the handlebars v4.0 compatibility notes
The file extension for partial files must now match the extension configured in extname - please see the PR
Usage
Register the engine with Express using hbs.express4().
var hbs = require('express-hbs');
// Use `.hbs` for extensions and find partials in `views/partials`.
app.engine('hbs', hbs.express4({
partialsDir: __dirname + '/views/partials'
}));
app.set('view engine', 'hbs');
app.set('views', __dirname + '/views');
hbs.express3() is still available for legacy apps and accepts the same
options:
hbs.express4({
partialsDir: "{String/Array} [Required] Path to partials templates, one or several directories",
// OPTIONAL settings
restrictLayoutsTo: "{String} Absolute path to a directory to restrict layout directive reading from",
blockHelperName: "{String} Override 'block' helper name.",
contentHelperName: "{String} Override 'contentFor' helper name.",
defaultLayout: "{String} Absolute path to default layout template",
extname: "{String} Extension for templates & partials, defaults to `.hbs`",
handlebars: "{Module} Use external handlebars instead of express-hbs dependency",
i18n: "{Object} i18n object",
layoutsDir: "{String} Path to layout templates",
templateOptions: "{Object} options to pass to template()",
beautify: "{Boolean} whether to pretty print HTML, see github.com/einars/js-beautify .jsbeautifyrc",
// override the default compile
onCompile: function(exhbs, source, filename) {
var options;
if (filename && filename.indexOf('partials') > -1) {
options = {preventIndent: true};
}
return exhbs.handlebars.compile(source, options);
}
});
Syntax
To mark where a layout should insert page content:
{{{body}}}
To declare a block placeholder in a layout:
{{{block "pageScripts"}}}
To define block content in a page:
{{#contentFor "pageScripts"}}
CONTENT HERE
{{/contentFor}}
Layouts
There are three ways to use a layout, listed in precedence order:
Declarative within a page. Use handlebars comment
{{!< LAYOUT}}
Layout file resolution:
If path starts with '.'
LAYOUT is relative to template
Else If `layoutsDir` is set
LAYOUT is relative to `layoutsDir`
Else
LAYOUT from path.resolve(dirname(template), LAYOUT)
As an option to render
⚠️ Passing user-controlled data into the layout option can read arbitrary
files unless restrictLayoutsTo confines layout resolution to a safe
directory. Do not call res.render('index', req.query) or similar without
setting restrictLayoutsTo.
This option also allows layout suppression, including the default layout and
template-declared layouts, by passing a falsey JavaScript value:
res.render('veggies', {
title: 'My favorite veggies',
veggies: veggies,
layout: null // render without using a layout template
});
Layout file resolution:
If path starts with '.'
layout is relative to template
Else If `layoutsDir` is set
layout is relative to `layoutsDir`
Else
layout from path.resolve(viewsDir, layout)
Lastly, use defaultLayout if specified in hbs configuration options.
Layouts can be nested: just include a declarative layout tag within any layout
template to have its content included in the declared "parent" layout. Be
aware that too much nesting can impact performances, and stay away from
infinite loops!
Helpers
Synchronous helpers
hbs.registerHelper('link', function(text, options) {
var attrs = [];
for(var prop in options.hash) {
attrs.push(prop + '="' + options.hash[prop] + '"');
}
return new hbs.SafeString(
"<a " + attrs.join(" ") + ">" + text + "</a>"
);
});
var i18n = require('i18n');
// minimal config
i18n.configure({
locales: ['en', 'fr'],
cookie: 'locale',
directory: __dirname + "/locales"
});
app.engine('hbs', hbs.express3({
// ... options from above
i18n: i18n, // registers __ and __n helpers
}));
app.set('view engine', 'hbs');
app.set('views', viewsDir);
// cookies are needed
app.use(express.cookieParser());
// init i18n module
app.use(i18n.init);
Engine Instances
Create isolated engine instances with their own cache system and handlebars engine.
var hbs = require('express-hbs');
var instance1 = hbs.create();
var instance2 = hbs.create();
Template options
The main use case for template options is setting the Handlebars data object,
which creates global template variables accessible with an @ prefix.
Template options can be passed when creating an engine instance, updated with
updateTemplateOptions(templateOptions), or set for one request with
updateLocalTemplateOptions(locals, templateOptions) on res.locals.
Both of these methods have a companion method getTemplateOptions() and getLocalTemplateOptions(locals), which should be used when extending or merging the current options.
Trang TopGit này là một snapshot — tab "Readme" hiển thị nguyên văn README của repo (đã bỏ link, giữ ảnh). Repo GitHub ở github.com/TryGhost/express-hbs là nguồn chính thức.
TryGhost/express-hbs có bao nhiêu sao?
TryGhost/express-hbs có 457 sao GitHub — tải lại trang để xem số mới nhất, hoặc xem trực tiếp github.com/TryGhost/express-hbs. TopGit phản chiếu số sao của GitHub nhưng không cam kết đến từng phút.
TryGhost/express-hbs có tag gì không?
Bản đồng bộ chưa ghi nhận topic GitHub nào cho TryGhost/express-hbs. GitHub topics hiển thị ở thanh bên phải trang repo — đó là nơi đáng kiểm tra nhất.
TryGhost/express-hbs còn đang phát triển không?
Commit gần nhất trên TryGhost/express-hbs là 11 ngày trước (theo timestamp GitHub). Repo có 84 fork — một chỉ báo về mức độ quan tâm của cộng đồng.
TryGhost/express-hbs viết bằng ngôn ngữ gì?
TryGhost/express-hbs chủ yếu viết bằng JavaScript. Trường "language" của GitHub dựa trên phần lớn byte ở nhánh mặc định.
Đọc đầy đủ README ở tab phía trên.
Chưa chắc express-hbs có hợp với bạn?
Để ChatGPT, Claude hoặc Perplexity tìm hiểu giúp — bấm bên dưới và xem AI nói gì về express-hbs.