Framework
Version
Getting Started
Guide
Route Trees & Nesting
react
Routing Concepts
react
Code Splitting
react
File-Based Routing
react
Code Based Routing
react
Creating a Router
react
Route Matching
react
Outlets
react
Navigation
react
Path Params
react
Search Params
react
Data Loading
react
Deferred Data Loading
react
External Data Loading
react
Data Mutations
react
Type Safety
react
Preloading
react
Route Masking
react
Navigation Blocking
react
Custom Search Param Serialization
react
History Types
react
Router Context
react
Not Found Errors
react
Authenticated Routes
react
Scroll Restoration
react
Static Route Data
react
SSR
react
Examples
Quickstart (file-based)
react
Quickstart (code-based)
react
Start Basic
react
Start Basic (RSC)
react
Basic (file-based)
react
Basic (code-based)
react
Basic + React Query (file-based)
react
Basic + React Query (code-based)
react
Basic + SSR (file-based)
react
Basic + SSR Streaming (file-based)
react
Kitchen Sink (file-based)
react
Kitchen Sink (code-based)
react
Kitchen Sink + React Query (file-based)
react
Kitchen Sink + React Query (code-based)
react
Location Masking
react
Authenticated Routes
react
Scroll Restoration
react
Deferred Data
react
Navigation Blocking
react
Installation
You can install TanStack Router with any NPM package manager.
sh
npm install @tanstack/react-router
npm install @tanstack/react-router
TanStack Router is currently only compatible with React and ReactDOM. If you would like to contribute to the React Native adapter, please reach out to us on Discord.
Requirements
- React v18.x.x
- ReactDOM v18.x.x
- TypeScript v5.x.x (TypeScript is optional, but recommended)
'%3e%3c/path%3e%3c/svg%3e)
'%3e%3c/path%3e%3c/svg%3e)
Subscribe to Bytes
Your weekly dose of JavaScript news. Delivered every Monday to over 100,000 devs, for free.