Preload actions on both server & client side (allows deep nesting of components)
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src
utils/__mocks__
.babelrc
.eslintrc
.gitignore
.npmignore
LICENSE
README.md
circle.yml
index.d.ts
package.json
publish
yarn.lock

README.md

Preload CircleCI Dependency Status

Description

Module is using to dispatch some actions (usually async data fetching) immediately after the rendering occurs. Works both on client and server sides.

Usage on client

import preload from 'redux-preload';

@preload([
  // You can just pass a single action creator, or array of them
  ({ someProp }) => ({ type: 'FETCH', payload: someProp })
])
class Container extends Component {
  render() {
    return <div />;
  }
}

Usage on server

On server to get all goodness of isomorphic-deeply-nested-component-data-prefetch you need to call serverPreload(routerContext) with router context.

And also send preloaded data back to client using window.__INITIAL_STATE__ = ${serialize(store.getState())};

serverPreload is a promise - when promise resolves data is already fetched (store is polluted with data) and now you can render your DOM

Here is pseudo code that demonstrate that on server in render.js

import { serverPreload } from 'redux-preload';

const getRouterContext = function(store, renderProps) {
  return (
    <Provider store={store}>
      <RouterContext {...renderProps} />
    </Provider>
  );
}

const renderHtml = (store, renderProps) => {
  return '<!DOCTYPE html>' + ReactDOMServer.renderToStaticMarkup(
    <html lang="en">
      <body>
        <div dangerouslySetInnerHTML={{__html: ReactDOMServer.renderToString(
          getRouterContext(store, renderProps)
        )}} id="app"></div>
        <script dangerouslySetInnerHTML={{__html:`
            window.__INITIAL_STATE__ = ${serialize(store.getState())};
        `}}></script>
      </body>
    </html>
  );
};

export default function render(req, res, next) {
  const store = createStore(...);
  ...
  match({routes, location}, async (error, redirectLocation, renderProps) => {
    ...
    try {
      await serverPreload(getRouterContext(store, renderProps));

      const html = renderHtml(store, renderProps, req);
      res.status(200).send(html);
    } catch (exception) {
      next(exception);
    }
  });
}

Restore state sent from server

On client you need to revive state with data sent from server.

You can do it in main.js

const store = createStore({
  initialState: window.__INITIAL_STATE__
});

ReactDOM.render(
  <Provider store={store}>
    <Router history={history}>
      {createRoutes(store.getState)}
    </Router>
  </Provider>,
  document.getElementById('app')
);

Development

yarn install
yarn eslint
yarn eslint:fix
yarn test

CI and autopublish

On Circle CI you need to add NPM_TOKEN which has rights to publish package to npmjs.org.

Also when you provide SLACK_TOKENS redux-preload/YYY/ZZZZ (take them as one string from url https://hooks.slack.com/services/redux-preload/YYY/ZZZ) it will let you know about new version.

When code gets to master branch, it will try to publish, so if version in package.json is different, it will push it automatically.

Made with love by