https://github.com/koajs/ejs

a koa view render middleware, support all feature of ejs
https://github.com/koajs/ejs

Last synced: 4 days ago
JSON representation

a koa view render middleware, support all feature of ejs

• Host: GitHub
• URL: https://github.com/koajs/ejs
• Owner: koajs
• License: mit
• Created: 2014-02-24T09:17:33.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2023-03-02T16:33:44.000Z (almost 2 years ago)
• Last Synced: 2024-10-29T15:32:17.426Z (about 1 month ago)
• Language: JavaScript
• Homepage:
• Size: 82 KB
• Stars: 248
• Watchers: 8
• Forks: 56
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: HISTORY.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-koa - koa-ejs - Koa视图渲染中间件，支持ejs所有特性。   (仓库 / 中间件)
• awesome-koa - ejs - a koa view render middleware, support all feature of ejs (Middleware)

README

        
# @koa/ejs

> Koa ejs view render middleware. support all feature of [ejs](https://github.com/mde/ejs).

[![Build Status](https://secure.travis-ci.org/koajs/ejs.svg)](http://travis-ci.org/koajs/ejs)

[![NPM](https://nodei.co/npm/@koa/ejs.png?downloads=true)](https://nodei.co/npm/@koa/ejs/)

## Usage

### Example

```js

const Koa = require("koa");

const render = require("@koa/ejs");

const path = require("path");

const app = new Koa();

render(app, {

  root: path.join(__dirname, "view"),

  layout: "template",

  viewExt: "html",

  cache: false,

  debug: true,

});

app.use(async function (ctx) {

  await ctx.render("user");

});

app.listen(7001);

```

Or you can checkout the [example](https://github.com/koajs/ejs/tree/master/example).

### Settings

- root: view root directory.

- fs: file system module with same Node.js fs interface (default `Node.js fs module`).

- layout: global layout file, default is `layout`, set `false` to disable layout.

- viewExt: view file extension (default `html`).

- cache: cache compiled templates (default `true`).

- debug: debug flag (default `false`).

- delimiter: character to use with angle brackets for open / close (default `%`).

- async: When true, EJS will use an async function for rendering. Depends on async/await support in the JS runtime.

- outputFunctionName: Set to a string (e.g., 'echo' or 'print') for a function to print output inside scriptlet tags.

### Layouts

`@koa/ejs` supports layouts. The default layout file is `layout`. If you want to change default layout file, use `settings.layout`. Also you can specify layout by `options.layout` in `await ctx.render`.

Also you can set `layout = false` to disable the layout.

```

  

    koa ejs

  

  

    
koa ejs

    <%- body %>

  


```

### Include

Supports ejs includes.

```



  <%- include ('user.html') -%>



```


### State

Support [`ctx.state` in koa](https://github.com/koajs/koa/blob/master/docs/api/context.md#ctxstate).

### TypeScript

If you're project based on TypeScript, we recommend using [`@types/koa-ejs`](https://www.npmjs.com/package/@types/koa-ejs) until we start supporting it in the upcoming releases.

## Licences

[(The MIT License)](LICENSE)