TanStack
Router v1v1
Libraries
Framework
StartRC
Docs
Router
Docs
Data & State Management
Query
Docs
DBbeta
Docs
Storealpha
Docs
AIbeta
Docs
UI & UX
Table
Docs
Formnew
Docs
Hotkeysalpha
Docs
Performance
Virtual
Docs
Pacerbeta
Docs
Tooling
Devtoolsalpha
Docs
Config
Docs
CLIalpha
Docs
Intentalpha
Docs
Resources
BlogRelease notes, architecture notes, and essays.YouTubeThe official TanStack channel.
Workshops
Learn from maintainers

Remote and in-person TanStack workshops for teams that need depth.

Professional Workshops
Channels
DiscordCommunity support and real-time discussion.GitHubSource, issues, discussions, and releases.
People & Work
MaintainersMeet the people maintaining the stack.ContributorsCore, library, and community contributors.ShowcaseProducts and teams building with TanStack.
Tools
BuilderAlphaGenerate TanStack app starters.StatsNPM and ecosystem usage data.
Merch
Recent Products
All MerchBrowse all TanStack apparel, accessories, and stickers.
Support
Support OverviewFind the right support path.PartnersCompanies supporting TanStack.OSS SponsorsSponsors keeping TanStack open source.Enterprise SupportPrivate consulting and expert support.ContactGet in touch with the TanStack team.
About
EthosHow we think about open source and products.TenetsThe values that shape TanStack libraries.Brand GuideLogos, colors, and brand usage.
Partners
Work with TanStack

Sponsorships, placements, and partner pages.

Partnership Inquiry
Log In
Log In
All LibrariesBrowse the full set of public packages.
Framework
StartRC
Docs
Router
Docs
Data & State Management
Query
Docs
DBbeta
Docs
Storealpha
Docs
AIbeta
Docs
UI & UX
Table
Docs
Formnew
Docs
Hotkeysalpha
Docs
Performance
Virtual
Docs
Pacerbeta
Docs
Tooling
Devtoolsalpha
Docs
Config
Docs
CLIalpha
Docs
Intentalpha
Docs
Resources
BlogRelease notes, architecture notes, and essays.YouTubeThe official TanStack channel.
Professional Workshops
Channels
DiscordCommunity support and real-time discussion.GitHubSource, issues, discussions, and releases.
People & Work
MaintainersMeet the people maintaining the stack.ContributorsCore, library, and community contributors.ShowcaseProducts and teams building with TanStack.
Tools
BuilderAlphaGenerate TanStack app starters.StatsNPM and ecosystem usage data.
Recent Products
All MerchBrowse all TanStack apparel, accessories, and stickers.
Support
Support OverviewFind the right support path.PartnersCompanies supporting TanStack.OSS SponsorsSponsors keeping TanStack open source.Enterprise SupportPrivate consulting and expert support.ContactGet in touch with the TanStack team.
About
EthosHow we think about open source and products.TenetsThe values that shape TanStack libraries.Brand GuideLogos, colors, and brand usage.
Partnership Inquiry
Docs
API
  • Router
  • File-Based Routing
HomeGet StartedGuidesAPIExamplesCommunity
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

  • 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
NextFile-Based Routing
Blog
@Tan_Stack on X.com
@TannerLinsley on X.com
GitHub
YouTube
Nozzle.io - Keyword Rank Tracker
Ethos
Tenets
Privacy Policy
Terms of Service
© 2026 TanStack LLC
PartnersBecome a Partner
Gold
CodeRabbitCodeRabbit
CloudflareCloudflare
RailwayRailway
Silver
AG GridAG Grid
OpenRouterOpenRouter
ClerkClerk
WorkOSWorkOS
SerpAPISerpAPI
NetlifyNetlify
Bronze
UnkeyUnkey
SentrySentry
ElectricElectric
PrismaPrisma
    Latest Posts
    TypeScript Performance in TanStack Table V9Jun 14, 2026TanStack AI Beta: The Switzerland of AI Tooling Grows UpJun 9, 2026TanStack Table V9: Taking FormJun 7, 2026