Skip to content

roperzh/dotjs_sprockets

Repository files navigation

DotjsSprockets

Gem Version Code Climate Inline docs

doT.js templates for any application using sprockets.

Installation

Add this line to your application's Gemfile:

 gem "dotjs_sprockets"

And then execute:

$ bundle

Usage

To get your template loaded and accessible client-side via the JST variable, you must follow:

  • The template file must be under one of the Sprockets load paths ( usually assets/javascripts or assets/templates )
  • The template must have the following extension: .jst.djs

That's all!

Example

app/
└── assets/
    └── javascripts/
        └── my_template.jst.djs

In this case the template will be accessible in the client via:

// The compiler function
JST["my_template"] //=> function() ...

//The compiled template
JST["my_template"]() //=> <h2>Hello!</h2> ...

Roadmap

  • Provide an easy way to change the djs extension
  • Check support and compatibility for nested templates

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Push to the branch (git push origin my-new-feature)
  4. Create a new Pull Request