Skip to content
Source
Sign inSign up
TanStack/form
Open History to see the last commit

useSelector.md

60 lines1.0 KB

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

Defined in: node_modules/.pnpm/@tanstack+vue-store@0.11.1_vue@3.6.0-rc.9_typescript@6.0.3_/node_modules/@tanstack/vue-store/dist/useSelector.d.ts:33

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 value = useSelector(countAtom)