# egg-view-react-ssr

> react server side render for egg

Latest version **3.1.0** (published 2020-08-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install egg-view-react-ssr
pnpm add egg-view-react-ssr
yarn add egg-view-react-ssr
bun add egg-view-react-ssr
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.1.0 |
| Published | 2020-08-15 |
| First published | 2017-08-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8.0.0 |
| Dependencies | 2 |
| Unpacked size | 22.1 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 62 |
| Author | hubcarl@126.com |
| Maintainers | hubcarl |
| Keywords | egg, eggPlugin, egg-plugin, react, react server side render |

## Links

- npm: https://www.npmjs.com/package/egg-view-react-ssr
- Repository: https://github.com/easy-team/egg-view-react-ssr
- Homepage: https://github.com/easy-team/egg-view-react-ssr#readme
- Issues: https://github.com/easy-team
- npm.io page: https://npm.io/package/egg-view-react-ssr

## Dependencies (2)

- [serialize-javascript](https://npm.io/package/serialize-javascript.md) ^4.0.0
- [server-side-render-resource](https://npm.io/package/server-side-render-resource.md) ^1.1.0

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 3.1.0 (latest) — 2020-08-15
- 3.0.0-beta.2 (beta) — 2020-01-20
- 2.5.3 (next) — 2019-11-06
- 3.0.0 — 2020-01-26
- 3.0.0-beta.1 — 2020-01-17
- 2.5.4 — 2020-01-16
- 2.5.2 — 2019-11-06
- 2.5.1 — 2019-11-05
- 2.5.0 — 2019-06-27
- 2.4.1 — 2018-12-18
- 2.4.0 — 2018-12-14
- 2.3.4 — 2018-12-03
- 2.3.3 — 2018-11-13
- 2.3.2 — 2018-11-08
- 2.3.1 — 2018-07-20
- … 22 more at https://npm.io/package/egg-view-react-ssr/versions

## README

# 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: '<!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](config/config.default.js) for more detail.


## Render

### Server Render, Call `render`

> 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'});
    }
  };
};
```

### Client Render, Call `renderClient`, Use React render layout

> 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'});
    }
  };
};
```

### Asset Render, Call `renderAsset`, Use render layout by viewEngine, default `nunjucks`

> 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](https://www.yuque.com/easy-team/egg-react/asset)

#### 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](https://github.com/easy-team/egg-react-webpack-boilerplate)

- React TypeScript Server Side Render [egg-react-typescript-boilerplate](https://github.com/easy-team/egg-react-typescript-boilerplate)

- React SSR Framework Example for Egg [res-awesome](https://github.com/easy-team/res-awesome)

## Questions & Suggestions

Please open an issue [here](https://github.com/easy-team/egg-react-webpack-boilerplate/issues).

## License

[MIT](LICENSE)

---
_Source: https://npm.io/package/egg-view-react-ssr · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._