jotai README

The project's README from github.com/pmndrs/jotai. As one markdown file: README.md.


Jotai (light mode) Jotai (dark mode)


visit jotai.org or npm i jotai

Build Status Build Size Version Downloads Discord Shield Open Collective

Jotai scales from a simple useState replacement to an enterprise TypeScript application.

Examples: Demo 1 | Demo 2

First, create a primitive atom

An atom represents a piece of state. All you need is to specify an initial value, which can be primitive values like strings and numbers, objects, and arrays. You can create as many primitive atoms as you want.

import { atom } from 'jotai'

const countAtom = atom(0)
const countryAtom = atom('Japan')
const citiesAtom = atom(['Tokyo', 'Kyoto', 'Osaka'])
const mangaAtom = atom({ 'Dragon Ball': 1984, 'One Piece': 1997, Naruto: 1999 })

Use the atom in your components

It can be used like React.useState:

import { useAtom } from 'jotai'

function Counter() {
  const [count, setCount] = useAtom(countAtom)
  return (
    <h1>
      {count}
      <button onClick={() => setCount((c) => c + 1)}>one up</button>
      ...

Create derived atoms with computed values

A new read-only atom can be created from existing atoms by passing a read function as the first argument. get allows you to fetch the contextual value of any atom.

const doubledCountAtom = atom((get) => get(countAtom) * 2)

function DoubleCounter() {
  const [doubledCount] = useAtom(doubledCountAtom)
  return <h2>{doubledCount}</h2>
}

Creating an atom from multiple atoms

You can combine multiple atoms to create a derived atom.

const count1 = atom(1)
const count2 = atom(2)
const count3 = atom(3)

const sum = atom((get) => get(count1) + get(count2) + get(count3))

Or if you like fp patterns ...

const atoms = [count1, count2, count3, ...otherAtoms]
const sum = atom((get) => atoms.map(get).reduce((acc, count) => acc + count))

Derived async atoms needs suspense

You can make the read function an async function too.

const urlAtom = atom('https://json.host.com')
const fetchUrlAtom = atom(async (get) => {
  const response = await fetch(get(urlAtom))
  return await response.json()
})

function Status() {
  // Re-renders the component after urlAtom is changed and the async function above concludes
  const [json] = useAtom(fetchUrlAtom)
  ...

You can create a writable derived atom

Specify a write function at the second argument. get will return the current value of an atom. set will update the value of an atom.

const decrementCountAtom = atom(
  (get) => get(countAtom),
  (get, set, _arg) => set(countAtom, get(countAtom) - 1)
)

function Counter() {
  const [count, decrement] = useAtom(decrementCountAtom)
  return (
    <h1>
      {count}
      <button onClick={decrement}>Decrease</button>
      ...

Write only derived atoms

Just do not define a read function.

const multiplyCountAtom = atom(null, (get, set, by) =>
  set(countAtom, get(countAtom) * by),
)

function Controls() {
  const [, multiply] = useAtom(multiplyCountAtom)
  return <button onClick={() => multiply(3)}>triple</button>
}

Async actions

Just make the write function an async function and call set when you're ready.

const fetchCountAtom = atom(
  (get) => get(countAtom),
  async (_get, set, url) => {
    const response = await fetch(url)
    set(countAtom, (await response.json()).count)
  }
)

function Controls() {
  const [count, compute] = useAtom(fetchCountAtom)
  return (
    <button onClick={() => compute('http://count.host.com')}>compute</button>
    ...

Note about functional programming

Jotai's fluid interface is no accident — atoms are monads, just like promises! Monads are an established pattern for modular, pure, robust and understandable code which is optimized for change. Read more about Jotai and monads.

jotai (pmndrs/jotai)

Searching Database…

21.3K ·GitHub
Jotai
Что это такое?Jotai — это простая и гибкая библиотека для управления состоянием в React. Она масштабируется от простой замены useState до полноценного корпоративного приложения на TypeScript.
Это библиотека, которую я подключаю к своему React-приложению, или фреймворк?Библиотека, которую вы устанавливаете в React-проект. Основной API минималистичный — около 2kb, а сверху доступно множество утилит и расширений.
Как добавить её в проект?Выполните npm i jotai; документация и примеры находятся на jotai.org. Затем создайте атом и используйте его в компоненте так же, как React.useState.
Нужно ли что-то ещё, кроме React?Нет — это библиотека состояний для React без зависимостей во время выполнения, так что ничего дополнительно ставить не нужно.
Чем она отличается от Recoil?В отличие от Recoil, атомам в Jotai не нужны строковые ключи — вы просто объявляете атом и сразу используете его.
Почему в README атомы сравнивают с монадами?Автор говорит, что текучий интерфейс (fluid interface) — не случайность: атомы — это монады, как и промисы, — устоявшийся паттерн для модульного, чистого и надёжного кода, который легко менять.
What are similar projects?Recoil, zustand, hyperapp, nuqs, valtio, recompose, snabbdom, date-fns
Which topics is it in?state, management, functional-programming, hooks, state-management, lightweight, javascript-library, hacktoberfest, web-development, react, npm, frontend
Creator
pmndrs
Size
15.1 MB
Stars
21.3K
Updated
CommitOct 07Releasev3.0.1Sep 29
Age
6y
Commits · 90 Days