README.md

Handlebars Asset-Pipeline

MOVED: This project has moved to a sub project of the main asset-pipeline repository http://github.com/bertramdev/asset-pipeline

Overview

The JVM handlebars-asset-pipeline is a plugin that provides handlebars template precompiler support to asset-pipeline.

For more information on how to use asset-pipeline, visit here.

Installation

Simply add this plugin to your classpath in gradle or dependencies list depending on how you are using it

//Example build.gradle file
buildscript {
  repositories {
    mavenCentral()
  }
  dependencies {
    classpath 'com.bertramlabs.plugins:asset-pipeline-gradle:2.0.13'
    classpath 'com.bertramlabs.plugins:handlebars-asset-pipeline:2.0.13'
  }
}

NOTE The version of this plugin is no longer coupled to the version of handlebars.js

Usage

By default, this plugin will scan for a copy of handlebars.js in your asset resolver paths. If it can find it, it will use it to compile your handlebars templates. Otherwise it will use an embedded copy of handlebars (4.0.2).

Simply create files in your standard assets/javascripts folder with extension .handlebars or .hbs. By default the templateRoot for your template names is specified as 'templates'. This means that any handlebars file within the root assets/javascripts folder will utilize its file name (without the extension) as its template name. Or a file in templates/show.handlebars would be named templates/show. If templates is set as the templateRoot than it would be named show

It is also possible to change the template path seperator for templatenames to be used by handlebars:

Gradle Example:

assets {
	config = [
		handlebars: [
			templateRoot: 'templates',
			templatePathSeperator: '/'
		]
	]
}

Grails Example:

grails {
	assets {
		handlebars {
			templateRoot = 'templates'
			templatePathSeperator = "/"
		}
	}
}

To use the handlebars runtime simply add handlebars js to your application.js or your gsp file

//=require handlebars

Using in the Browser

Template functions are stored in the Handlebars.templates object using the template name. If the template name is person/show, then the template function can be accessed from Handlebars.templates['person/show']. See the Template Names section for how template names are calculated.

See the Handlebars.js website for more information on using Handlebars template functions.

Custom Template Wrapper

This plugin supports customizing the javascript that is wrapped around the compiled template. It provides access to 2 binded variables templateName and compiledTemplate. This might be useful if you were namespace isolating the Handlebars runtime as an example:

grails {
	assets {
	  handlebers {
	  	wrapTemplate = '''
	  	 (function(){
			var template = HandlebarsCustom.template, templates = HandlebarsCustom.templates = HandlebarsCustom.templates || {};
				templates['$templateName'] = template($compiledTemplate);
		}());
	  	'''
	  }
    }
}

NOTE: The groovy-template library is required (included with groovy-all).