Source: https://tanstack.com/store/latest/docs/framework/react/reference/functions/usestore

TanStack

Store v0v0

Search...

+ K

Auto

Log In

TanStack StartRC

Docs Examples GitHub Contributors

TanStack Router

Docs Examples GitHub Contributors

TanStack Query

Docs Examples GitHub Contributors

TanStack Table

Docs Examples Github Contributors

TanStack Formnew

Docs Examples Github Contributors

TanStack DBbeta

Docs Github Contributors

TanStack Virtual

Docs Examples Github Contributors

TanStack Paceralpha

Docs Examples Github Contributors

TanStack Storealpha

Docs Examples Github Contributors

TanStack Devtoolsalpha

Docs Github Contributors

More Libraries

Maintainers Partners Support Learn StatsBETA Discord Merch Blog GitHub Ethos Brand Guide

Documentation

Framework

React

Version

Latest

Search...

+ K

Menu

• Home

• Frameworks

• Contributors

• GitHub

• Discord

Getting Started

• Overview
  
  core

• Installation
  
  core

• Quick Start
  
  core

• Quick Start
  
  react

API Reference

• JavaScript Reference
  
  core

• Classes / Store
  
  core

• Classes / Derived
  
  core

• Classes / Effect
  
  core

• Interfaces / StoreOptions
  
  core

• Interfaces / DerivedOptions
  
  core

• React Reference
  
  react

• Functions / useStore
  
  react

• Functions / shallow
  
  react

Examples

• Simple
  
  react

Framework

React

Version

Latest

Menu

• Home

• Frameworks

• Contributors

• GitHub

• Discord

Getting Started

• Overview
  
  core

• Installation
  
  core

• Quick Start
  
  core

• Quick Start
  
  react

API Reference

• JavaScript Reference
  
  core

• Classes / Store
  
  core

• Classes / Derived
  
  core

• Classes / Effect
  
  core

• Interfaces / StoreOptions
  
  core

• Interfaces / DerivedOptions
  
  core

• React Reference
  
  react

• Functions / useStore
  
  react

• Functions / shallow
  
  react

Examples

• Simple
  
  react

On this page

• Function: useStore()

• Call Signature

• Type Parameters

• Parameters

• store

• selector?

• options?

• Returns

• Call Signature

• Type Parameters

• Parameters

• store

• selector?

• options?

• Returns

useStore

Copy Markdown

Function: useStore()
==================== Call Signature
--------------

ts

function useStore<TState, TSelected>(
   store, 
   selector?, 
   options?): TSelected


function useStore<TState, TSelected>(
   store, 
   selector?, 
   options?): TSelected

Defined in: index.ts:15

### Type Parameters

• TState

• TSelected = NoInfer<TState>

### Parameters #### store

Store<TState, any>

#### selector?

(state) => TSelected

#### options?

UseStoreOptions<TSelected>

### Returns

TSelected

Call Signature
--------------

ts

function useStore<TState, TSelected>(
   store, 
   selector?, 
   options?): TSelected


function useStore<TState, TSelected>(
   store, 
   selector?, 
   options?): TSelected

Defined in: index.ts:20

### Type Parameters

• TState

• TSelected = NoInfer<TState>

### Parameters #### store

Derived<TState, any>

#### selector?

(state) => TSelected

#### options?

UseStoreOptions<TSelected>

### Returns

TSelected

Edit on GitHub

React Reference

Functions / shallow

Partners Become a Partner