README

requirejs-handlebars

Simple Handlebars plugin for RequireJS.

Requires the official text! plugin.
Like the offical text! plugin, include the file extension in the module id.
For (optimized) builds using r.js, make sure to
- Install Handlebars from npm (not Bower or website).
- Include the runtime version of Handlebars.

Example usage

define(['hb!myTemplate.tpl'], function(myTemplate) {

    var html = myTemplate({name:'John Doe'});

});

Partials

This plugin has no automatic partial registration (by design).

define(['hb!myTemplate.tpl', 'hb!myPartial.tpl'], function(myTemplate, myPartial) {

    var html = myTemplate({name:'John Doe'}, {
        partials: {
            myPartial: myPartial
        }
    });

});

Example config

Handlebars includes AMD builds since v1.1.0. Use a package config:

require.config({
    paths: {
        text: 'lib/text/text',
        hb: 'lib/requirejs-handlebars/hb',
        'handlebars.runtime': 'node_modules/handlebars/handlebars.runtime.amd'
    },
    packages: [
        {
            name: 'handlebars',
            location: 'node_modules/handlebars/dist/amd',
            main: './handlebars'
        }
    ]
});

Using a version of Handlebars lower than v1.1.0? Then use a configuration like this:

require.config({
    paths: {
        text: 'lib/requirejs-text/text',
        handlebars: 'node_modules/handlebars/dist/handlebars',
        hb: 'lib/requirejs-handlebars/hb'
    },
    shim: {
        handlebars: {
            exports: 'Handlebars'
        }
    }
});

Handlebars runtime

The Handlebars runtime is much smaller than the full version, and it's made to render pre-compiled templates. It's highly efficient to use pre-compiled templates and the runtime template engine in production.

Pre-compiled templates use handlebars.runtime as a dependency.

Still using a version of Handlebars lower than v1.1.0? Then override the path for handlebars, e.g.:

    paths: {
        handlebars: 'node_modules/handlebars/dist/handlebars.runtime'
    }

License

MIT

Usage no npm install needed!