gatsby-plugin-react-redux

    1.1.0 • Public • Published

    gatsby-plugin-react-redux

    A Gatsby plugin for react-redux with built-in server-side rendering support.

    Install

    npm install --save gatsby-plugin-react-redux react-redux redux

    How to use

    ./src/state/createStore.js // same path you provided in gatsby-config

    import { createStore } from 'redux';
     
    function reducer() {
      //...
    }
     
    // preloadedState will be passed in by the plugin
    export default preloadedState => {
      return createStore(reducer, preloadedState);
    };

    ./gatsby-config.js

    module.exports = {
      plugins: [
        {
          resolve: `gatsby-plugin-react-redux`,
          options: {
            // [required] - path to your createStore module
            pathToCreateStoreModule: './src/state/createStore',
            // [optional] - options passed to `serialize-javascript`
            // info: https://github.com/yahoo/serialize-javascript#options
            // will be merged with these defaults:
            serialize: {
              space: 0,
              // if `isJSON` is set to `false`, `eval` is used to deserialize redux state,
              // otherwise `JSON.parse` is used
              isJSON: true,
              unsafe: false,
              ignoreFunction: true,
            },
            // [optional] - if true will clean up after itself on the client, default:
            cleanupOnClient: true,
            // [optional] - name of key on `window` where serialized state will be stored, default:
            windowKey: '__PRELOADED_STATE__',
          },
        },
      ],
    };

    License

    MIT

    Install

    npm i gatsby-plugin-react-redux

    DownloadsWeekly Downloads

    1,880

    Version

    1.1.0

    License

    MIT

    Unpacked Size

    12.7 kB

    Total Files

    9

    Last publish

    Collaborators

    • le0nik