Git Product home page Git Product logo

egg-view-nunjucks's Introduction

egg-view-nunjucks

NPM version build status Test coverage David deps Known Vulnerabilities npm download

nunjucks view plugin for egg.

Install

$ npm i egg-view-nunjucks --save

Usage

// {app_root}/config/plugin.js
exports.nunjucks = {
  enable: true,
  package: 'egg-view-nunjucks',
};

Set mapping in config

// {app_root}/config/config.default.js
exports.view = {
  defaultViewEngine: 'nunjucks',
  mapping: {
    '.nj': 'nunjucks',
  },
};

Render in controller

// {app_root}/app/controller/test.js
class TestController extends Controller {
  async list() {
    const ctx = this.ctx;
    // ctx.body = await ctx.renderString('{{ name }}', { name: 'local' });
    // not need to assign `ctx.render` to `ctx.body`
    // https://github.com/mozilla/nunjucks/blob/6f3e4a36a71cfd59ddc8c1fc5dcd77b8c24d83f3/nunjucks/src/environment.js#L318
    await ctx.render('test.nj', { name: 'view test' }, {
      path: '***'
    });
  }
}

Feature

Filter

  • escape filter is replaced by helper.escape which is provided by egg-security for better performance
  • Add your filters to app/extend/filter.js, then they will be injected automatically to nunjucks
// {app_root}/app/extend/filter.js
exports.hello = name => `hi, ${name}`;

// so you could use it at template
// {app_root}/app/controller/test.js
class TestController extends Controller {
  async list() {
    const ctx = this.ctx;
    ctx.body = await ctx.renderString('{{ name | hello }}', { name: 'egg' }, {
      path: '***'
    });
  };
}

Tag

you can extend custom tag like this:

// {app_root}/app.js
const markdown = require('nunjucks-markdown');
const marked = require('marked');

module.exports = app => {
  markdown.register(app.nunjucks, marked);
};

Security

see egg-security

  • auto inject _csrf attr to form field
  • auto inject nonce attr to script tag

Helper / Locals

  • you can use helper/ctx/request in template, such as helper.shtml('<div></div>')
  • nunjucks build-in filters is injected to helper, such as helper.upper('test')
  • helper.shtml/surl/sjs/escape is auto wrapped with safe

More

  • app.nunjucks - nunjucks environment
  • app.nunjucks.cleanCache(fullPath/tplName) to easy clean cache, can use with custom egg-watcher

Configuration

see config/config.default.js for more detail.

Questions & Suggestions

Please open an issue here.

License

MIT

egg-view-nunjucks's People

Contributors

atian25 avatar popomore avatar beliefgp avatar dead-horse avatar fengmk2 avatar kisnows avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.