egg-view-react-ssr
React server side render solution for egg
Install
$ npm i egg-view-react-ssr --saveUsage
// {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.layoutdefaultapp/view/layout.html - support react stateless component render (not support promise function callback)
2.x.x (Node>6)
- node version > 6
- config
reactssr.layoutdefaultapp/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
// {app_root}/config/config.default.js
exports.reactssr = {
// doctype: '<!doctype html>',
// 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
Server Render, Call render
when server render bundle error, will try client render**
// 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'});
}
};
};
Client Render, Call renderClient, Use React render layout
when client render, render layout
exports.reactssr.layoutby React
// 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'});
}
};
};
Asset Render, Call renderAsset, Use render layout by viewEngine, default nunjucks
- when asset render, you can render layout
exports.reactssr.layoutby viewEngine, default useegg-view-nunjucks - you must install the specified engine dependence, such as
egg-view-nunjucksoregg-view-ejs - The context provides an
assetobject that can getjs,css,stateinformation. layout template
use default viewEngine nunjucks
// 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
// 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.
![dependabot[bot]](https://avatars.githubusercontent.com/u/49699333?size=120)