egg-view-react-ssr

[![NPM version][npm-image]][npm-url]
[![build status][travis-image]][travis-url]
[![Test coverage][codecov-image]][codecov-url]
[![David deps][david-image]][david-url]
[![Known Vulnerabilities][snyk-image]][snyk-url]
[![npm download][download-image]][download-url]

[npm-image]: https://img.shields.io/npm/v/egg-view-react-ssr.svg?style=flat-square
[npm-url]: https://npmjs.org/package/egg-view-react-ssr
[travis-image]: https://img.shields.io/travis/easy-team/egg-view-react-ssr.svg?style=flat-square
[travis-url]: https://travis-ci.org/easy-team/egg-view-react-ssr
[codecov-image]: https://img.shields.io/codecov/c/github/easy-team/egg-view-react-ssr.svg?style=flat-square
[codecov-url]: https://codecov.io/github/easy-team/egg-view-react-ssr?branch=master
[david-image]: https://img.shields.io/david/easy-team/egg-view-react-ssr.svg?style=flat-square
[david-url]: https://david-dm.org/easy-team/egg-view-react-ssr
[snyk-image]: https://snyk.io/test/npm/egg-view-react-ssr/badge.svg?style=flat-square
[snyk-url]: https://snyk.io/test/npm/egg-view-react-ssr
[download-image]: https://img.shields.io/npm/dm/egg-view-react-ssr.svg?style=flat-square
[download-url]: https://npmjs.org/package/egg-view-react-ssr

React server side render solution for egg

Install

``bash
$ npm i egg-view-react-ssr --save
`

Usage

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

Version

#### 3.x.x (Node>8)

- node version > 8
- config reactssr.layout default app/view/layout.html
- support react stateless component render (not support promise function callback)

#### 2.x.x (Node>6)

- node version > 6
- config reactssr.layout default app/view/layout.js
- support promise function callback(not support react stateless component render)

#### 1.x.x

egg-view-react-ssr depends on egg-view-react plugin

Configuration

`js
// {app_root}/config/config.default.js
exports.reactssr = {
// doctype: '',
// layout: path.join(app.baseDir, 'app/view/layout.html'),
// manifest: path.join(app.baseDir, 'config/manifest.json'),
// injectHeadRegex: /(<\/head>)/i,
// injectBodyRegex: /(<\/body>)/i,
// injectCss: true,
// injectJs: true,
// crossorigin: false,
// injectRes: [],
// mergeLocals: true,
// fallbackToClient: true, // fallback to client rendering if server render failed
// afterRender: (html, context) => { / eslint no-unused-vars:off /
// return html;
// },
};
`

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

Render

$3

> when server render bundle error, will try client render**

> https://www.yuque.com/easy-team/egg-react/node

`js
// controller/home.js
module.exports = app => {
return class IndecController extends app.Controller {
async index(ctx) {
// home.js: webpack builded ssr entry jsbundle file
await ctx.render('home.js', { message: 'egg react server side render'});
}
};
};
`

$3

> https://www.yuque.com/easy-team/egg-react/web

> when client render, render layout exports.reactssr.layout by React

`js
// controller/home.js
module.exports = app => {
return class IndecController extends app.Controller {
async index(ctx) {
// home.js: webpack builded client render entry jsbundle file
await ctx.renderClient('home.js', { message: 'egg react client side render'});
}
};
};
`

$3

> https://www.yuque.com/easy-team/egg-react/asset

- when asset render, you can render layout exports.reactssr.layout by viewEngine, default use egg-view-nunjucks
- you must install the specified engine dependence, such as egg-view-nunjucks or egg-view-ejs
- The context provides an asset object that can get js, css, state information. layout template

#### use default viewEngine nunjucks

`js
// controller/home.js
module.exports = app => {
return class IndecController extends app.Controller {
async index(ctx) {
// home.js: webpack builded client render entry jsbundle file
await ctx.renderAsset('home.js', { message: 'egg react client asset render'});
}
};
};
`

#### scope render viewEngine config

`js
// controller/home.js
module.exports = app => {
return class IndecController extends app.Controller {
async index(ctx) {
// home.js: webpack builded client render entry jsbundle file
await ctx.renderAsset('home.js', { message: 'egg react client asset render'}, { viewEngine: 'ejs' });
}
};
};
``

Example

- React Server Side Render egg-react-webpack-boilerplate

- React TypeScript Server Side Render egg-react-typescript-boilerplate

- React SSR Framework Example for Egg res-awesome

Questions & Suggestions

Please open an issue here.

License

MIT