multiplex-templates

Easy embedding for multiple template languages

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
multiplex-templates
211.3.07 years ago9 years agoMinified + gzip package size for multiplex-templates in KB

Readme

multiplex-templates
Embed components in other components!
Build Status Code Climate

Install

npm install --save multiplex-templates

Usage

render a template

var multiplex = require('multiplex-templates')();

multiplex.render('path/to/template.ext', data);

This will render a template. The templating engine it uses is determined by the template's extension.
e.g.
components/paragraph/template.jade
templates/header.nunjucks

Engines

We support all of the engines that consolidate.js supports.
This module exposes the instances of the templating engines, so you can add mixins/filters/globals/etc onto them:
var env = multiplex.engines.nunjucks;

env.addGlobal('key', 'value');

You can also instantiate your own engines (and configure them however you like) and pass them into multiplex-templates.
var env = require('nunjucks').configure('.', { watch: false }),
  jadeEnv = require('jade'), // so cool, doesn't need config (⌐■_■)
  multiplex = require('multiplex-templates')({
    nunjucks: env,
    jade: jadeEnv
  });

// multiplex.engines.nunjucks === env

Cross-engine Embedding

To embed a template, call the embed function in the parent template, passing in the name of the template you want to embed, plus (optionally) data and defaults objects. The embed function is available in all templating languages that allow functions inside template locals.
Nunjucks:
{{ embed('path/to/tpl.nunjucks', data) | safe }}

Jade:
section#foo
  p.embedded
    != embed('path/to/tpl.jade', data)

The data you pass in is then used to render the child template. You can optionally pass in additional data:
Nunjucks:
{{ embed('path/to/tpl.mustache', data, defaults) | safe }}

Jade:
section#foo
  p.embedded
    != embed('path/to/tpl.ejs', data, defaults)

Properties in the data object will overwrite properties of the same name in the defaults object, as this uses lodash's fast _.defaults() method.

Tests

npm test