npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

handlebars-extended

v1.1.0

Published

Handlebars extended (HBX) with nested layout support

Downloads

7

Readme

Handlebars Extended (HBX)

Build Status

A lightweight wrapper around the popular Handlebars library to add support for nested layouts.

Getting started

The package can be installed with the following command:

npm install hbx --save

Example

The example below shows how a Handlebars content page can be nested within a layout.

Layout file (root.hbs)

<html>
<head><title>{{title}}</title>
<body>
{{{content}}}
</body>
</html>

Content file (welcome.hbs)

{{! layout: root}}
<h1>Welcome page</h1>
{{quote}}

Code

var hbx = require('hbx');

// register the global layout
hbx.registerLayout('root', '<FROM ROOT.HBS>');

// compile the content page template
var template = hbx.compile('<FROM WELCOME.HBS>');

// render the nested content page with data
var result = template({ title: 'Why hello there!', question: 'How is your day going?' });

Resulting HTML

<html>
<head><title>Why hello there!</title>
<body>
<h1>Welcome page</h1>
How is your day going?
</body>
</html>

Usage

Layout definition

The layout definition is a Handlebars comment that defines the name of the layout that should be used. By using comments, the definition will be ignored if by the standard Handlebars project.

{{! layout: NAME }}

Layouts can also define layout definitions meaning multiple layers of nest are possible.

Monkey Patching

In order to maintain existing handlebars functionality, HBX monkey patches the existing compile method. Currently the precompile method has been disabled.

API

hbx.registerLayout(name, layout)

Registers a global layout that can then be used by all future compile calls.

hbx.registerLayout('root', '<div>{{{content}}}</div>');

hbx.unregisterLayout(name)

Removes a registered global layout, this will result in the layout no longer being available to any past or future compile calls.

hbx.unregisterLayout('root');

template({ layouts: {} })

Local layouts can also be specified when rendering a template, just like partials and helpers in Handlebars.

var template = hbx.compile('{{! layout: root }}\nhello');
template({ layouts: { root: '<div>{{{content}}}</div>' } });