State management made simple for React. Built on React Hooks. Inspired by `atom`s in `reagent.cljs`.
npm install @dbeining/react-atom
src="https://document-export.canva.com/DADKGVfSlSY/19/preview/0001-541240887.png"
height="350"
width="350"
alt="react-atom logo" />










- Description
- Why use react-atom?
- Installation
- Documentation
- Code Example: react-atom in action
- š¹ļø Play with react-atom in CodeSandbox š®ļø
- Contributing / Feedback
react-atom provides a very simple way to manage state in React, for both global app state and for local component state: āØAtomsāØ.
``ts
import { Atom } from "@dbeining/react-atom";
const appState = Atom.of({
color: "blue",
userId: 1
});
`
You can't inspect Atom state directly, you have to dereference it, like this:
`js
import { deref } from "@dbeining/react-atom";
const { color } = deref(appState);
`
You can't modify an Atom directly. The main way to update state is with swap. Here's its call signature:
`ts`
function swap(atom: Atom, updateFn: (state: S) => S): void;
updateFn is applied to atom's state and the return value is set as atom's new state. There are just two simple rules for updateFn:
1. it must return a value of the same type/interface as the previous state
2. it must not mutate the previous state
To illustrate, here is how we might update appState's color:
`js
import { swap } from "@dbeining/react-atom";
const setColor = color =>
swap(appState, state => ({
...state,
color: color
}));
`
Take notice that our updateFn is spreading the old state onto a new object before overriding color. This is an easy way to obey the rules of updateFn.
You don't need to do anything special for managing side-effects. Just write your IO-related logic as per usual, and call swap when you've got what you need. For example:
`js/api/user/${userId}/theme
const saveColor = async color => {
const { userId } = deref(appState);
const theme = await post(, { color });`
swap(appState, state => ({ ...state, color: theme.color }));
};
useAtom is a [custom React Hook][customhooksurl]. It does two things:
1. returns the current state of an atom (like deref), and
2. subscribes your component to the atom so that it re-renders every time its state changes
It looks like this:
`js
export function ColorReporter(props) {
const { color, userId } = useAtom(appState);
return (
User {userId} has selected {color}
hook will trigger a re-render on swap /}> Nota Bene: You can also use a selector to subscribe to computed state by using the
options.select argument. Read the docs for details.Why use
react-atom?
š Tiny API / learning curve
Atom.of, useAtom, and swap will cover the vast majority of use cases.
š« No boilerplate, just predictable state management
Reducers? Actions? Thunks? Sagas? Nope, just
swap(atom, state => newState).
šµ Tuned for performant component rendering
The useAtom hook accepts an optional select function that lets components subscribe to computed state. That means the component will only re-render when the value returned from select changes.
š¬ React.useState doesn't play nice with React.memo
useState is cool until you realize that in most cases it forces you to pass new function instances through props on every render because you usually need to wrap the setState function in another function. That makes it hard to take advantage of React.memo. For example:
---
`jsx
function Awkwardddd(props) {
const [name, setName] = useState("");
const [bigState, setBigState] = useState({ ...useYourImagination }); const updateName = evt => setName(evt.target.value);
const handleDidComplete = val => setBigState({ ...bigState, inner: val });
return (
<>
>
);
}
`Every time
input fires onChange, ExpensiveButMemoized has to re-render because handleDidComplete is not strictly equal (===) to the last instance passed down.The React docs admit this is awkward and suggest using Context to work around it, because the alternative is super convoluted.
With
react-atom, this problem doesn't even exist. You can define your update functions outside the component so they are referentially stable across renders.`jsx
const state = Atom.of({ name, bigState: { ...useYourImagination } });const updateName = ({ target }) => swap(state, prev => ({ ...prev, name: target.value }));
const handleDidComplete = val =>
swap(state, prev => ({
...prev,
bigState: { ...prev.bigState, inner: val }
}));
function SoSmoooooth(props) {
const { name, bigState } = useAtom(state);
return (
<>
>
);
}
`
TS First-class TypeScript support
react-atom is written in TypeScript so that every release is published with correct, high quality typings.
src="https://img.shields.io/bundlephobia/minzip/@dbeining/react-atom.svg"
alt="react-atom minified+gzipped file size"/>
āļø Embraces React's future with Hooks
Hooks will make class components and their kind (higher-order components, render-prop components, and function-as-child components) obsolete. react-atom makes it easy to manage shared state with just function components and hooks.
Installation
`
npm i -S @dbeining/react-atom
`Dependencies
react-atom has one bundled dependency, @libre/atom, which provides the Atom data type. It is re-exported in its entirety from @dbeining/atom. You may want to reference the docs here.react-atom also has two peerDependencies, namely, react@^16.8.0 and react-dom@^16.8.0, which contain the Hooks API.Documentation
react-atom API@libre/atom APICode Example:
react-atom in action
Click for code sample
`jsx
import React from "react";
import ReactDOM from "react-dom";
import { Atom, useAtom, swap } from "@dbeining/react-atom";//------------------------ APP STATE ------------------------------//
const stateAtom = Atom.of({
count: 0,
text: "",
data: {
// ...just imagine
}
});
//------------------------ EFFECTS ------------------------------//
const increment = () =>
swap(stateAtom, state => ({
...state,
count: state.count + 1
}));
const decrement = () =>
swap(stateAtom, state => ({
...state,
count: state.count - 1
}));
const updateText = evt =>
swap(stateAtom, state => ({
...state,
text: evt.target.value
}));
const loadSomething = () =>
fetch("https://jsonplaceholder.typicode.com/todos/1")
.then(res => res.json())
.then(data => swap(stateAtom, state => ({ ...state, data })))
.catch(console.error);
//------------------------ COMPONENT ------------------------------//
export const App = () => {
const { count, data, text } = useAtom(stateAtom);
return (
Count: {count}
Text: {text}
{JSON.stringify(data, null, " ")}
);
};ReactDOM.render( , document.getElementById("root"));
`š¹ļø Play with
react-atom in CodeSandbox š®ļøYou can play with
react-atom` live right away with no setup at the following links:| JavaScript Sandbox | TypeScript Sandbox |
| ------------------------------- | ------------------------------- |
| [![try react-atom][imgurl]][js] | [![try react-atom][imgurl]][ts] |
Please open an issue if you have any questions, suggestions for
improvements/features, or want to submit a PR for a bug-fix (please include
tests if applicable).
[customhooksurl]: https://github.com/reactjs/reactjs.org/blob/98c1d22fbef2638cafb03b07e0eabe2a6186fca8/content/docs/hooks-custom.md
[hooksurl]: https://github.com/reactjs/reactjs.org/blob/98c1d22fbef2638cafb03b07e0eabe2a6186fca8/content/docs/hooks-intro.md
[imgurl]: https://codesandbox.io/static/img/play-codesandbox.svg
[js]: https://codesandbox.io/s/m3x9wn6kmy
[ts]: https://codesandbox.io/s/km72yynqov