useSelector

Function: useSelector()

ts
function useSelector<TSource, TSelected>(
   source, 
   selector, 
options?): Readonly<Ref<TSelected>>;
function useSelector<TSource, TSelected>(
   source, 
   selector, 
options?): Readonly<Ref<TSelected>>;

Defined in: vue-store/src/useSelector.ts:39

Selects a slice of state from an atom or store and subscribes the component to that selection.

This is the primary Vue read hook for TanStack Store. It returns a readonly ref containing the selected value.

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

Readonly<Ref<TSelected>>

Examples

ts
const count = useSelector(counterStore, (state) => state.count)
console.log(count.value)
const count = useSelector(counterStore, (state) => state.count)
console.log(count.value)
ts
const value = useSelector(countAtom)
const value = useSelector(countAtom)
Subscribe to Bytes

Your weekly dose of JavaScript news. Delivered every Monday to over 100,000 devs, for free.

Bytes

No spam. Unsubscribe at any time.