JotaiJotai

状態
Primitive and flexible state management for React

Introduction

Welcome to the Jotai v2 documentation! Jotai's atomic approach to global React state management scales from a simple useState replacement to an enterprise application with complex requirements.

Features

  • Minimal core API (2kb)
  • Many utilities and extensions
  • TypeScript oriented
  • Works with Next.js, Gatsby, Remix, Waku, and React Native

Core

Jotai has a very minimal API, exposing only a few exports from the main jotai bundle. They are split into four categories below.

atom
useAtom
Store
Provider

Utilities

Jotai also includes a jotai/utils bundle with a variety of extra utility functions. One example is atomWithStorage, which includes localStorage persistence and cross browser tab synchronization.

Storage
SSR
Async
Resettable
Family

Extensions

Jotai has separate bundles for many official extensions including atomWithQuery for React Query and atomWithMachine for XState, among many others.

tRPC
Query
Effect
URQL
Immer
XState
Location
Cache
Scope
Optics

Tools

There are also SWC and Babel compiler plugins for React Fast Refresh support and debugging labels. This creates the best developer experience when using Jotai with a React framework such as Next.js or Gatsby.

SWC
Babel
Devtools

Basics

Learn the basic concepts and primitives of the library, discover how it compares with other solutions, and see examples of it in use.

Concepts
Comparison
Showcase

Guides

These guides can help with use common cases such as TypeScript, React frameworks, and basic patterns.

v2 API migration
TypeScript
Next.js
Gatsby
Remix
React Native
Debugging
Performance
Testing
Core internals
Composing atoms
Atoms in atom
Initializing state on render
Persistence

Recipes

These recipes can help with more advanced patterns.

Large objects
Custom useAtom hooks
useAtomEffect
atomWithToggle
atomWithCompare
atomWithToggleAndStorage
atomWithRefresh
atomWithRefreshAndDefault
atomWithListeners
atomWithBroadcast
atomWithDebounce