https://github.com/le0nik/gatsby-plugin-react-redux

Gatsby plugin for React-Redux with built-in server-side rendering support
https://github.com/le0nik/gatsby-plugin-react-redux

gatsby gatsby-plugin gatsbyjs react react-redux reactjs redux

Last synced: 19 days ago
JSON representation

Gatsby plugin for React-Redux with built-in server-side rendering support

• Host: GitHub
• URL: https://github.com/le0nik/gatsby-plugin-react-redux
• Owner: le0nik
• License: mit
• Created: 2019-05-06T01:15:33.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2020-09-19T21:10:21.000Z (about 4 years ago)
• Last Synced: 2024-10-09T12:43:02.608Z (30 days ago)
• Topics: gatsby, gatsby-plugin, gatsbyjs, react, react-redux, reactjs, redux
• Language: JavaScript
• Size: 313 KB
• Stars: 15
• Watchers: 1
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# gatsby-plugin-react-redux

> A [Gatsby](https://github.com/gatsbyjs/gatsby) plugin for

> [react-redux](https://github.com/reduxjs/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

```javascript

import { createStore } from 'redux';

function reducer() {

  //...

}

// preloadedState will be passed in by the plugin

export default preloadedState => {

  return createStore(reducer, preloadedState);

};

```

`./gatsby-config.js`

```javascript

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