@tanstack/react-router 1.133.13 → 1.133.18

package/dist/llms/rules/guide.js

@@ -5183,6 +5183,9 @@ const router = createRouter({
 })
 \`\`\`
 
+> [!TIP]
+> \`MyRouterContext\` only needs to contain content that will be passed directly to \`createRouter\` below. All other context added in \`beforeLoad\` will be inferred.
+
 ## Passing the initial Router Context
 
 The router context is passed to the router at instantiation time. You can pass the initial router context to the router via the \`context\` option:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/react-router",
-  "version": "1.133.13",
+  "version": "1.133.18",
   "description": "Modern and scalable routing for React applications",
   "author": "Tanner Linsley",
   "license": "MIT",
@@ -80,7 +80,7 @@
     "tiny-invariant": "^1.3.3",
     "tiny-warning": "^1.0.3",
     "@tanstack/history": "1.133.3",
-    "@tanstack/router-core": "1.133.13"
+    "@tanstack/router-core": "1.133.18"
   },
   "devDependencies": {
     "@testing-library/jest-dom": "^6.6.3",

package/src/fileRoute.ts

@@ -35,6 +35,17 @@ import type { UseLoaderDepsRoute } from './useLoaderDeps'
 import type { UseLoaderDataRoute } from './useLoaderData'
 import type { UseRouteContextRoute } from './useRouteContext'
 
+/**
+ * Creates a file-based Route factory for a given path.
+ *
+ * Used by TanStack Router's file-based routing to associate a file with a
+ * route. The returned function accepts standard route options. In normal usage
+ * the `path` string is inserted and maintained by the `tsr` generator.
+ *
+ * @param path File path literal for the route (usually auto-generated).
+ * @returns A function that accepts Route options and returns a Route instance.
+ * @link https://tanstack.com/router/latest/docs/framework/react/api/router/createFileRouteFunction
+ */
 export function createFileRoute<
   TFilePath extends keyof FileRoutesByPath,
   TParentRoute extends AnyRoute = FileRoutesByPath[TFilePath]['parentRoute'],

package/src/link.tsx

@@ -514,6 +514,18 @@ export interface LinkComponentRoute<
   ): React.ReactElement
 }
 
+/**
+ * Creates a typed Link-like component that preserves TanStack Router's
+ * navigation semantics and type-safety while delegating rendering to the
+ * provided host component.
+ *
+ * Useful for integrating design system anchors/buttons while keeping
+ * router-aware props (eg. `to`, `params`, `search`, `preload`).
+ *
+ * @param Comp The host component to render (eg. a design-system Link/Button)
+ * @returns A router-aware component with the same API as `Link`.
+ * @link https://tanstack.com/router/latest/docs/framework/react/guide/custom-link
+ */
 export function createLink<const TComp>(
   Comp: Constrain<TComp, any, (props: CreateLinkProps) => ReactNode>,
 ): LinkComponent<TComp> {
@@ -522,6 +534,22 @@ export function createLink<const TComp>(
   }) as any
 }
 
+/**
+ * A strongly-typed anchor component for declarative navigation.
+ * Handles path, search, hash and state updates with optional route preloading
+ * and active-state styling.
+ *
+ * Non-obvious props include:
+ * - `preload`: Controls route preloading (eg. 'intent', 'render', 'viewport', true/false)
+ * - `preloadDelay`: Delay in ms before preloading on hover
+ * - `activeProps`/`inactiveProps`: Additional props merged when link is active/inactive
+ * - `resetScroll`/`hashScrollIntoView`: Control scroll behavior on navigation
+ * - `viewTransition`/`startTransition`: Use View Transitions/React transitions for navigation
+ * - `ignoreBlocker`: Bypass registered blockers
+ *
+ * @returns An anchor-like element that navigates without full page reloads.
+ * @link https://tanstack.com/router/latest/docs/framework/react/api/router/linkComponent
+ */
 export const Link: LinkComponent<'a'> = React.forwardRef<Element, any>(
   (props, ref) => {
     const { _asChild, ...rest } = props

package/src/route.tsx

@@ -307,6 +307,17 @@ export class Route<
   ) as unknown as LinkComponentRoute<TFullPath>
 }
 
+/**
+ * Creates a non-root Route instance for code-based routing.
+ *
+ * Use this to define a route that will be composed into a route tree
+ * (typically via a parent route's `addChildren`). If you're using file-based
+ * routing, prefer `createFileRoute`.
+ *
+ * @param options Route options (path, component, loader, context, etc.).
+ * @returns A Route instance to be attached to the route tree.
+ * @link https://tanstack.com/router/latest/docs/framework/react/api/router/createRouteFunction
+ */
 export function createRoute<
   TRegister = unknown,
   TParentRoute extends RouteConstraints['TParentRoute'] = AnyRoute,
@@ -403,6 +414,15 @@ export type AnyRootRoute = RootRoute<
   any
 >
 
+/**
+ * Creates a root route factory that requires a router context type.
+ *
+ * Use when your root route expects `context` to be provided to `createRouter`.
+ * The returned function behaves like `createRootRoute` but enforces a context type.
+ *
+ * @returns A factory function to configure and return a root route.
+ * @link https://tanstack.com/router/latest/docs/framework/react/api/router/createRootRouteWithContextFunction
+ */
 export function createRootRouteWithContext<TRouterContext extends {}>() {
   return <
     TRegister = Register,
@@ -563,6 +583,16 @@ export class RootRoute<
   ) as unknown as LinkComponentRoute<'/'>
 }
 
+/**
+ * Creates a root Route instance used to build your route tree.
+ *
+ * Typically paired with `createRouter({ routeTree })`. If you need to require
+ * a typed router context, use `createRootRouteWithContext` instead.
+ *
+ * @param options Root route options (component, error, pending, etc.).
+ * @returns A root route instance.
+ * @link https://tanstack.com/router/latest/docs/framework/react/api/router/createRootRouteFunction
+ */
 export function createRootRoute<
   TRegister = Register,
   TSearchValidator = undefined,

package/src/router.ts

@@ -77,6 +77,17 @@ declare module '@tanstack/router-core' {
   }
 }
 
+/**
+ * Creates a new Router instance for React.
+ *
+ * Pass the returned router to `RouterProvider` to enable routing.
+ * Notable options: `routeTree` (your route definitions) and `context`
+ * (required if the root route was created with `createRootRouteWithContext`).
+ *
+ * @param options Router options used to configure the router.
+ * @returns A Router instance to be provided to `RouterProvider`.
+ * @link https://tanstack.com/router/latest/docs/framework/react/api/router/createRouterFunction
+ */
 export const createRouter: CreateRouterFn = (options) => {
   return new Router(options)
 }

package/src/useNavigate.tsx

@@ -8,6 +8,16 @@ import type {
   UseNavigateResult,
 } from '@tanstack/router-core'
 
+/**
+ * React hook that returns a `navigate` function for programmatic navigation.
+ * Supports updating pathname, search, hash and state with full type-safety.
+ *
+ * Options:
+ * - `from`: Default base path used to resolve relative `to` destinations.
+ *
+ * @returns A memoized `navigate` function.
+ * @link https://tanstack.com/router/latest/docs/framework/react/api/router/useNavigateHook
+ */
 export function useNavigate<
   TRouter extends AnyRouter = RegisteredRouter,
   TDefaultFrom extends string = string,
@@ -27,6 +37,15 @@ export function useNavigate<
   ) as UseNavigateResult<TDefaultFrom>
 }
 
+/**
+ * Component that triggers a navigation when rendered. Navigation executes
+ * in an effect after mount/update.
+ *
+ * Props are the same as `NavigateOptions` used by `navigate()`.
+ *
+ * @returns null
+ * @link https://tanstack.com/router/latest/docs/framework/react/api/router/navigateComponent
+ */
 export function Navigate<
   TRouter extends AnyRouter = RegisteredRouter,
   const TFrom extends string = string,