https://github.com/goosewobbler/zubridge
Streamlined state management for cross-platform apps
https://github.com/goosewobbler/zubridge
cross-platform electron state-management tauri zustand
Last synced: about 2 months ago
JSON representation
Streamlined state management for cross-platform apps
- Host: GitHub
- URL: https://github.com/goosewobbler/zubridge
- Owner: goosewobbler
- License: mit
- Created: 2025-02-11T14:25:42.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-04-07T16:02:27.000Z (about 2 months ago)
- Last Synced: 2025-04-07T16:28:59.606Z (about 2 months ago)
- Topics: cross-platform, electron, state-management, tauri, zustand
- Language: TypeScript
- Homepage:
- Size: 5.02 MB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
_streamlined state management for cross-platform apps_
`@zubridge/electron`:
\
`@zubridge/tauri`:
\
`@zubridge/tauri-v1`:
### Why
> tldr: I want to use Zustand in my cross-platform 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 cross-platform apps, accessing state across the main and renderer processes presents a challenge.
Zubridge solves this by enabling a single store workflow, abstracting away the IPC management and state synchronization between processes.
### Features
- Use Zustand everywhere in your cross-platform app
- Single store workflow across IPC boundary
- Supports Electron and Tauri
- Supports different Zustand usage patterns
- Handles thunks, inline actions or Redux-style action objects
### How It Works
Zubridge uses an additional Zustand store in the front-end (renderer) process, which is synchronized in one direction with your application store in the back-end (main) process.
Actions from the front-end are dispatched via IPC (Electron) or commands / events (Tauri) to the back-end store, which handles them and updates state accordingly. The front-end store then receives these state updates and synchronizes itself automatically.
### Getting Started
Zubridge is available for both Electron and Tauri apps. See the [Electron docs](./packages/electron/docs/getting-started.md) or [Tauri docs](./packages/tauri/docs/getting-started.md) to get started.
### Framework Support
Zubridge is available for multiple cross-platform application frameworks:
#### Electron
Install `@zubridge/electron` for Electron applications.
Uses Electron's built-in IPC system with minimal configuration required.
#### Tauri
Install `@zubridge/tauri` for Tauri v2 applications, or `@zubridge/tauri-v1` for Tauri v1.
Uses Tauri's event system and commands, respecting its security model where main process actions must be explicitly allowed.
### Inspiration / Prior Art
- [goosewobbler/zutron](https://github.com/goosewobbler/zutron) (Electron + Zustand)
- Zustand store in the main process, synced to Zustand in the renderer
- `@zubridge/electron` is a rebrand of Zutron
- [vitordino/reduxtron](https://github.com/vitordino/reduxtron) (Electron + Redux + Zustand)
- Redux store in the main process, optionally synced to Zustand in the renderer
- `@zubridge/electron` is based on Reduxtron
- [klarna/electron-redux](https://github.com/klarna/electron-redux) (Electron + Redux)
- Bi-directional sync between one Redux store in the main process, and another in the renderer
- No longer maintained. I [forked it](https://github.com/goosewobbler/electron-redux) to enable support for the security model improvements [in Electron 14](https://github.com/klarna/electron-redux/issues/317).