Back to Jotai

Documentation

docs/index.mdx

2.19.11.6 KB
Original Source

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, Waku, Remix, 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.

<TOC section="core" />

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.

<TOC section="utilities" />

Extensions

Jotai has many officially maintained extensions including atomWithQuery for React Query and atomWithMachine for XState, among many others.

<TOC section="extensions" />

Third-party

Beyond the official extensions, there are many third-party community packages as well.

<TOC section="third-party" />

Tools

Use SWC and Babel compiler plugins for React Fast Refresh support and debugging labels. This creates the best developer experience when using a React framework such as Next.js or Waku.

<TOC section="tools" />

Basics

Learn the basic concepts of the library, discover how it compares with others, and see usage examples.

<TOC section="basics" />

Guides

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

<TOC section="guides" />

Recipes

Recipes can help with more advanced patterns.

<TOC section="recipes" />