Odesza
Odesza allows you to write clean, expressive templates with inline JavaScript. It offers the flexibility of multiple inheritance and inline programming logic with the simplicity of writing plain HTML and JS.
- multiple inheritance (extends, includes, blocks)
- full access to inline ES6 JavaScript
- support for Express
Variables & Expressions
Variables are passed in when Odesza templates are rendered. Scope is maintained through includes and extends. You can also treat ${}
as a function statement.
code
var vars = {
title: 'hello world',
names: ['foo', 'bar']
};
odesza.compile('hello', vars);
hello.ode
<title>${title}</title>
<p>
Welcome, ${names.map(n => `<i>${n}</i>`).join(', ')}!
</p>
output
<title>hello world</title>
<p>
Welcome, <i>foo</i>, <i>bar</i>
</p>
Inline JavaScript
Odesza makes it easy to write inline JavaScript in your templates. Under the hood, templates are evaluated as ES6 template strings, which means you have access to ${}
expressions. If you need more flexibility with inline js, you can create a self-executing function expression with code inside it like this: ${(() => { ... }())
.
code
var vars = {
names: ['wells', 'joe', 'dom']
};
odesza.compile('greetings.ode', vars);
greetings.ode
<h2>welcome ${names.join(', ')}!</h2>
${(() => {
var items = [];
names.forEach((name, index) => {
items.push(`<div>${index + 1}: ${name}</div>`)
});
return items.join('<br/>');
})()}
output
<h2>welcome wells, joe, dom!</h2>
<div>1: wells</div><br/>
<div>2: joe</div><br/>
<div>3: dom</div>
Partials
Odesza makes it easy to nest templates within each other. You can include templates as many levels deep as you like. Variables maintain scope in included files.
greeting.ode
hello!
welcome.ode
include greeting
welcome, ${name}!
question.ode
include welcome
would you like to play a game, ${name}?
code
var vars = {
name: 'foo'
};
odesza.compile('question', vars);
output
hello!
welcome, foo!
would you like to play a game, foo?
Inheritance
Odesza gives you access to multiple inheritance through extending templates and block scopes.
layout.ode
<!doctype html>
<html>
<head>
<title>${title}</title>
block js
</head>
<body>
block content
</body>
</html>
page.ode (extends layout.ode)
extends layout
block js
<script src="${base_path}/page.js"></script>
endblock
block content
<p>
Some content.
</p>
endblock
extended_page.ode (extends page.ode, overwrites 'content' block)
extends page
block content
<p>
Overwritten content.
</p>
endblock
code
var vars = {
title: 'hello world',
base_path: 'public/js'
};
odesza.compile('extended_page.ode', vars);
output
<!doctype html>
<html>
<head>
<title>hello world</title>
<script src="public/js/page.js"></script>
</head>
<body>
<p>
Overwritten content.
</p>
</body>
</html>
Express Support
index.js
app.set('view engine', 'ode');
app.engine('.ode', require('odesza').__express);
controller
res.render('template', {
foo: 'bar'
});
Command Line
You can compile odesza templates from the command line to stdout
or an output file.
odesza <file> [-o <output>]
Install
npm install odesza --save
License
MIT