renderly
v0.1.0
Published
A minimal template engine for Node based on ES6 string templates.
Downloads
8
Readme
Renderly - A minimal template engine based on ES6 template strings
A minimal template engine for Node based on ES6 string templates.
It handles variable interpolation, supports rendering partials and it gracefully handles presentation logic(ifs, fors etc) within the template.
Usage
First install:
npm i renderlyProgramatic usage
The API is minimal by design and consists of a single function: createRenderer(options) .
It takes in a set of options and returns a render function.
Options:
globals- A javascript object whose keys are available in any rendered template without them needing to be passed to the views.
const { createRenderer } = require("../index");
// calling createRenderer returns a render function
const render = createRenderer({
globals: {
link: function(post) {
return `posts/${post.id}`;
},
siteTitle: 'Test'
}
});
const tplData = {
name: "John",
// This is a computed property
get lang() {
return `${this.name} speaks French!`;
}
// You can pass functions. Basically whatever you want
currencyFormatter: function() { .... }
};
// A `render` function is automatically added to the template data
console.log(render("./templates/test.tpl", tplData));See also the examples folder.
How the templates look like
In file test.tsg:
<html>
${render('templates/head.tsg', {name})}
<body>
<div>
Hi ${name}. ${ name === 'test' ? 'This is a test name': 'This is a real a
name'} Language info: ${lang}
</div>
<a href="${link({id: 1})}">Test link</a>
</body>
</html>In file head.tsg:
<head>
<title>Main page</title>
${render('templates/meta.tsg', {name})}
</head>In file meta.tsg:
<meta name="content" value="${name}" />Every template has access to a render function that it can use to pull in additional templates.
Additionally, if options were passed all of the globals specified
are passed along to the templates.
Inside the templates you can use standard ES6 template string interpolations to display variables and basically use just about any javascript function.