Repository files navigation

A Molecular State Engine for React.

Zedux is a multi-paradigm state management tool that features a powerful composable store model wrapped in a DI-driven atomic architecture.

npm install @zedux/react# npmyarn add @zedux/react# yarnpnpm add @zedux/react# pnpm

The React package (@zedux/react) contains everything you need to use Zedux in a React app - thecore store model, thecore atomic model, and the React-specific APIs.

@zedux/react has a peer dependency on React. It supports React version 18 and up.

We borrowed ideas from dozens of state management tools over the past 5 years, invented a few ourselves, and put it all together in one powerhouse of a state management library.

Most notably, Zedux borrows ideas from Redux, Recoil, and React Query. Zedux takes the unique approach of separating the state layer (stores) from the architecture layer (atoms). This allows for a powerful Dependency Injection model, conceptually similar to Angular's but simpler and more dynamic.

Sound complex? Zedux is actually very beginner-friendly. In fact, here's all you need to begin:

import{atom,useAtomState}from'@zedux/react'constgreetingAtom=atom('greeting','Hello, World!')functionGreeting(){const[greeting,setGreeting]=useAtomState(greetingAtom)return(<inputonChange={event=>setGreeting(event.target.value)}value={greeting}/>)}

We'll break down this example and so much more inthe docs.

To embark on the journey of mastering Zedux, jump intothe quick start.

If you prefer something more high-level,the introduction's a decent place to start. Or if you want to learn Everything Everywhere All at Once, theAPI docs orrepo source code and tests are real page-turners.

Happy coding!

Contributions an any level are absolutely welcome! Have a look at thecontribution guidelines.

Bugs can be reportedhere.

Questions, feature requests, ideas, and links to cool projects or examples are always welcome in thediscussions page.

TheMIT License.