https://github.com/goosewobbler/zutron

Streamlined Electron State Management
https://github.com/goosewobbler/zutron

electron electronjs state-management zustand

Last synced: 13 days ago
JSON representation

Streamlined Electron State Management

• Host: GitHub
• URL: https://github.com/goosewobbler/zutron
• Owner: goosewobbler
• Created: 2024-03-24T12:39:54.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2025-01-13T14:20:21.000Z (24 days ago)
• Last Synced: 2025-01-17T06:06:18.762Z (20 days ago)
• Topics: electron, electronjs, state-management, zustand
• Language: TypeScript
• Homepage:
• Size: 2.73 MB
• Stars: 31
• Watchers: 0
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        

  

  

  

_streamlined electron state management_



  



  

### Why

> tldr: I want to use Zustand in my Electron app, seamlessly

[Zustand](https://github.com/pmndrs/zustand) is a great state management library. As with other state libraries [such as Redux](https://redux.js.org/tutorials/fundamentals/part-4-store#redux-store), it is [recommended](https://zustand.docs.pmnd.rs/guides/flux-inspired-practice#recommended-patterns) that a single store is used in your app.

For Electron apps this is an awkward problem as you need access to the store in both the main and renderer processes.

Zutron enables a single store workflow with Zustand in Electron apps, effectively simplifying the use of Zustand in this context by abstracting away the necessary IPC and dispatch management.

### Features

- Use Zustand everywhere in your Electron app

- Single store workflow across the IPC boundary

- Works with the latest [Electron security recommendations](https://www.electronjs.org/docs/latest/tutorial/security#checklist-security-recommendations)

- Supports `BrowserWindow`, `BrowserView` and `WebContentsView`

- Integrates with windows and views created at runtime

- Compatible with the main Zustand usage patterns

- Handles thunks, inline actions or Redux-style action objects

### How It Works

Behind the scenes, Zutron creates an additional Zustand store in each renderer process.  These stores are synchronized in one direction with your application store in the main process.

  

  

  

Actions from the renderer process(es) are dispatched across IPC to the main process store, which handles them and updates the application state accordingly. Internally, the Zutron renderer process store(s) receive these state updates over IPC and update themselves accordingly.

#### Accessing Your Application Store

- Renderer process

  - Application state can be accessed via the Zutron `useStore` hook

  - Actions & thunks can be dispatched via the Zutron `useDispatch` hook

- Main process

  - Application state can be accessed directly in the [same way you normally use a vanilla Zustand store](https://github.com/pmndrs/zustand/blob/5d92ad2767e6a13d94331b5b62a44c069df2dfc6/readme.md#using-zustand-without-react):

    - Either using the Zustand vanilla API utilities: `getState`, `setState`, `subscribe`, `getInitialState`

    - Or via the Zustand `useStore` hook

  - Actions & thunks can be dispatched via the Zutron `dispatch` helper

### Getting Started

See the [docs](./docs/getting-started.md).

There are minimal example applications featuring three different Zustand usage patterns:

- [Redux-style reducers](./apps/example-reducers)

- [Separate handlers](./apps/example-separate-handlers)

- [Store-based handlers](./apps/example-store-handlers)

### Inspiration / Prior Art

This project would not exist without Reduxtron, shout out to vitordino for creating it!

- [vitordino/reduxtron](https://github.com/vitordino/reduxtron)

  - Redux store in the main process, optionally synced to Zustand in the renderer

  - Zutron is based on Reduxtron

  - Great for Redux users, not an option if you want to use Zustand everywhere

- [klarna/electron-redux](https://github.com/klarna/electron-redux)

  - Bi-directional sync between one Redux store in the main process, and another in the renderer

  - No longer maintained

  - I created [a fork](https://github.com/goosewobbler/electron-redux) to enable support for [electron >= 14](https://github.com/klarna/electron-redux/issues/317), however I won't be spending any more time on this approach