templ

yet another lightweight templating thing

npm install templ
6 downloads in the last week
44 downloads in the last month

templ

yet another lightweight templating thing

build status

Idea

Just a good, simple, handlebars-based templating middleware.

Features

  • handlebars
  • works with Express, Connect, middler, etc
  • pre-compiles your templates for speed
  • layouts
  • transparent partials support - no need to register partials
  • gzip support
  • ETag support
  • built-in file watcher with dynamic recompilation
  • custom header support, i.e., can serve XML feeds, etc.

Usage

require('templ')(<template root>) (root defaults to ./views) gets you a middleware handler which provides:

  • res.vars - template context object, defaults to {}
  • res.render(<template path>, [context], [options]) - end the response with a rendered template. template path is relative to root and should not include extension.
  • res.renderStatus(<code>, [template path], [context]) - end the response with a specific status code and an optional template path (defaults to status-{code})

Middleware

Using middler

var middler = require('middler')
  , templ = require('templ')
  , server = require('http').createServer()

middler(server)
  // simply call templ() with the template root folder, and you get a middleware
  // which provides the render() and renderStatus() methods.
  .add(templ('path/to/views'))
  .get('/', function (req, res, next) {
    // use layout.hbs as layout, and render index.hbs inside it
    res.vars.title = 'my title'; // res.vars is the template context
    res.render('index');
  })
  .get('/about', function (req, res, next) {
    // use layouts/about.hbs as layout, and render pages/about.hbs inside it
    // you can also pass a specific context object to override res.vars:
    res.render('pages/about', {name: 'carlos'}, {layout: 'layouts/about'});
  })
  .get('/raw', function (req, res, next) {
    // render raw.hbs directly
    res.render('raw', null, {layout: false});
  })
  .get('/feed.xml', function (req, res, next) {
    // render feed.hbs with a custom header
    res.render('feed', null, {headers: {'content-type': 'text/xml'}});
  })
  .get('/layout-override', function (req, res, next) {
    // override layout by passing a template function, and render pages/about.hbs inside it
    var precompiled = require('handlebars').compile('<cool>{{{content}}}</cool>');
    res.render('pages/about', {name: 'carlos'}, {layout: precompiled});
  })
  .add(function (req, res, next) {
    // 404 status code, use layout.hbs as layout, and render
    // status-404.hbs inside it
    res.renderStatus(404, {title: 'error 404'});
  })

Basic

Using without a middleware runner

// template root is implied as ./ or ./views
var templ = require('templ')()
  , server = require('http').createServer()

server.on('request', function (req, res) {
  templ(req, res);
  if (req.url === '/') {
    res.render('index', {title: 'basic templ example', num: Math.random()});
  }
  else res.renderStatus(404);
});

Developed by Terra Eclipse

Terra Eclipse, Inc. is a nationally recognized political technology and strategy firm located in Aptos, CA and Washington, D.C.


License: MIT

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

npm loves you