How to ensure a pathname variable is part of my routeTree ?

[seedy]

I have a use-case where a global component shows a "go back" link.

I'd like to configure the target of this go back link per Route.

Instead of moving the component from a global layout down to each Route, I'd like to use the staticData prop on each Route.

To ensure type-safety, I'd like to somehow - on the type level, function level, or even component level - ensure my pathname is part of my routeTree.

I already tried typing inside StaticDataRouteOption, but I'm blocked due to circular references :

  interface StaticDataRouteOption {
    i18nKeyTitle?: string;
    backTo?: RoutePaths<typeof routeTree>;
  }

I was also thinking about a hook which would validate a pathname as being part of my routeTree :

const useValidatePathname = () => {
  const {routesByPath} = useRouter();

 return (pathname: string) => routesByPath[pathname] !== undefined
}

What do you think ?

[bisak]

I have the same question, did you figure this out?

[mmospanenko]

Trying to understand the same, very unclear...

[mmospanenko]

try this as a type, works for to, from

import type { RegisteredRouter, RouteIds, RoutePaths } from '@tanstack/react-router';

export type RoutePath = RoutePaths<RegisteredRouter['routeTree']>;
export type RouteId = RouteIds<RegisteredRouter['routeTree']>;

[kingmalitha]

Cannot find name 'RoutePaths'. From Where did you import RouthPaths ??
version: @tanstack/react-router 1.114.27

[mmospanenko]

Cannot find name 'RoutePaths'. From Where did you import RouthPaths ?? version: @tanstack/react-router 1.114.27

updated comment

[kingmalitha]

seems like they removed it , RoutePaths

[airtonix]

Your routeTree.gen.ts should have a generated type FileRoutesByPath.

So maybe this works ?

app/router.ts

declare module "@tanstack/react-router" {
  interface Register {
    router: ReturnType<typeof createRouter>;
  }
  interface StaticDataRouteOption {
    i18nKeyTitle?: string;
    backTo?: keyof FileRoutesByPath;
  }
}

You could also use keyof FileRoutesById, FileRouteTypes['id']