router README

The project's README from github.com/TanStack/router. As one markdown file: README.md.

TanStack Router

TanStack Router

A modern router designed for type safety, data‑driven navigation, and seamless developer experience.

  • End‑to-end type safety (routes, params, loaders)
  • Schema‑driven search params with validation
  • Built‑in caching, prefetching & invalidation
  • Nested layouts, transitions & error boundaries

Read the Router Docs →

TanStack Start

TanStack Start

A full‑stack framework built on Router, designed for server rendering, streaming, and production‑ready deployments.

  • Full‑document SSR & streaming
  • Server functions & end‑to‑end type safety
  • Deployment‑ready bundling & builds
  • All the power of TanStack Router, plus full‑stack features

Read the Start Docs →


npm downloads GitHub stars Bundle size

semantic-release Best of JS Follow @TanStack

Become a Sponsor!

Get Involved

Partners

CodeRabbit Cloudflare Netlify
Neon Clerk Convex
Sentry Prisma Strapi
Router & you?

We're looking for TanStack Router & Start Partners to join our mission! Partner with us to push the boundaries of TanStack Router & Start and build amazing things together.

LET'S CHAT

Explore the TanStack Ecosystem

… and more at TanStack.com »

router (TanStack/router)

Searching Database…

15.2K ·GitHub
Что это такое?TanStack Router — это современный роутер для веба, построенный вокруг сквозной типобезопасности: маршруты, параметры, загрузчики (loaders) и search-параметры всё проверяются типами. В этом же репозитории живёт TanStack Start — фулстек-фреймворк, построенный поверх роутера.
Это библиотека-роутер или полноценный фреймворк?И то, и другое, в одном репозитории: Router — это клиентская библиотека маршрутизации, а Start — необязательный фулстек-слой поверх неё, который добавляет SSR всего документа, стриминг, серверные функции и готовые к деплою сборки.
Как добавить его в свой проект?Установите пакет для вашего фреймворка (npm install @tanstack/react-router) и следуйте разделу quick start в документации Router; у Start есть собственный трек документации. Сам репозиторий — это монорепозиторий на pnpm + nx.
Он работает только с React?React — основной целевой фреймворк: проект описывается как роутер «для веба (React и не только)», а кодовая база целиком написана на TypeScript. Актуальный список поддерживаемых фреймворков смотрите в документации.
Он готов к продакшену или всё ещё экспериментальный?Он позиционируется как решение для продакшена, а не как эксперимент: Start поставляет готовые к деплою сборки, а CI репозитория прогоняет eslint, юнит- и e2e-тесты, проверку типов и сборку на каждое изменение.
Можно ли сделать с ним обычное SPA-приложение, или серверная часть обязательна?Роутер изначально клиентский, поэтому классическое одностраничное приложение — базовый сценарий, сервер не нужен. TanStack Start подключается по желанию: добавляйте его, когда нужны SSR всего документа, стриминг и серверные функции на той же модели маршрутизации.
Он сам занимается загрузкой данных и кешированием?Да — кеширование, предзагрузка и инвалидация встроены в роутер, а загрузчики являются типизированной частью маршрута, так что навигация, управляемая данными, работает без подключения дополнительных библиотек.
Как он работает с search-параметрами в URL?Они описываются схемой: вы объявляете схему валидации для каждого маршрута, и параметры остаются полностью типобезопасными от начала до конца, вместо того чтобы быть «сырыми» строками, распарсенными из URL.
Можно ли делать вложенные макеты и обработку ошибок на уровне маршрута?Да — вложенные макеты, переходы и error boundaries — это полноценные возможности маршрутизации, встроенные прямо в роутер.
What are similar projects?nuxt, react-router, wasp, framework, reflex, fresh, graphql, open-saas
Creator
TanStack
Size
116.8 MB
Stars
15.2K
Age
7y
Commits · 90 Days