Skip to content

Latest commit

 

History

History
 
 

react-serialize

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 

@shopify/react-serialize

Note: This module is now deprecated. You should move to using the serialization features of @shopify/react-html instead.


Build Status License: MIT npm version npm bundle size (minified + gzip)

Provides an idiomatic way to serialize data for rehydration in a universal react application.

Installation

$ yarn add @shopify/react-serialize

Usage

On the server, the <Serializer /> component will serialize whatever you pass as it's data prop.

// in your server renderer
import {Serializer} from '@shopify/react-serialize';

...

const apolloState = getDatafromTree(appMarkup)

const markup = react.renderToString(
  <React.Fragment>
    {appMarkup}
    <Serializer id="apollo-data" data={apolloState}>
  </React.Fragment>
);

Then on the client, you can use getSerialized to fetch that data out of the DOM and initialize whatever you need.

// when you are rehydrating on the client
import {getSerialized} from '@shopify/react-serialize';
import ApolloClient from 'apollo-client';

...

const {data: initialApolloData} = getSerialized('apollo-data');
const client = new ApolloClient({
  ...myConfig,
  cache: cache.restore(initialApolloData),
});