Skip to content

fix(react-router,solid-router): top-level Matches should use pendingComponent on root route #5495

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Oct 17, 2025
Merged

fix(react-router,solid-router): top-level Matches should use pendingComponent on root route #5495

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
15841e3
fix: the top level Matches component should use the pendingComponent …
TkDodo Oct 16, 2025
dd78c82
fix for solid
TkDodo Oct 16, 2025
692fed2
tests
TkDodo Oct 16, 2025
955e61a
chore: auto-import
TkDodo Oct 16, 2025
051390a
chore: scope tests
TkDodo Oct 16, 2025
13d45c1
maybe like this?
TkDodo Oct 16, 2025
74a3835
ref: use rootRouteId
TkDodo Oct 17, 2025
6fc6e2b
ref: switch to data-testId
TkDodo Oct 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions packages/react-router/src/Matches.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import type {
ValidateSelected,
} from './structuralSharing'
import type {
AnyRoute,
AnyRouter,
DeepPartial,
Expand,
Expand Down Expand Up @@ -41,10 +42,12 @@ declare module '@tanstack/router-core' {

export function Matches() {
const router = useRouter()
const rootRoute: AnyRoute = router.routesById['__root__']
Copy link
Contributor Author

@TkDodo TkDodo Oct 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we need to be defensive here and type this as AnyRoute | undefined. I think a __root__ route must always exist ...

Copy link
Contributor

@schiller-manuel schiller-manuel Oct 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please use rootRouteId from @tanstack/router-core instead of __root__

Copy link
Member

@SeanCassiere SeanCassiere Oct 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

and to answer your question, the answer is probably not, since a root route must always be present, but if it helps silence typescript then a ! assertion or a throw Error should be fine.

Copy link
Contributor Author

@TkDodo TkDodo Oct 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done: 74a3835


const pendingElement = router.options.defaultPendingComponent ? (
<router.options.defaultPendingComponent />
) : null
const PendingComponent =
rootRoute.options.pendingComponent ?? router.options.defaultPendingComponent

const pendingElement = PendingComponent ? <PendingComponent /> : null

// Do not render a root Suspense during SSR or hydrating from SSR
const ResolvedSuspense =
Expand Down
13 changes: 8 additions & 5 deletions packages/solid-router/src/Matches.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import * as Solid from 'solid-js'
import warning from 'tiny-warning'
import * as React from 'react'
import { CatchBoundary, ErrorComponent } from './CatchBoundary'
import { useRouterState } from './useRouterState'
import { useRouter } from './useRouter'
Expand All @@ -8,6 +9,7 @@ import { matchContext } from './matchContext'
import { Match } from './Match'
import { SafeFragment } from './SafeFragment'
import type {
AnyRoute,
AnyRouter,
DeepPartial,
Expand,
Expand Down Expand Up @@ -44,16 +46,17 @@ export function Matches() {
? SafeFragment
: Solid.Suspense

const rootRoute: () => AnyRoute = () => router.routesById['__root__']
const PendingComponent =
rootRoute().options.pendingComponent ??
router.options.defaultPendingComponent

const OptionalWrapper = router.options.InnerWrap || SafeFragment

return (
<OptionalWrapper>
<ResolvedSuspense
fallback={
router.options.defaultPendingComponent ? (
<router.options.defaultPendingComponent />
) : null
}
fallback={PendingComponent ? <PendingComponent /> : null}
>
{!router.isServer && <Transitioner />}
<MatchesInner />
Expand Down
Loading