Use redux in the main and browser process in electron

Downloads in past


001.0.14 years ago4 years agoMinified + gzip package size for @getstation/electron-redux in KB


- [Local actions (renderer process)](#local-actions-renderer-process)
- [Aliased actions (main process)](#aliased-actions-main-process)

Differences with trunk repo

  • This fork doesn't enforce FSA
  • Support for ImmutableJS but drop of support for POJSO
  • Change dispatch execution order: the process from where the action is dispatched reduces action immediately instead of waiting for the the main to dispatch action in other processes.


Using redux with electron poses a couple of problems. Processes (main and renderer) are completely isolated, and the only mode of communication is IPC.
  • Where do you keep the state?
  • How do you keep the state in sync across processes?

The solution

electron-redux offers an easy to use solution. The redux store on the main process becomes the single source of truth, and stores in the renderer processes become mere proxies. See under the hood.
electron-redux basic


npm install --save @getstation/electron-redux

@getstation/electron-redux comes as redux middleware that is really easy to apply:
// in the main store
import {
} from '@getstation/electron-redux';

const todoApp = combineReducers(reducers);

const store = createStore(
  initialState, // optional
    triggerAlias, // optional, see below
    forwardToRenderer, // IMPORTANT! This goes last


// in the renderer store
import {
} from '@getstation/electron-redux';

const todoApp = combineReducers(reducers);
const initialState = getInitialStateRenderer();

const store = createStore(
    forwardToMain, // IMPORTANT! This goes first


Check out timesheets for a more advanced example.
And that's it! You are now ready to fire actions without having to worry about synchronising your state between processes.

Local actions (renderer process)

By default, all actions are being broadcast from the main store to the renderer processes. However, some state should only live in the renderer (e.g. isPanelOpen). electron-redux introduces the concept of action scopes.
To stop an action from propagating from renderer to main store, simply set the scope to local:
function myLocalActionCreator() {
  return {
    type: 'MY_ACTION',
    payload: 123,
    meta: {
      scope: 'local',

Aliased actions (main process)

Most actions will originate from the renderer side, but not all should be executed there as well. A great example is fetching of data from an external source, e.g. using promise middleware, which should only ever be executed once (i.e. in the main process). This can be achieved using the triggerAlias middleware mentioned above.
Using the createAliasedAction helper, you can quite easily create actions that are are only being executed in the main process, and the result of which is being broadcast to the renderer processes.
import { createAliasedAction } from 'electron-redux';

export const importGithubProjects = createAliasedAction(
  'IMPORT_GITHUB_PROJECTS', // unique identifier
  (accessToken, repoFullName) => ({
    payload: importProjects(accessToken, repoFullName),

Check out timesheets for more examples.