EJS
Embedded JavaScript templates
Installation
$ npm install ejs
Features
- Control flow with
<% %>
- Escaped output with
<%= %>
- Unescaped raw output with
<%- %>
- Trim-mode ('newline slurping') with
-%>
ending tag - Custom delimiters (e.g., use '' instead of '<% %>')
- Includes
- Client-side support
- Static caching of intermediate JavaScript
- Static caching of templates
- Complies with the Express view system
Example
<% if (user) { %>
<h2><%= user.name %></h2>
<% } %>
Usage
var template = ejs.compile(str, options);
template(data);
ejs.render(str, data, options);
Options
cache
Compiled functions are cached, requires filename
filename
Used by cache
to key caches, and for includescontext
Function execution contextcompileDebug
When false
no debug instrumentation is compiledclient
Returns standalone compiled functiondelimiter
Character to use with angle brackets for open/close
Tags
<%
'Scriptlet' tag, for control-flow, no output<%=
Outputs the value into the template (HTML escaped)<%-
Outputs the unescaped value into the template<%#
Comment tag, no execution, no output<%%
Outputs a literal '<%'%>
Plain ending tag-%>
Trim-mode ('newline slurp') tag, trims following newline
Includes
Includes are relative to the template with the include
call. (This
requires the 'filename' option.) For example if you have "./views/users.ejs" and
"./views/user/show.ejs" you would use <%- include('user/show'); %>
.
You'll likely want to use the raw output tag (<%-
) with your include to avoid
double-escaping the HTML output.
<ul>
<% users.forEach(function(user){ %>
<%- include('user/show', {user: user}); %>
<% }); %>
</ul>
Includes are inserted at runtime, so you can use variables for the path in the
include
call (for example <%- include(somePath); %>
). Variables in your
top-level data object are available to all your includes, but local variables
need to be passed down.
NOTE: Include preprocessor directives (<% include user/show %>
) are
still supported.
Custom delimiters
Custom delimiters can be applied on a per-template basis, or globally:
var ejs = require('ejs'),
users = ['geddy', 'neil', 'alex'];
ejs.render('<?= users.join(' + '); ?>, {users: users}, {delimiter: '?'});
// => 'geddy + neil + alex'
// Or globally
ejs.delimiter = '$';
ejs.render('<$= users.join(' + '); $>, {users: users});
Layouts
EJS does not specifically support blocks, but layouts can be implemented by
including headers and footers, like so:
<%- include('header'); -%>
<h1>Title</h1>
<p>My page</p>
<%- include('footer'); -%>
Client-side support
Include ./ejs.js
or ./ejs.min.js
and ejs.render(str)
.
Related projects
There are a number of implementations of EJS:
License
Licensed under the Apache License, Version 2.0
(http://www.apache.org/licenses/LICENSE-2.0)
EJS Embedded JavaScript templates copyright 2112
mde@fleegix.org.