Recoil README

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

Recoil · NPM Version Node.js CI GitHub license Follow on Twitter

Recoil is an experimental state management framework for React.

Website: https://recoiljs.org

Documentation

Documentation: https://recoiljs.org/docs/introduction/core-concepts

API Reference: https://recoiljs.org/docs/api-reference/core/RecoilRoot

Tutorials: https://recoiljs.org/resources

Installation

The Recoil package lives in npm. Please see the installation guide

To install the latest stable version, run the following command:

npm install recoil

Or if you're using yarn:

yarn add recoil

Or if you're using bower:

bower install --save recoil

Contributing

Development of Recoil happens in the open on GitHub, and we are grateful to the community for contributing bugfixes and improvements. Read below to learn how you can take part in improving Recoil.

License

Recoil is MIT licensed.

Recoil (facebookexperimental/Recoil)

jest
Searching Database…

19.4K ·GitHub
archived
What is this?Recoil is an experimental state management library for React apps, built to add capabilities that are hard to get with plain React (like shared derived state and fine-grained updates), while staying compatible with React's newest features.
Is this a framework I adopt, or a library I just add to React?It's a library, not a replacement framework: you keep writing normal React components and install the Recoil npm package to manage state alongside React.
How do I add it to my project?Install the 'recoil' package with npm, or use yarn or bower if you prefer those package managers.
Do I need anything besides React itself?No extra runtime setup beyond React - Recoil is designed to plug into an existing React app and stay compatible with React's newest features.
Is this project still maintained?No - the repository is archived, so it's no longer under active development or receiving new features; treat it as a frozen project rather than one with ongoing support.
Why does the README call it 'experimental'?The project itself is labeled experimental, signaling its APIs and patterns were still being explored rather than guaranteed stable for long-term production use - which lines up with it later being archived.
What internal pieces does Recoil rely on?Under the hood it uses libraries like 'hamt_plus' (a persistent hash map) and 'transit-js' for its data structures, rather than depending on any other external state framework.
Does it support TypeScript?Yes - the repo ships a 'test:typescript' script that runs dtslint against TypeScript type definitions, so Recoil provides and tests its own TS types.
Size
48.7 MB
Stars
19.4K
Age
6y
Commits · 90 Days