TanStack Router v1

Framework

Version

Menu

Getting Started

Migrate from React Router

Migrate from React Location

Decisions on DX

Guide

Route Trees & Nesting

Routing Concepts

File-Based Routing

Code Based Routing

Creating a Router

Deferred Data Loading

External Data Loading

Navigation Blocking

Custom Search Param Serialization

Not Found Errors

Authenticated Routes

Scroll Restoration

Static Route Data

API

Examples

Quickstart (file-based)

Quickstart (code-based)

Basic (file-based)

Basic (code-based)

Basic + React Query (file-based)

Basic + React Query (code-based)

Basic + SSR (file-based)

Basic + SSR Streaming (file-based)

Kitchen Sink (file-based)

Kitchen Sink (code-based)

Kitchen Sink + React Query (file-based)

Kitchen Sink + React Query (code-based)

Vinxi (file-based)

Vinxi + SSR (file-based)

Vinxi + SSR Streaming (file-based)

Location Masking

Authenticated Routes

Scroll Restoration

Navigation Blocking

TanStack Router v1

Framework

Version

Menu

Getting Started

Migrate from React Router

Migrate from React Location

Decisions on DX

Guide

Route Trees & Nesting

Routing Concepts

File-Based Routing

Code Based Routing

Creating a Router

Deferred Data Loading

External Data Loading

Navigation Blocking

Custom Search Param Serialization

Not Found Errors

Authenticated Routes

Scroll Restoration

Static Route Data

API

Examples

Quickstart (file-based)

Quickstart (code-based)

Basic (file-based)

Basic (code-based)

Basic + React Query (file-based)

Basic + React Query (code-based)

Basic + SSR (file-based)

Basic + SSR Streaming (file-based)

Kitchen Sink (file-based)

Kitchen Sink (code-based)

Kitchen Sink + React Query (file-based)

Kitchen Sink + React Query (code-based)

Vinxi (file-based)

Vinxi + SSR (file-based)

Vinxi + SSR Streaming (file-based)

Location Masking

Authenticated Routes

Scroll Restoration

Navigation Blocking

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 compatible with React v16.8+ and is currently only compatible with ReactDOM. If you would like to contribute to the React Native adapter, please reach out to us on Discord.

Requirements

TanStack Router requires React v16.8+ and ReactDOM v16.8+. If you're working with TypeScript, you'll need TypeScript v5.0+.

Subscribe to Bytes

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

Subscribe to Bytes

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