React Component Caching is a component-level caching library for faster server-side rendering with React 16.

• Use any of React's four server-side rendering methods
• Cache components using a simple or template strategy
• Choose from three cache implementations (LRU, Redis, or Memcached)

Using npm:

$ npm install react-component-caching

Instantiate a cache and pass it to any rendering method (renderToString, renderToStaticMarkup, renderToNodeStream, or renderToStaticNodeStream) as a second argument. Wherever you would use ReactDOM.renderToString, use ReactCC.renderToString.

const ReactCC = require("react-component-caching"); const cache = ReactCC.ComponentCache(); ReactCC.renderToString(<App />, cache>) // ...

To flag a component for caching, simply add a cache property to it.

export default class App extends Component { render() { return ( <div> <ComponentNotToBeCached /> <ComponentToCache cache /> </div> ); } } // ...

The example above employs a simple caching strategy: a rendered component is saved with its prop values. Each time the component is rendered with different prop values, a separate copy is saved to the cache. If a component is frequently rendered with different prop values, you may prefer to cache a template of the component to save space in the cache. The template strategy stores a version of the component with placeholders (e.g. {{0}}, {{1}}) in place of actual prop values.

To create a cache template, add both cache and templatized to the component along with an array of props to templatize. Templatized props should have string or number values. Be aware that templates are not currently supported with the renderToNodeStream or renderToStaticNodeStream methods.

export default class App extends Component { render() { return ( <div> <ComponentNotToBeCached /> <ComponentToCache cache /> <ComponentToTemplatize templatizedProp1="value" templatizedProp2="value2" nonTemplatizedProp="anotherValue" cache templatized={["templatizedProp1", "templatizedProp2"]} /> </div> ); } } // ...

React Component Caching provides its own cache implementation as well as support for Redis and Memcached. Simply create your preferred cache and pass it into one of the rendering methods.

Standard (LRU) Cache Example:

const ReactCC = require("react-component-caching"); const cache = ReactCC.ComponentCache(); ReactCC.renderToString(<App />, cache);

Redis Example:

const ReactCC = require("react-component-caching"); const redis = require("redis"); const cache = redis.createClient(); ReactCC.renderToString(<App />, cache);

Memcached Example:

const ReactCC = require("react-component-caching"); const Memcached = require("memcached"); const cache = new Memcached(server location, options); // Make sure to pass in the lifetime of the data (in seconds) as a number. ReactCC.renderToString(<App />, cache, 1000);

React Component Caching gives you access to all four of React 16's server-side rendering methods, as well as additional functionality. Available methods are described below.

• size: (Optional) An integer representing the maximum size (in characters) of the cache. Defaults to 1 million.

Example:

const cache = new ReactCC.ComponentCache();

• component: The React component being rendered
• cache: The component cache
• memLife: (Only if using Memcached) A number representing the lifetime (in seconds) of each Memcached entry. Defaults to 0.

Example:

ReactCC.renderToString(<App />, cache);

• component: The React component being rendered
• cache: The component cache
• memLife: (Only if using Memcached) An integer representing the lifetime (in seconds) of each Memcached entry. Defaults to 0.

Example:

ReactCC.renderToStaticMarkup(<App />, cache);

• component: The React component being rendered
• cache: The component cache
• memLife: (Only if using Memcached) An integer representing the lifetime (in seconds) of each Memcached entry. Defaults to 0.

Example:

ReactCC.renderToNodeStream(<App />, cache);

• component: The React component being rendered
• cache: The component cache
• memLife: (Only if using Memcached) An integer representing the lifetime (in seconds) of each Memcached entry. Defaults to 0.

Example:

ReactCC.renderToStaticNodeStream(<App />, cache);