egg-view-react-ssr
React server side render solution for egg
Install
$ npm i egg-view-react-ssr --save
Usage
// {app_root}/config/plugin.jsexportsreactssr = enable: true package: 'egg-view-react-ssr';
Version
3.x.x (Node>8)
- node version > 8
- config
reactssr.layout
defaultapp/view/layout.html
- support react stateless component render (not support promise function callback)
2.x.x (Node>6)
- node version > 6
- config
reactssr.layout
defaultapp/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.jsexportsreactssr = // 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
render
Server Render, Call when server render bundle error, will try client render**
// controller/home.jsmodule { return Controller async { // home.js: webpack builded ssr entry jsbundle file await ctx; } ;};
renderClient
, Use React render layout
Client Render, Call when client render, render layout
exports.reactssr.layout
by React
// controller/home.jsmodule { return Controller async { // home.js: webpack builded client render entry jsbundle file await ctx; } ;};
renderAsset
, Use render layout by viewEngine, default nunjucks
Asset Render, Call - when asset render, you can render layout
exports.reactssr.layout
by viewEngine, default useegg-view-nunjucks
- you must install the specified engine dependence, such as
egg-view-nunjucks
oregg-view-ejs
- The context provides an
asset
object that can getjs
,css
,state
information. layout template
use default viewEngine nunjucks
// controller/home.jsmodule { return Controller async { // home.js: webpack builded client render entry jsbundle file await ctx; } ;};
scope render viewEngine config
// controller/home.jsmodule { return Controller async { // home.js: webpack builded client render entry jsbundle file await ctx; } ;};
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.