react-chain
v0.5.1
Published
A chain of pluggable logic for your React rendering pipline.
Downloads
38
Keywords
Readme
react-chain simplifies the process of bootstraping browser, and server rendered React applications with a shared middleware chain. It allows developers to share custom logic with both rendering targets, as well as targeting either one specifically. Additionally, some parts of the browser’s rendering process need only happen once, therefore react-chain middleware is designed around the concept of sessions. Each session wraps the rendering of the app. This allows us to run setup code ahead of, or after the inital, or continous, render process.
Note: react-chain is in active development and the API is subject to change drastically before it hits version
1.0.0.
Usage
Install as dependency, using the package manager of your choice:
npm install --save react-chainCreate a new file, app.js, and add the following code to it:
// app.js
import React from 'react'
import createReactChain from 'react-chain'
export default createReactChain()
.chain(session => () => <div>Hello ReactChain!</div>)createReactChain() will instantiate a new ReactChain instance that can be used to link middleware and perform render on. The example above creates a very simple middleware chain that ends with a middleware that renders a div, containing the string Hello ReactChain!. Note that the resulting React element returned from a render is wrapped with an instance of ReactChainProvider, which gives us access to custom logic which we see later.
Middleware
A react-chain comprises a chain of middleware, that have the following API (typescript type definitions):
type Middleware =
(session: Session) =>
(void | WrapElement)
type WrapElement =
(next: () => Promise<null | ReactElement<any>>) =>
ReactElement<any> | Promise<ReactElement<any>>The session object that is passed to the middleware has the following API:
interface Session {
on: OnRender
htmlProps: { [key: string]: string }
bodyProps: { [key: string]: string }
window: { [key: string]: any }
head: ReactElement<any>[]
footer: ReactElement<any>[]
css: string[]
js: string[]
}
type OnRender =
(target: 'browser' | 'server' , render: WrapRender)
=> void
type WrapRender =
(render: Function) =>
voidRender
Browser
react-chain exposes a handy method, called startClient, which accepts two arguments, a react-chain instance, and a dom node to render the app in. This method wraps ReactDOM.render and adds a refresh method to the session, allowing middleware to trigger a rerender of the application.
Example:
// index.js
import app from './app' // <-- the previously create react-chain application.
import { startClient } from 'react-chain'
startClient(app, document.querySelector('#app'))Server-side rendering
Server rendering requires a bit more configuration and thus we do not ship a rendering method in this version. This may, or may not change in the future.
Example:
// server.js
import React from 'react'
import ReactDOMServer from 'react-dom/server'
import express from 'express'
import Document from 'react-document'
import app from './app' // <-- the previously create react-chain application.
const server = express()
server.use('*', async (req, res, next) => {
const session = app.createSession()
session.req = req
session.res = res
try {
const body = await app.renderServer(session, ReactDOMServer.renderToString)
res.status(session.status || 200)
res.send('<!doctype html>' + ReactDOMServer.renderToStaticMarkup(
<Document {...session}>{body}</Document>
))
} catch (error) {
next(error)
}
})
server.listen(3000)