Libraries
Framework
Start
Router
Data & State
Query
DB
Store
AI
UI & UX
Table
Charts
Form
Hotkeys
Markdown
Highlight
Performance
Virtual
Pacer
Tooling
Devtools
Config
CLI
Intent
Browse all libraries
Blog
Blog & Release Notes
About
YouTube
The official TanStack channel.
Workshops
Live sessions from the maintainers.
Release Notes
The latest releases and changelog.
Community
Channels
Discord
Real-time community support.
GitHub
Source, issues, discussions, and releases.
People & Work
Maintainers
Meet the people maintaining the stack.
Contributors
Core, library, and community contributors.
Showcase
Teams building with TanStack.
Tools
Tools
Builder
Alpha
Generate TanStack app starters.
Stats
NPM and ecosystem usage data.
Merch
View all
Support
Support
Support Overview
Find the right support path.
Partners
Companies supporting TanStack.
OSS Sponsors
Sponsors keeping TanStack open source.
Enterprise Support
Private consulting and expert support.
Contact
Get in touch with the TanStack team.
About
Ethos
How we approach open source.
Tenets
The values that shape TanStack libraries.
Design System
Logos, tokens, and UI components.
Search
AI
Ask AI
Log In
Log In
Libraries
Blog
Blog & Release Notes
About
YouTube
The official TanStack channel.
Workshops
Live sessions from the maintainers.
Release Notes
The latest releases and changelog.
Community
Channels
Discord
Real-time community support.
GitHub
Source, issues, discussions, and releases.
People & Work
Maintainers
Meet the people maintaining the stack.
Contributors
Core, library, and community contributors.
Showcase
Teams building with TanStack.
Tools
Tools
Builder
Alpha
Generate TanStack app starters.
Stats
NPM and ecosystem usage data.
Merch
View all
Support
Support
Support Overview
Find the right support path.
Partners
Companies supporting TanStack.
OSS Sponsors
Sponsors keeping TanStack open source.
Enterprise Support
Private consulting and expert support.
Contact
Get in touch with the TanStack team.
About
Ethos
How we approach open source.
Tenets
The values that shape TanStack libraries.
Design System
Logos, tokens, and UI components.
Partnership Inquiry
Router Docs
React
Latest
Search...
K
Home
Get Started
Guides
API
Examples
API
Router
File-Based Routing
Router
Menu
Menu
Home
Get Started
Guides
API
Examples
React
Latest
API
Router
File-Based Routing
AI/LLM: This documentation page is available in plain markdown format at/router/latest/docs/api/router.md
API
Router API
Copy page
Functions
createFileRoute
createLazyFileRoute
createRootRoute
createRootRouteWithContext
createRoute
createLazyRoute
createRouteMask
createRouter
defer
getRouteApi
isNotFound
isRedirect
lazyRouteComponent
linkOptions
notFound
redirect
retainSearchParams
stripSearchParams
Components
<Await>
<CatchBoundary>
<CatchNotFound>
<ClientOnly>
<DefaultGlobalNotFound>
<ErrorComponent>
<Link>
<MatchRoute>
<Navigate>
<NotFoundComponent>
<Outlet>
Hooks
useAwaited
useBlocker
useCanGoBack
useChildMatches
useLinkProps
useLoaderData
useLoaderDeps
useLocation
useMatch
useMatchRoute
useMatches
useNavigate
useParentMatches
useParams
useRouteContext
useRouter
useRouterState
useSearch
Types
ActiveLinkOptions Type
AsyncRouteComponent Type
HistoryState Interface
LinkOptions Type
LinkProps Type
MatchRouteOptions Type
NavigateOptions Type
NotFoundError Type
ParsedHistoryState Type
ParsedLocation Type
Redirect Type
Register Type
Route Type
RouteApi Type
RouteMask Type
RouteMatch Type
RouteOptions Type
Router Type
RouterEvents Type
RouterOptions Type
RouterState Type
ToMaskOptions Type
ToOptions Type
UseMatchRouteOptions Type
ViewTransitionOptions Type
⚠️ Deprecated
FileRoute Class
Route Class
Router Class
RouteApi Class
RootRoute Class
NotFoundRoute Class
rootRouteWithContext Function
Edit on GitHub
Next
File-Based Routing
Blog
@Tan_Stack on X.com
@TannerLinsley on X.com
GitHub
YouTube
Ethos
Tenets
Privacy Policy
Terms of Service
© 2026 TanStack LLC
Partners
Become a Partner
Gold
Silver
Bronze
Latest Posts