Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/soarez/express-ejs-layouts
Layout support for ejs in express.
https://github.com/soarez/express-ejs-layouts
ejs express html javascript rendering
Last synced: 29 days ago
JSON representation
Layout support for ejs in express.
- Host: GitHub
- URL: https://github.com/soarez/express-ejs-layouts
- Owner: soarez
- License: mit
- Created: 2012-04-28T21:51:32.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2024-03-11T14:21:17.000Z (8 months ago)
- Last Synced: 2024-09-29T07:21:08.863Z (about 1 month ago)
- Topics: ejs, express, html, javascript, rendering
- Language: JavaScript
- Size: 151 KB
- Stars: 297
- Watchers: 15
- Forks: 66
- Open Issues: 9
-
Metadata Files:
- Readme: Readme.md
- License: LICENSE
Awesome Lists containing this project
README
# express-ejs-layouts
> Layout support for ejs in express
[](https://badge.fury.io/js/express-ejs-layouts)
[](http://travis-ci.org/Soarez/express-ejs-layouts)
## Installation
```sh
$ npm install express-ejs-layouts
```
## Example
Check the example folder.
1. `git clone https://github.com/soarez/express-ejs-layouts.git`
2. `cd express-ejs-layouts`
3. `npm install`
4. `node example`
5. Open http://localhost:3000/
## Usage
```javascript
var express = require('express');
var expressLayouts = require('express-ejs-layouts');
var app = express();
app.set('view engine', 'ejs');
app.use(expressLayouts);
app.get('/', function(req, res) {
var locals = {
title: 'Page Title',
description: 'Page Description',
header: 'Page Header'
};
res.render('the-view', locals);
});
app.listen(3000);
```
### `contentFor`
A view
```ejs
tyler
<%- contentFor('foo') %>
club
<%- contentFor('bar') %>
fight
```
With a layout
```ejs
<%-bar%> <%-foo%>
<%-body%>
```
Renders
```
fight club
tyler
```
As another example, consider this view:
```html
foo
<%- contentFor('pageSectionA') %>
bar
<%- contentFor('pageSectionB') %>
baz
```
Using it with this layout:
```html
<%- pageSectionA %>
<%- body %>
```
Will render:
```html
bar
foo
```
Notice that the difference between using `<%- pageSectionA %>` and `<%-defineContent('pageSectionA')%>` is that the former will generate an error if the view doesn't define content for this section.
This can be used not only to fill large layout parts, but also for simple stuff, like setting page title:
With this layout:
```ejs
<%- title %>
<%- body %>
```
You can set page title by:
```html
foo
<%- contentFor('title') %>
Foo Page
```
Or if you would rather set title at the beginning of the view:
```html
<%- contentFor('title') %>Foo Page<%- contentFor('body') %>
foo
```
### Script blocks extraction
If you like to place all the script blocks at the end, you can do it like this:
```javascript
app.set("layout extractScripts", true)
```
A view
```html
somethingsomejs<script>something
```
With a layout
```ejs
<body>
<%- body %>
<%- script %>
</body>
```
Renders
```html
<body>
somethingsomething
<script>somejs<script>
</body>
```
Enabling individually:
```javascript
req.render('view', { extractScripts: true })
```
When the `"layout extractScripts"` option is activated, scripts defined in views will be extracted (won't be a part of `body`) and will be available for use in the layout through the variable `scripts`.
Another example:
This view:
```html
<script src="/b.js" />
<div>foo</div>
<script src="/a.js" />
<div>bar</div>
<script src="/c.js" />
```
Used with this layout:
```html
<div class="main">
<%- body %>
</div>
<!-- place the scripts at the end of the html page -->
<%- script %>
```
Will render:
```html
<div class="main">
<div>foo</div>
<div>bar</div>
</div>
<!-- place the scripts at the end of the html page -->
<script src="/b.js" />
<script src="/a.js" />
<script src="/c.js" />
```
### Style blocks extraction
Works exactly like script blocks extraction except:
* Supported tags are `<link rel="stylesheet" …>` and `<style …>`
* The option is named `extractStyles`
* The template variable in layout is `style`
### Meta blocks extraction
Works exactly like script blocks extraction except:
* Supported tags are `<meta …>` and `<meta …/>`
* The option is named `extractMetas`
* The template variable in layout is `meta`
### Set custom default layout
By default 'layout.ejs' is used. If you want to specify your custom
layout (e.g. 'layouts/layout.ejs'), just set `layout` property in
express app settings.
```
app.set('layout', 'layouts/layout');
```
### Set custom layout for single render
Just pass `layout` as render locals object.
```
app.get('/', function(req, res) {
res.render('the-view', { layout: 'specific-layout' });
});
```
### Set no layout for single render
Just pass `layout: false` as render locals object.
```
app.get('/', function(req, res) {
res.render('the-view', { layout: false });
);
```
## Optional sections
In a layout, you can have optional sections using `defineContent`:
Unspecified section content defaults to `''`.
```ejs
1
<%-defineContent('a')%>
2
<%-defineContent('b')%>
3
```
with a view:
```ejs
<%- contentFor('a') %>
1.5
```
will render:
```ejs
1
1.5
2
3
```
## Running tests
Clone the repo and run:
```sh
$ npm test
```
## License
MIT