Open History to see the last commit
function useSelector<TSource, TSelected>(
source,
selector?,
options?): TSelected;
Defined in: packages/react-store/src/useSelector.ts:60
Selects a slice of state from an atom or store and subscribes the component to that selection.
This is the primary React read hook for TanStack Store. It works with any
source that exposes get() and subscribe(), including atoms, readonly
atoms, stores, and readonly stores.
Omit the selector to subscribe to the whole value.
Type Parameters#
TSource#
TSource
TSelected#
TSelected = NoInfer<TSource>
Parameters#
source#
SelectionSource<TSource>
selector?#
(snapshot) => TSelected
options?#
UseSelectorOptions<TSelected>
Returns#
TSelected
Examples#
const count = useSelector(counterStore, (state) => state.count)
const value = useSelector(countAtom)