electron-redux

Keeps your state in sync across all of your Electron processes by playing your actions across all of them.

Usage

// in the main process
import { syncMain } from "@mckayla/electron-redux";
const store = createStore(reducer, syncMain);

// in the renderer processes
import { syncRenderer } from "@mckayla/electron-redux";
const store = createStore(reducer, syncRenderer);

// in your preload script
import "@mckayla/electron-redux/preload";

If you don't have your own preload script, you can specify the provided preload script directly whenever you initialize a BrowserWindow

// when initializing a BrowserWindow
const view = new BrowserWindow({
	webPreferences: {
		preload: require.resolve("@mckayla/electron-redux/preload"),
	},
});

w/ Webpack

If you use Webpack to bundle your renderer code, and you don't have nodeIntegration enabled, you might also need to prevent the electron module from being included in your renderer bundle. You can do this by including the following in your Webpack config.

// in your webpack.config.js
module.exports = {
	resolve: {
		alias: {
			electron: false,
		},
	},
};

w/ Parcel (or Webpack)

In your renderer code, you'll actually want to import the store enhancer from a submodule.

// in your renderer processes
import { syncRenderer } from "@mckayla/electron-redux/renderer";
const store = createStore(reducer, syncRenderer);

Actions

Actions MUST be FSA-compliant, i.e. have a type and payload property. Any actions not passing this test will be ignored and simply passed through to the next middleware.

NB: redux-thunk is not FSA-compliant out of the box, but can still produce compatible actions once the async action fires.

Actions MUST be serializable

• Objects with enumerable properties
• Arrays
• Numbers
• Booleans
• Strings
• Maps
• Sets

Local actions

By default, all actions are played in all processes. If an action should only be played in the current thread, then you can set the scope meta property to local.

const myLocalActionCreator = () => ({
	type: "MY_ACTION",
	payload: 123,
	meta: {
		scope: "local", // only play the action locally
	},
});

We also provide a utility function for this

import { stopForwarding } from "@mckayla/electron-redux";
dispatch(stopForwarding(action));

Contributors

• Burkhard Reffeling
• Charlie Hess
• Roman Paradeev