Function: useSelector()#

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#

const count = useSelector(counterStore, (state) => state.count)
console.log(count.value)

const count = useSelector(counterStore, (state) => state.count)
console.log(count.value)

const value = useSelector(countAtom)

const value = useSelector(countAtom)