https://github.com/tj/ejs

Embedded JavaScript templates for node
https://github.com/tj/ejs

Last synced: 1 day ago
JSON representation

Embedded JavaScript templates for node

• Host: GitHub
• URL: https://github.com/tj/ejs
• Owner: tj
• Created: 2010-07-09T19:55:35.000Z (over 14 years ago)
• Default Branch: master
• Last Pushed: 2023-09-12T07:15:27.000Z (over 1 year ago)
• Last Synced: 2024-12-05T04:02:13.425Z (8 days ago)
• Language: JavaScript
• Homepage:
• Size: 1.13 MB
• Stars: 4,471
• Watchers: 137
• Forks: 513
• Open Issues: 117
• Metadata Files:
  • Readme: Readme.md
  • Changelog: History.md

Awesome Lists containing this project

• awesome-github-star - ejs

README

        
# EJS

Embedded JavaScript templates.

[![Build Status](https://travis-ci.org/visionmedia/ejs.png)](https://travis-ci.org/visionmedia/ejs)

- - -

NOTE: Version 2 of EJS makes some breaking changes with this version (notably,

removal of the filters feature).  Work on v2 is happening here:

https://github.com/mde/ejs

File issues for EJS v2 here: https://github.com/mde/ejs/issues

- - -

## Installation

    $ npm install ejs

## Features

  * Complies with the [Express](http://expressjs.com) view system

  * Static caching of intermediate JavaScript

  * Unbuffered code for conditionals etc `<% code %>`

  * Escapes html by default with `<%= code %>`

  * Unescaped buffering with `<%- code %>`

  * Supports tag customization

  * Filter support for designer-friendly templates

  * Includes

  * Client-side support

  * Newline slurping with `<% code -%>` or `<% -%>` or `<%= code -%>` or `<%- code -%>`

## Example

    <% if (user) { %>

	    
<%= user.name %>

    <% } %>

    

## Try out a live example now




## Usage

    ejs.compile(str, options);

    // => Function

    ejs.render(str, options);

    // => str

## Options

  - `cache`           Compiled functions are cached, requires `filename`

  - `filename`        Used by `cache` to key caches

  - `scope`           Function execution context

  - `debug`           Output generated function body

  - `compileDebug`    When `false` no debug instrumentation is compiled

  - `client`          Returns standalone compiled function

  - `open`            Open tag, defaulting to "<%"

  - `close`           Closing tag, defaulting to "%>"

  - *                 All others are template-local variables

## Includes

 Includes are relative to the template with the `include` statement,

 for example if you have "./views/users.ejs" and "./views/user/show.ejs"

 you would use `<% include user/show %>`. The included file(s) are literally

 included into the template, _no_ IO is performed after compilation, thus

 local variables are available to these included templates.

```



  <% users.forEach(function(user){ %>

    <% include user/show %>

  <% }) %>



```


## Custom delimiters

Custom delimiters can also be applied globally:

    var ejs = require('ejs');

    ejs.open = '{{';

    ejs.close = '}}';

Which would make the following a valid template:

    
{{= title }}


## Filters

EJS conditionally supports the concept of "filters". A "filter chain"

is a designer friendly api for manipulating data, without writing JavaScript.

Filters can be applied by supplying the _:_ modifier, so for example if we wish to take the array `[{ name: 'tj' }, { name: 'mape' },  { name: 'guillermo' }]` and output a list of names we can do this simply with filters:

Template:

    
<%=: users | map:'name' | join %>


Output:

    
Tj, Mape, Guillermo


Render call:

    ejs.render(str, {

        users: [

          { name: 'tj' },

          { name: 'mape' },

          { name: 'guillermo' }

        ]

    });

Or perhaps capitalize the first user's name for display:

    
<%=: users | first | capitalize %>


## Filter list

Currently these filters are available:

  - first

  - last

  - capitalize

  - downcase

  - upcase

  - sort

  - sort_by:'prop'

  - size

  - length

  - plus:n

  - minus:n

  - times:n

  - divided_by:n

  - join:'val'

  - truncate:n

  - truncate_words:n

  - replace:pattern,substitution

  - prepend:val

  - append:val

  - map:'prop'

  - reverse

  - get:'prop'

## Adding filters

 To add a filter simply add a method to the `.filters` object:

 

```js

ejs.filters.last = function(obj) {

  return obj[obj.length - 1];

};

```

## Layouts

  Currently EJS has no notion of blocks, only compile-time `include`s,

  however you may still utilize this feature to implement "layouts" by

  simply including a header and footer like so:

```html

<% include head %>

Title

My page

<% include foot %>

```


## client-side support

  include `./ejs.js` or `./ejs.min.js` and `require("ejs").compile(str)`.

## License 

(The MIT License)

Copyright (c) 2009-2010 TJ Holowaychuk <[email protected]>

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.