Skip to main content

atom(options)

An atom represents state in Recoil. The atom() function returns a writeable RecoilState object.


function atom<T>({
key: string,

default?: T | Promise<T> | Loadable<T> | WrappedValue<T> | RecoilValue<T>,

effects?: $ReadOnlyArray<AtomEffect<T>>,

dangerouslyAllowMutability?: boolean,
}): RecoilState<T>
  • key - A unique string used to identify the atom internally. This string should be unique with respect to other atoms and selectors in the entire application.
  • default - The initial value of the atom. It can also be a Promise, Loadable, wrapped value, or another atom or selector of the same type representing the default value.
    • If a selector is used as the default the atom will dynamically update as the default selector updates. Once the atom is set, then it will retain that value unless the atom is reset.
    • If no default is provided, as oppose to a value which could include null or undefined, the atom will start in a "pending" state and trigger Suspense until it is set.
    • If you would like to set the default atom value directly to a Promise, Loadable, atom, selector, or function without unwrapping it, then you can wrap it with atom.value(...).
  • effects - An optional array of Atom Effects for the atom.
  • dangerouslyAllowMutability - In some cases it may be desireable to allow mutating of objects stored in atoms that don't represent state changes. Use this option to override freezing objects in development mode.

Recoil manages atom state changes to know when to notify components subscribing to that atom to re-render, so you should use the hooks listed below to change atom state. If an object stored in an atom was mutated directly it may bypass this and cause state changes without properly notifying subscribing components. To help detect bugs like this Recoil will freeze objects stored in atoms in development mode.

Most often, you'll use the following hooks to interact with atoms:

  • useRecoilState(): Use this hook when you intend on both reading and writing to the atom. This hook subscribes the component to the atom.
  • useRecoilValue(): Use this hook when you intend on only reading the atom. This hook subscribes the component to the atom.
  • useSetRecoilState(): Use this hook when you intend on only writing to the atom.
  • useResetRecoilState(): Use this hook to reset an atom to its default value.

For rare cases where you need to read an atom's value without subscribing the component, see useRecoilCallback().

You can initialize an atom either with a static value or with a Promise or a RecoilValue representing a value of the same type. Because the Promise may be pending or the default selector may be asynchronous it means that the atom value may also be pending or throw an error when reading. Note that you cannot currently assign a Promise when setting an atom. Please use selectors for async functions.

Atoms cannot be used to store Promise's or RecoilValue's directly, but they may be wrapped in an object. Note that Promise's may be mutable. Atoms can be set to a function, as long as it is pure, but to do so you may need to use the updater form of setters. (e.g. set(myAtom, () => myFunc);).

Example

import {atom, useRecoilState} from 'recoil';

const counter = atom({
key: 'myCounter',
default: 0,
});

function Counter() {
const [count, setCount] = useRecoilState(counter);
const incrementByOne = () => setCount(count + 1);

return (
<div>
Count: {count}
<br />
<button onClick={incrementByOne}>Increment</button>
</div>
);
}

Atom Families

atomFamily() can be useful for storing a collection of related states or scoping your atom state.