Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Express 3 handlebars template engine with inheritance, partials, i18n and async helpers.

tree: 8615a0d1aa

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 example
Octocat-spinner-32 lib
Octocat-spinner-32 .gitignore
Octocat-spinner-32 LICENSE
Octocat-spinner-32 README.md
Octocat-spinner-32 index.js first commit October 21, 2012
Octocat-spinner-32 package.json
README.md

express-hbs

Express 3 handlebars template engine with multiple layouts, blocks and cached partials.

Open source project from Barc, instant real-time forum on any website.

Usage

To use with express 3.

var hbs = require('express-hbs');

// Use `.hbs` for extensions and find partials in `views/partials`.
app.engine('hbs', hbs.express3({partialsDir: __dirname + '/views/partials'}));
app.set('view engine', 'hbs');
app.set('views', __dirname + '/views');

Options for #express3

hbs.express3({
  defaultLayout: "{String} [Optional] Absolute path to default layout template",
  extname: "{String} Extension for templates, defaults to `.hbs`",
  handlebars: "{Module} Use external handlebars instead of express-hbs dependency",
  partialsDir: "{String} Path to partials templates"
});

Partials may use any extension, which is better for syntax highlighting.

Syntax

To mark where layout should insert page,

{{{body}}}

To declare a block placeholder in layout.

{{{block "pageScripts"}}}

To define block content in a page.

{{contentFor "pageScripts"}}
  CONTENT HERE
{{/contentFor}}

There are three ways to use a layout

  1. Declarative within a page. Use handlebars comment. LAYOUT is a relative path from template.

    {{!< LAYOUT}}

  2. As an option to render

    res.render('veggies', { title: 'My favorite veggies', veggies: veggies, layout: 'layout/veggie' });

  3. Lastly, use defaultLayout if specified in hbs configuration options.

Example

File views/layout/default.hbs

<html>
  <head>
    <title>{{title}}</title>
    <link type="text/css" rel="stylesheet" href="/css/style.css"/>
    {{{block "pageStyles"}}}
  </head>
  <body>
    {{{body}}}

    {{> scripts}}

    {{{block "pageScripts"}}}
  </body>
</html>

File views/index.hbs

{{!< layout/default}}

{{#contentFor "pageStyles"}}
<style>
  .clicker {
    color: blue;
  };
</style>
{{/contentFor}}

<h1>{{title}}</h1>
<p class="clicker">Click me!</p>

To run example project

npm install -d
node example/app.js

Credits

Inspiration and code from donpark/hbs

License

The MIT License (MIT) Copyright (c) 2012 Barc, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Something went wrong with that request. Please try again.