https://github.com/Omnistac/zedux

:zap: A Molecular State Engine for React
https://github.com/Omnistac/zedux

atom atomic dependency-injection extensible flexible graph molecular powerful react state state-management zero-configuration

Last synced: 8 days ago
JSON representation

:zap: A Molecular State Engine for React

• Host: GitHub
• URL: https://github.com/Omnistac/zedux
• Owner: Omnistac
• License: mit
• Created: 2021-02-17T19:38:00.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-10-13T20:20:45.000Z (about 1 month ago)
• Last Synced: 2024-10-30T00:32:48.438Z (18 days ago)
• Topics: atom, atomic, dependency-injection, extensible, flexible, graph, molecular, powerful, react, state, state-management, zero-configuration
• Language: TypeScript
• Homepage: https://Omnistac.github.io/zedux/
• Size: 36.3 MB
• Stars: 362
• Watchers: 13
• Forks: 7
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Zedux

[![Build Status](https://github.com/Omnistac/zedux/actions/workflows/coverage.yml/badge.svg)](https://github.com/Omnistac/zedux/actions/workflows/coverage.yml)

[![codecov.io](https://codecov.io/gh/Omnistac/zedux/coverage.svg)](https://app.codecov.io/gh/Omnistac/zedux)

[![npm](https://img.shields.io/npm/v/@zedux/react.svg)](https://www.npmjs.com/package/@zedux/react)

[![license](https://shields.io/badge/license-MIT-informational)](https://github.com/Omnistac/zedux/tree/master/LICENSE.md)

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.

## Installation

```bash

npm install @zedux/react # npm

yarn add @zedux/react # yarn

pnpm add @zedux/react # pnpm

```

The React package (`@zedux/react`) contains everything you need to use Zedux in a React app - the [core store model](https://www.npmjs.com/package/@zedux/core), the [core atomic model](https://www.npmjs.com/package/@zedux/atoms), and the React-specific APIs.

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

## Intro

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:

```tsx

import { atom, useAtomState } from '@zedux/react'

const greetingAtom = atom('greeting', 'Hello, World!')

function Greeting() {

  const [greeting, setGreeting] = useAtomState(greetingAtom)

  return (

     setGreeting(event.target.value)}

      value={greeting}

    />

  )

}

```

We'll break down this example and so much more in [the docs](https://omnistac.github.io/zedux/docs/walkthrough/quick-start).

## Learn Zedux

To embark on the journey of mastering Zedux, jump into [the quick start](https://Omnistac.github.io/zedux/docs/walkthrough/quick-start).

If you prefer something more high-level, [the introduction's](https://omnistac.github.io/zedux/docs/about/introduction) a decent place to start. Or if you want to learn Everything Everywhere All at Once, the [API docs](https://omnistac.github.io/zedux/docs/api/api-overview) or [repo source code and tests](https://github.com/Omnistac/zedux/tree/master/packages) are real page-turners.

Happy coding!

## Contributing

Contributions an any level are absolutely welcome! Have a look at the [contribution guidelines](https://github.com/Omnistac/zedux/blob/master/CONTRIBUTING.md).

Bugs can be reported [here](https://github.com/Omnistac/zedux/issues).

Questions, feature requests, ideas, and links to cool projects or examples are always welcome in the [discussions page](https://github.com/Omnistac/zedux/discussions).

## License

The [MIT License](https://github.com/Omnistac/zedux/blob/master/LICENSE.md).