Skip to content
Source
Sign inSign up
TanStack/router
Open History to see the last commit

CHANGELOG.md

707 lines42.1 KB

@tanstack/solid-router

1.170.39

Patch Changes

  • #8602 efc2042 - Links of a route that the pending navigation leaves skip deriving the destination location, and clicks and preloads follow the href a Link displays. buildLocation now builds mask and routeMasks locations from the same _fromLocation as the destination.

  • #8579 d35aab4 - Cancel pending link preload timers when starting navigation to avoid redundant preloading while the destination is loading.

  • #8619 e7ab157 - Solid Links resolve their own props through one reactive memo instead of two, which makes mounting and updating many Links slightly faster.

  • #8602 efc2042 - Solid and Vue Links reuse the router's built destination across navigations and derive their state through fewer reactive nodes. Solid Links call a user ref once per element and create no reactive nodes on the server.

  • Updated dependencies [dfe3dea, dfe3dea, dfe3dea, efc2042, efc2042, dfe3dea, 663282b]:

    • @tanstack/history@1.162.5
    • @tanstack/router-core@1.171.35

1.170.38

Patch Changes

  • Updated dependencies [d521abd]:
    • @tanstack/router-core@1.171.34

1.170.37

Patch Changes

  • #8436 f5ffd38 - Skip unused Link preload cleanup when preloading is disabled and ignore queued viewport notifications after their effect has been cleaned up.

  • Updated dependencies [488d046, 0c1b5e3, 3cdd1af]:

    • @tanstack/router-core@1.171.33

1.170.36

Patch Changes

1.170.35

