Store API Reference

useAtom

Function: useAtom()

function useAtom<TValue>(atom, options?): [TValue, (fn) => void & (value) => void];

function useAtom<TValue>(atom, options?): [TValue, (fn) => void & (value) => void];

Defined in: preact-store/src/useAtom.ts:22

Returns the current atom value together with a stable setter.

Use this when a component needs to both read and update the same writable atom.

Type Parameters

TValue

Parameters

atom

Atom<TValue>

options?

UseSelectorOptions<TValue>

Returns

[TValue, (fn) => void & (value) => void]

Example

tsx

const [count, setCount] = useAtom(countAtom)

return (
  <button type="button" onClick={() => setCount((prev) => prev + 1)}>
    {count}
  </button>
)

const [count, setCount] = useAtom(countAtom)

return (
  <button type="button" onClick={() => setCount((prev) => prev + 1)}>
    {count}
  </button>
)