handlebars-template-loader
A Handlebars template loader for Webpack
Changelog
* 1.0: Loader now works with Webpack 4. Still a beta release.
Table of Contents
Installation
npm install handlebars-template-loader
Since version 0.5.4, this loaders does not include Handlebars in its dependency list. Make sure to install Handlebars before running webpack. Read https://github.com/npm/npm/issues/6565 for details.
Usage
moduleexports = //... module: loaders: test: /\.hbs/ loader: "handlebars-template-loader" node: fs: "empty" // avoids error messages ;
Loading templates
<!-- File: hello.hbs -->Hello {{name}}
// File: app.jsvar compiled = ;return ;
Using helpers
// File: helpers.js // Get Handlebars instancevar Handlebars = ; Handlebars; Handlebars;
// File: main.js // Include template helpers;
Using partials
// Get Handlebars instance var Handlebars = ; // Require partial var partial = ; // Register partial Handlebars;
Options
Prepending filename comment
When debugging a large single page app with the DevTools, it's often hard to find the template that contains a bug. With the following config a HTML comment is prepended to the template with the relative path in it (e.g. <!-- view/user/edit.html -->
).
moduleexports = //... module: loaders: test: /\.hbs$/ loader: "handlebars-template-loader" query: prependFilenameComment: __dirname ;
Images
In order to load images you must install either the file-loader
or the url-loader
package.
moduleexports = //... module: loaders: //... test: /\.hbs/ loader: "handlebars-template-loader" test: /\.jpg/ loader: "file-loader" test: /\.png/ loader: "url-loader?mimetype=image/png" ;
<!-- Require image using file-loader --> <!-- Require image using url-loader -->
Images with an absolute path are not translated unless a root
option is defined
<!-- Using root = undefined => no translation --> <!-- Using root = 'images' => require('images/image.jpg') -->
In order to deactivate image processing define the attributes
option as an empty array.
moduleexports = //... module: loaders: test: /\.hbs$/ loader: "handlebars-template-loader" query: attributes: ;
You could also add which attributes need to be processed in the form of pairs tag:attribute.
moduleexports = //... module: loaders: test: /\.hbs$/ loader: "handlebars-template-loader" query: attributes: 'img:src' 'x-img:src' ;
Dynamic attributes won't be afected by this behaviour by default.
<!-- Ignore "root" argument if attribute contains a template expression -->
In order to append the root directory you'll need to specify the parseDynamicRoutes
argument.
moduleexports = //... module: loaders: test: /\.html$/ loader: "handlebars-template-loader" query: root: "myapp" parseDynamicRoutes: true ;
<!-- Attribute now translates to "myapp/img/{{doge}}.png" -->
Runtime path
If you have a custom location for your Handlebars runtime module then you can set that in your query
object via the runtimePath
property. This is the path to the Handlebars runtime that every .hbs
file will require and use. By default this loader looks up the absolute path to the handlebars/runtime
in your node_modules
folder. Changing this property is useful if you are doing somethign non-standard with your Handlebar templates, for example setting an alias for the handlebars/runtime
path.
moduleexports = //... module: loaders: test: /\.html$/ loader: "handlebars-template-loader" query: runtimePath: 'handlebars/runtime' ;
Compilation options
Handlebars does support additional compilation options that you can specify in your query
object literal.
moduleexports = //... module: loaders: test: /\.html$/ loader: "handlebars-template-loader" query: root: "myapp" strict: true noEscape: true ;
Macros
Macros allow additional features like including templates or inserting custom text in a compiled templates.
require
The require
macro expects a path to a handlebars template. The macro is then translated to a webpack require expression that evaluates the template using the same arguments.
Profile Name: {{name}}Surname: {{surname}} @require('profile-details.hbs')
include
While the require
macro expects a resource that returns a function, the include
macro can be used for resources that return plain text. For example, we can include text loaded through the html-loader
directly in our template.
Introduction @include('intro.htm') Authors @include('authors.htm')
repeat
The repeat
macro will repeat the given string the amount of times as specified by the second argument (default to 1). It will only accept string literals.
Lorem ipsum@repeat('', 3)Sit amet@repeat('\n')
Custom macros
We can include additional macros by defining them in the webpack configuration file. Remember that the value returned by a macro is inserted as plain javascript, so in order to insert a custom text we need to use nested quotes. For example, let's say that we want a macro that includes a copyright string in our template.
// File: webpack.config.jsmoduleexports = // ... module: loaders: // ... test: /\.hbs/ loader: "handlebars-template-loader" macros: { return "'<p>Copyright FakeCorp 2014 - 2015</p>'"; }
We then invoke our macro from within the template as usual.
@copyright()
Disabling macros
You can disable macros if you are a bit unsure about their usage or just simply want faster processing. This is achieved by setting the parseMacros
options to false.
moduleexports = // ... module: loaders: // ... test: /\.hbs/ loader: "handlebars-template-loader" query: parseMacros: false
Arguments
Macros can accept an arbitrary number of arguments. Only boolean, strings and numeric types are supported.
// File: webpack.config.jsmoduleexports = // ... module: loaders: // ... test: /\.html$/ loader: "handlebars-template-loader" macros: { return "'<h" + size + ">" + content + "</h" + size + ">'"; }
@header(1, 'Welcome')Lorem ipsum@header(3, 'Contents')Sit amet
Escaping
Macro expressions can be escaped with the \
character.
@repeat('', 3)\@escaped()@custom_macro()
Translates to
@escaped()custom string
License
Released under the MIT license.