Patch Changes

  • #8418 e561fa1 - deepEqual now takes its flags as positional arguments β€” deepEqual(a, b, partial?, explicitUndefined?) β€” instead of an options object. The router's hot callers (Link option stabilization and active-state checks, matchRoute) no longer allocate an options object per comparison, and the comparator reads two booleans instead of a polymorphic object. explicitUndefined replaces ignoreUndefined: false. deepEqual is an internal helper; it stays exported for compatibility of two-argument calls.

  • #8419 a1c8d1a - resolvePath (internal helper) now takes positional arguments β€” resolvePath(base, to, trailingSlash?, cache?) β€” so buildLocation and matchRoute no longer allocate an options object per path resolution.

  • #8204 cbbfbe3 - Stream large deferred SSR hydration payloads through a backpressure-aware router transport, fail known setup errors before response creation, and close cancelled or expired transforms safely.

    Start now cancels discarded middleware and HEAD response bodies, including plain streams and derived branches.

    Server-function raw streams share one ordered response. Arbitrary or sequential consumption can require potentially unbounded buffering of unread data on the client. Cancelling one raw stream discards it locally, while aborting the whole call cancels the response and server work. Consume streams concurrently, cancel unused streams promptly, or use separate calls when independent backpressure is required. A raw stream that exceeds its unread-byte limit now fails alone; sibling streams and the JSON result keep flowing.

    The JSON wire shape of a RawStream server-function argument changed. Clients and servers must run matching versions for requests that pass a RawStream.

    The frame-protocol constants (FRAME_TYPE_*, MAX_FRAME_PAYLOAD_SIZE, MAX_FRAMED_STREAMS) moved from the @tanstack/start-client-core root to the @tanstack/start-client-core/client-rpc subpath.

    Router requests whose Accept header allows neither text/html nor */* now receive 406 Not Acceptable instead of 500.

    Framework adapters share the body <Scripts> composition (getSsrBodyScriptParts, composeSsrBodyScripts) and the eager HTML response wrapper (renderSsrHtmlResponse) from @tanstack/router-core.

    Solid SSR now emits one document type and renders late lazy errors through route boundaries. A Solid <Await> without a fallback no longer holds the streamed shell; it renders inside the nearest <Suspense> boundary like React and Vue, and now renders falsy resolved values.

    Static server functions decode cached RawStream values with the client deserializer plugins.

    SSR Query integrations now keep request cleanup and stream ownership aligned with the router lifecycle.

  • Updated dependencies [bc80866, e561fa1, cbbfbe3, a1c8d1a, cbbfbe3, a0b2ad9, 1ca361b]:

    • @tanstack/router-core@1.171.31

1.170.34

Patch Changes

  • #8318 9b2adaf - Keep Solid Link's computed href, target, and disabled values authoritative when active or inactive state props contain routing options, while preserving state-prop refs, event handlers, and class/style merging.

  • #8318 9b2adaf - Allow active and inactive Link props to override base element props in React and Solid while preserving class/style merging. Keep React's href, target, and disabled values controlled by routing options. Preserve Vue object and nested-array class bindings, including reactive updates and server rendering, without mutating cached bindings during VNode normalization.

  • #8327 634da91 - Make pathParamsAllowedCharacters initialization-only. Configure it when creating the router; changing allowed characters requires a new router instance. Remove decoder-update bookkeeping and decoder-change checks from route-owned path caches.

  • #8370 e9396c9 - Stop exporting the internal isPlainObject and isPlainArray helpers.

  • #8318 9b2adaf - Reduce Link bundle size by sharing exact/fuzzy active-path checks and resolving only the selected active or inactive props. Avoid unnecessary class/style allocations while preserving reactive style updates, server rendering, and each framework's prop-override behavior.

  • Updated dependencies [d76a332, b747fb8, 6cfb1e8, 700a714, 700a714, 8fff7fa, f021f6d, ae68535, 7e349c3, 873c830, 7e349c3, 634da91, e9396c9, 634da91, f151ab0, bc57fa3, 9872d2a, d76a332, 634da91, 634da91, 7e349c3, 9448caa, e9396c9, 700a714, 634da91, 634da91]:

    • @tanstack/router-core@1.171.30
    • @tanstack/history@1.162.4

1.170.33

Patch Changes

  • #8316 b1c9219 - Skip client-only hydration, preloading, observer, and event-handler setup for all server-rendered links.

  • #8270 76239a3 - Avoid duplicate external script execution when a Solid script includes both src and children. Reuse each Solid hydration boundary's marker element instead of scanning all document markers on mount.

1.170.32

Patch Changes

  • #8308 9c1871c - Validate navigation and redirect destinations, keep ambiguous relative URLs on the current origin, and constrain prerender requests and output paths. Prevent redirect headers from appearing in serialized server function response bodies.

    Preserve native form HTTP redirects, route error handling and masks for document redirects, and per-navigation destinations for shared loader redirects. Avoid redundant origin parsing and reduce link styling and server-rendering work. Configured origins must already be normalized.

    Keep blocked-link inactive props consistent during React hydration, honor explicit redirect Location headers before checking route options, and refresh Vue link state when destinations become internal. Reuse the protocol-relative URL check while parsing redirect schemes once.

    Reduce React link bundle size by sharing pathname comparisons, state-prop selection, and element creation.

    Share normalized pathname comparisons in Solid and Vue links to reduce bundle size.

  • Updated dependencies [f9836f1, 9c1871c, 9871c06, 0654c0a]:

    • @tanstack/router-core@1.171.29
    • @tanstack/history@1.162.3

1.170.31

Patch Changes

  • #8165 2f20c00 - Exclude structural descendants below error and not-found boundaries from route lifecycle callbacks. Preserve lifecycle membership through invalidation, hydration, background reloads, and superseded navigation publication.

  • #8209 28a5e45 - Preserve falsy thrown values in React and Vue error boundaries. Type React and Vue boundary error components and onCatch callbacks as unknown. Solid boundary errors remain typed as Error; SSR now wraps non-Error loader errors to match Solid’s native boundary behavior, preserving the original value in cause. Router state and loader onError values are unchanged.

    When upgrading React or Vue, narrow boundary errors (for example, with error instanceof Error) before reading message or stack. ErrorComponentProps<TError> remains available for values narrowed to a specific error type. Route onError types are unchanged.

  • #8161 f0b5eda - Retain successful not-found matches as terminal shared boundaries during client navigation, preserving route context while the destination loads.

  • #8251 0497cae - Use URL.canParse for absolute URL checks in links, navigation, redirects, and build configuration. Preserve a URL constructor fallback for older browsers.

  • #8169 0caf6b9 - Fix route-scoped useMatch, useSearch, and useParams APIs to forward the shouldThrow option and preserve optional return types when shouldThrow: false.

  • Updated dependencies [edf0e16, 2f20c00, 28a5e45, 08eff50, 216c0c4, 2f91503, f0b5eda, 50eafca, 0497cae, ee28348, 9035abc, c18e690]:

    • @tanstack/router-core@1.171.28
    • @tanstack/history@1.162.2

1.170.30

Patch Changes

  • #8132 fa65287 - Build client preload locations on demand and remove the prebuilt-location argument used by framework links.

  • #8130 cb281d7 - preserve context during reloads

  • Updated dependencies [fa65287, cb281d7]:

    • @tanstack/router-core@1.171.27

1.170.29

Patch Changes

  • Updated dependencies [3e016ac]:
    • @tanstack/router-core@1.171.26

1.170.28

Patch Changes

  • #8084 5d3785d - preserve pending UI across retained routes

  • Updated dependencies [5d3785d, 63d2cc9]:

    • @tanstack/router-core@1.171.25

1.170.27

Patch Changes

1.170.26

Patch Changes

  • #8054 31882c7 - Reuse resolved lazy route components when revisiting code-split routes, preventing unnecessary pending UI.

  • #8002 3848503 - Keep active route components mounted by default when route params change.

  • Updated dependencies [31882c7]:

    • @tanstack/router-core@1.171.23

1.170.25

Patch Changes

  • #8045 f500760 - Warn when an Outlet is rendered inside a pending, error, or not-found component.

  • #8043 1aafca9 - remove the undocumented Link isTransitioning state and data-transitioning attribute

  • #8044 aa10b65 - Apply preloadDelay to viewport link preloading and cancel pending preloads when links leave the viewport.

  • Updated dependencies [7e93431]:

    • @tanstack/router-core@1.171.22

1.170.24

Patch Changes

  • Updated dependencies [51138a8]:
    • @tanstack/router-core@1.171.21

1.170.23

Patch Changes

  • Updated dependencies [44a8c3e, 5253e70]:
    • @tanstack/router-core@1.171.20

1.170.22

Patch Changes

  • Updated dependencies [ea3a665]:
    • @tanstack/router-core@1.171.19

1.170.21

Patch Changes

  • #7970 2435885 - createFileRoute does not rely on FileRoute class

  • #7985 9cac62a - perf: compact private bundle boundaries- #7975

  • #7971 86bf510 - clean intersection observer options in link component

  • #7967 6aefb33 - Preserve path params in their raw string form while matching routes so structured values returned by params.parse produce stable match IDs and do not reuse stale loader data.

    RouterCore.getMatchedRoutes() now returns [matchedRoutes, rawParams, foundRoute] instead of an object.

  • Updated dependencies [84db4a8, 9cac62a, 6aefb33]:

    • @tanstack/router-core@1.171.18
    • @tanstack/history@1.162.1

1.170.20

Patch Changes

  • Updated dependencies [b2908c6]:
    • @tanstack/router-core@1.171.17

1.170.19

Patch Changes

  • #7805 45c4ad8 - Rewrite match loading around a lane-based scheduler that tracks each navigation, preload, and background reload as an ordered unit of work. This fixes pending/redirect/retry state leaking between overlapping navigations, restores correct SSR status codes for redirects, errors, and not-found responses, and closes hydration gaps where the client re-ran work the server had already completed.

    • Invalidation now retires matching active preloads so older speculative loader results cannot become fresh cache data after invalidation.
    • Route headers() now only runs on the server, matching the documented behavior β€” it is no longer invoked during client-side asset projection.
    • The documented default gcTime and preloadGcTime now match the existing runtime default of 5 minutes (300_000).

    Removed / changed exported internals

    • RouterState no longer includes loadedAt, isTransitioning, statusCode, or redirect. Use match.updatedAt in place of loadedAt; subscribe to router.state.status / router.state.isLoading in place of isTransitioning; server response status and redirect handling are now internal to the server loader and are no longer exposed on router.state.
    • RouteMatch.fetchCount has been removed, with no replacement β€” it was purely informational.
    • RouteMatch.status no longer includes 'redirected' (it remains 'pending' | 'success' | 'error' | 'notFound') β€” redirected matches are dropped from the match list instead of being rendered.
    • RouteMatch.globalNotFound has been renamed and privatized to the internal _notFound field. Use match.status === 'notFound' instead.
    • The exported React, Solid, and Vue Match components now accept routeId instead of matchId.
    • The exported RouterStores adapter contract now uses route-keyed presentation stores: matchesId is replaced by ids, matchStores by byRoute, and getRouteMatchStore() by getMatchStore(). The separate loadedAt, isLoading, isTransitioning, statusCode, and redirect stores have been removed, along with the pending/cache stores and their setters. StoreConfig.init has also been removed. Read application-facing state from router.state; preload and cache coordination are now internal.
    • Removed RouterCore members getMatch(), updateMatch(), cancelMatch(), and cancelMatches() β€” read matches from router.state.matches (e.g. router.state.matches.find((m) => m.id === id)); there is no replacement for mutating or cancelling an individual in-flight match from outside the router.
    • Removed RouterCore.hasNotFoundMatch() β€” use router.state.matches.some((m) => m.status === 'notFound').
    • Removed RouterCore.looseRoutesById β€” use routesById.
    • Removed RouterCore.isPrerendering(), RouterCore.isViewTransitionTypesSupported, and RouterCore.viewTransitionPromise, with no replacement.
    • Removed RouterCore.getParsedLocationHref() and RouterCore.clearExpiredCache(), with no replacement β€” expired cache entries are now reconciled automatically as part of match commit.
    • Removed RouterCore.latestLoadPromise and RouterCore.beforeLoad(), with no replacement.
    • RouterCore.commitLocationPromise and RouterCore.pendingBuiltLocation have been replaced by the internal _commitPromise and _pendingLocation fields.
    • Removed the exported GetMatchFn and UpdateMatchFn types, along with the methods they typed.
    • Removed the standalone getMatchedRoutes() export from @tanstack/router-core β€” use the router.getMatchedRoutes() instance method instead.
    • RouterCore.loadRouteChunk() no longer accepts an array of component types as its second argument. One-argument usage is unchanged; the optional second argument is now 'errorComponent', 'notFoundComponent', or false for internal boundary loading.
    • Removed Redirect.redirectHandled, which was internal redirect bookkeeping.
    • MatchRoutesOpts.preload and MatchRoutesOpts.dest have been removed.
    • StartTransitionFn is now (fn, expected) => Promise<boolean> (previously (fn) => void). This only affects custom framework adapters that implement startTransition.
  • Updated dependencies [45c4ad8]:

    • @tanstack/router-core@1.171.16

1.170.18

Patch Changes

  • Updated dependencies [e2dd204]:
    • @tanstack/router-core@1.171.15

1.170.17

Patch Changes

  • Updated dependencies [9809a06]:
    • @tanstack/router-core@1.171.14

1.170.16

Patch Changes

  • #7584 41e7a24 - Remove unnecessary setTimeout from Match components

1.170.15

Patch Changes

  • Updated dependencies [776d8ef]:
    • @tanstack/router-core@1.171.13

1.170.14

Patch Changes

  • Updated dependencies [df1076c]:
    • @tanstack/router-core@1.171.12

1.170.13

Patch Changes

  • #7555 ac10815 - Fix search middleware composition so retainSearchParams does not restore search params that a downstream stripSearchParams removed.

  • Updated dependencies [ac10815]:

    • @tanstack/router-core@1.171.11

1.170.12

Patch Changes

1.170.11

Patch Changes

  • Updated dependencies [b4cd5af]:
    • @tanstack/router-core@1.171.9

1.170.10

Patch Changes

  • Updated dependencies [2f53749]:
    • @tanstack/router-core@1.171.8

1.170.9

Patch Changes

1.170.8

Patch Changes

  • Add support for Rsbuild client output formats, including module output by default and IIFE output for classic script environments. (#7477)

    Client entry scripts and preloads are now represented as root route manifest assets, script preloads follow the manifest script format, and script asset cross-origin configuration uses the script key. The transformAssets script callback context now exposes only kind: 'script' and url, keeping script format handling internal to manifest rendering.

  • Updated dependencies [51a97a1]:

    • @tanstack/router-core@1.171.6

1.170.7

Patch Changes

  • Updated dependencies [5268ba4]:
    • @tanstack/router-core@1.171.5

1.170.6

Patch Changes

  • Fix hash navigation being overridden by stale scroll restoration entries. (#7447)

  • Updated dependencies [0300f87, 0300f87]:

    • @tanstack/router-core@1.171.4

1.170.5

Patch Changes

  • Updated dependencies [5fa9e55]:
    • @tanstack/router-core@1.171.3

1.170.4

Patch Changes

  • Updated dependencies [b60eb36]:
    • @tanstack/router-core@1.171.2

1.170.3

Patch Changes

  • Updated dependencies [d9cf933]:
    • @tanstack/router-core@1.171.1

1.170.2

Patch Changes

  • Updated dependencies [d533f87]:
    • @tanstack/router-core@1.171.0

1.170.1

Patch Changes

  • Updated dependencies [2387a2e]:
    • @tanstack/router-core@1.170.1

1.170.0

Minor Changes

  • Clean minor bump, fresh start (#7395)

Patch Changes

  • Updated dependencies [b1c061a, 201e150]:
    • @tanstack/router-core@1.170.0
    • @tanstack/history@1.162.0

1.169.2

Patch Changes

  • Updated dependencies [35e88f0]:
    • @tanstack/router-core@1.169.2

1.169.1

Patch Changes

  • Updated dependencies [4a1e63f]:
    • @tanstack/router-core@1.169.1

1.169.0

Minor Changes

  • Allow params.parse to experimentally return false to skip an incoming route candidate during path matching. Thrown parse errors still surface on the selected match instead of falling through, and outgoing typed route-template links continue to use exact route lookup followed by params.stringify for URL generation. (#7263)

Patch Changes

  • Updated dependencies [c992495]:
    • @tanstack/router-core@1.169.0

1.168.26

Patch Changes

  • Updated dependencies [b5c4183]:
    • @tanstack/router-core@1.168.18

1.168.25

Patch Changes

  • Updated dependencies [493148b]:
    • @tanstack/router-core@1.168.17

1.168.24

Patch Changes

  • Fix hydration mismatch for ssr='data-only' with pendingComponent (#7266)

1.168.23

Patch Changes

  • Fix for useLoaderData sometimes going undefined (#7265)

  • Fix streaming when using Await component (#7264)

1.168.22

Patch Changes

  • fix server middleware type in solid-router (#7260)

  • Enhanced internal tag comparison logic to optimize stylesheet persistence during route navigation. (#7250)

1.168.21

Patch Changes

  • Add TanStack Start inline CSS manifest support for SSR so route styles can be embedded in the HTML response and hydrated without duplicate stylesheet links. (#7253)

  • Updated dependencies [4d864ee]:

    • @tanstack/router-core@1.168.16

1.168.20

Patch Changes

  • fix: use keyed Show in Outlet to fix child route rendering with useQuery (#7204)

1.168.19

Patch Changes

  • Updated dependencies [16f6892]:
    • @tanstack/router-core@1.168.15

1.168.18

Patch Changes

  • Fix route file transforms to preserve route ID quoting, handle more exported Route patterns, and avoid incorrect import rewrites in edge cases. (#7167)

    Improve transform robustness with clearer route-call detection, safer import removal, and expanded test coverage for quote preservation, constructor swaps, and unsupported route definitions.

1.168.17

Patch Changes

  • Updated dependencies [0e2c900]:
    • @tanstack/router-core@1.168.14

1.168.16

Patch Changes

  • Updated dependencies [812792f]:
    • @tanstack/router-core@1.168.13

1.168.15

Patch Changes

  • Updated dependencies [8ec9ca9]:
    • @tanstack/router-core@1.168.12

1.168.14

Patch Changes

  • shorten internal non-minifiable store names for byte shaving (#7152)

  • Updated dependencies [6355bb7]:

    • @tanstack/router-core@1.168.11

1.168.13

Patch Changes

  • migrate createStore > createAtom for simpler API (#7150)

  • Updated dependencies [459057c]:

    • @tanstack/router-core@1.168.10

1.168.12

Patch Changes

  • Fix MatchRoute child callback param inference to resolve params from the target to route instead of the route path key across React, Solid, and Vue adapters. (#7139)

1.168.11

Patch Changes

  • Fix redirected pending route transitions so lazy target routes can finish loading without stale redirected matches causing render errors. (#7137)

1.168.10

Patch Changes

  • Fix Link to keep internal routing props like preloadIntentProximity, from, and unsafeRelative from leaking to rendered DOM elements across React, Solid, and Vue. (#7138)

1.168.9

Patch Changes

  • Preserve component-thrown notFound() errors through framework error boundaries so route notFoundComponent handlers render without requiring an explicit routeId. (#7077)

  • Updated dependencies [796406d]:

    • @tanstack/router-core@1.168.9

1.168.8

Patch Changes

  • Updated dependencies [2d1ec86]:
    • @tanstack/router-core@1.168.8

1.168.7

Patch Changes

  • Updated dependencies [6ee0e79]:
    • @tanstack/router-core@1.168.7

1.168.6

Patch Changes

  • Updated dependencies [42c3f3b]:
    • @tanstack/router-core@1.168.6

1.168.5

Patch Changes

  • fix: scroll restoration without throttling (#7042)

  • Updated dependencies [cf5f554]:

    • @tanstack/router-core@1.168.5

1.168.4

Patch Changes

  • Updated dependencies [71a8b68]:
    • @tanstack/router-core@1.168.4

1.168.3

Patch Changes

  • feat: transformAssets (#7023)

  • Updated dependencies [d81d21a]:

    • @tanstack/router-core@1.168.3

1.168.2

Patch Changes

  • Replace tiny-invariant and tiny-warning with in-house solution for bundle-size (#7007)

  • Updated dependencies [c9e1855]:

    • @tanstack/router-core@1.168.2

1.168.1

Patch Changes

  • Updated dependencies [91cc628]:
    • @tanstack/router-core@1.168.1

1.168.0

Minor Changes

  • remove pendingMatches, cachedMatches (#6704) move to signal-based reactivity solid uses its own native signals

Patch Changes

  • Updated dependencies [0545239]:
    • @tanstack/router-core@1.168.0

1.167.5

Patch Changes

  • Updated dependencies [5ff4f0b]:
    • @tanstack/router-core@1.167.5

1.167.4

Patch Changes

  • Add @tanstack/intent AI agent skills and CLI entry points for Router and Start packages (#6866)

  • Updated dependencies [940151c]:

    • @tanstack/router-core@1.167.4

1.167.3

Patch Changes

  • Updated dependencies [32fcba7]:
    • @tanstack/router-core@1.167.3

1.167.2

Patch Changes

  • build: update to vite-config 5.x (rolldown) (#6926)

  • Updated dependencies [838b0eb]:

    • @tanstack/history@1.161.6
    • @tanstack/router-core@1.167.2

1.167.1

Patch Changes

  • fix: build with @tanstack/vite-config 0.4.3 (#6923)

  • Updated dependencies [ef9b241]:

    • @tanstack/router-core@1.167.1
    • @tanstack/history@1.161.5

1.167.0

Minor Changes

  • feat: add staleReloadMode (#6921)

Patch Changes

  • Updated dependencies [6f297a2]:
    • @tanstack/router-core@1.167.0