⚛️ react-atomic-state

Dead simple React global state management based on use-sync-external-store.


Installation

``bash
$ npm install --save react-atomic-state


--- or ---


$ yarn add react-atomic-state
`

❓Motivation

I'm a huge fan of the _"state and props"_ couple, but sometimes I need to share a simple value to my entire application.

As I'm not a fan of the Context API and found existing global state management libraries overkill to me most of the times, I decided to publish this small library to cover this specific need 🙌.

Usage

`tsx
// states/count.ts
import { atom, useAtom, useAtomWithSelector } from "react-atomic-state";

const count = atom(0);

export const decrement = () => count.set((prevCount) => prevCount - 1);
export const increment = () => count.set((prevCount) => prevCount + 1);

const unsubscribe = count.subscribe((value) => {
console.log(value); // log every update
});

// create a custom hook
export const useCount = () => useAtom(count);

// create a custom hook with selector
// (not to create a complex object store - it's often better to create multiple atoms, but to derive data)
export const useStringCount = () =>
useAtomWithSelector(count, (count) => count.toString());
`

`tsx
import { decrement, increment, useCount } from "./states/count.ts";

const Counter = () => {
const count = useCount();

return (



);
};
`

API

$3

`ts
type atom = (initialValue: Value) => {
get: () => Value;
set: (value: Value | ((prevValue: Value) => Value)) => void;
subscribe: (callback: (value: Value) => void) => () => void;
reset: () => void;
};
`

$3

`ts
type useAtom = (
atom: Atom,
isEqual?: (prevValue: Value, nextValue: Value) => boolean,
) => Value;
`

$3

`ts
type useAtomWithSelector = (
atom: Atom,
selector: (value: Value) => Selection,
isEqual?: (prevSelection: Selection, nextSelection: Selection) => boolean,
) => Value;
``