Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

jQuery Templates for the Rails asset pipeline.

branch: master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 lib
Octocat-spinner-32 spec
Octocat-spinner-32 vendor
Octocat-spinner-32 .gitignore
Octocat-spinner-32 Gemfile Add integration test for including and rendering a template. March 23, 2012
Octocat-spinner-32 LICENSE
Octocat-spinner-32 README.md
Octocat-spinner-32 Rakefile add specs for sprockets engine September 09, 2011
Octocat-spinner-32 jquery-tmpl-rails.gemspec
README.md

Code Climate endorse

jquery-tmpl-rails

This gem adds the jQuery Templates plugin and a corresponding Sprockets engine to the asset pipeline in Rails >= 3.1 applications.

Installation

Add it to your Gemfile and run bundle.

Usage

jQuery templates will be recognized by Sprockets with the .tmpl extension. Place them anywhere in the Sprockets load path.

<!-- app/assets/javascripts/templates/author.tmpl -->
<div class="author">${name}</div>

In your application's JavaScript manifest file, require the jQuery Templates plugin followed by your templates. The templates are compiled and named with their Sprockets logical path:

//= require jquery-tmpl
//= require_tree ./templates

$.tmpl("templates/author", { name: "Jimmy" }).appendTo("#author");

Configuration

If the path to all of your templates have a common prefix that you prefer is not included in the template's name, you can set this option in config/application.rb:

config.jquery_templates.prefix = "templates"

That would change the previous example to this:

$.tmpl("author", { name: "Jimmy" }).appendTo("#author");

The prefix can also be a regular expression. For example, to use only the name of the file for the template name, regardless of directory structure:

config.jquery_templates.prefix = %r{([^/]*/)*}

Happy templating!

Acknowledgements

The Sprockets engine was originally derived from the sprockets-jquery-tmpl gem. If you want a similar mechanism for use outside of Rails, take a look at this project.

Something went wrong with that request. Please try again.