diff --git a/examples/react/basic-file-based/src/main.tsx b/examples/react/basic-file-based/src/main.tsx index 18b1b603f8..1114f047a3 100644 --- a/examples/react/basic-file-based/src/main.tsx +++ b/examples/react/basic-file-based/src/main.tsx @@ -1,22 +1,19 @@ import React from 'react' import ReactDOM from 'react-dom/client' import { RouterProvider, createRouter } from '@tanstack/react-router' -import { routeTree } from './routeTree.gen' +import { router } from './router' // Set up a Router instance -const router = createRouter({ - routeTree, - defaultPreload: 'intent', - defaultStaleTime: 5000, -}) + +/* // Register things for typesafety declare module '@tanstack/react-router' { interface Register { router: typeof router } } - +*/ const rootElement = document.getElementById('app')! if (!rootElement.innerHTML) { diff --git a/examples/react/basic-file-based/src/router.ts b/examples/react/basic-file-based/src/router.ts new file mode 100644 index 0000000000..751e808952 --- /dev/null +++ b/examples/react/basic-file-based/src/router.ts @@ -0,0 +1,24 @@ +import { + createLink, + createRouter, + useNavigate as tsrUseNavigate, +} from '@tanstack/react-router' +import { routeTree } from './routeTree.gen' +import type { AnyRouter, FromPathOption } from '@tanstack/react-router' + +export const router = createRouter({ + routeTree, + defaultPreload: 'intent', + defaultStaleTime: 5000, +}) + +export const Link = createLink('a', router) +// should be provided by @tanstack/react-router +function createUseNavigate(router: TRouter) { + return (_defaultOpts?: { + from?: FromPathOption + }) => { + return tsrUseNavigate(_defaultOpts) + } +} +export const useNavigate = createUseNavigate(router) diff --git a/examples/react/basic-file-based/src/routes/__root.tsx b/examples/react/basic-file-based/src/routes/__root.tsx index 6b57d1e239..0a3c17859f 100644 --- a/examples/react/basic-file-based/src/routes/__root.tsx +++ b/examples/react/basic-file-based/src/routes/__root.tsx @@ -1,6 +1,7 @@ import * as React from 'react' -import { Link, Outlet, createRootRoute } from '@tanstack/react-router' +import { Outlet, createRootRoute } from '@tanstack/react-router' import { TanStackRouterDevtools } from '@tanstack/router-devtools' +import { Link } from '../router' export const Route = createRootRoute({ component: RootComponent, diff --git a/examples/react/basic-file-based/src/routes/_layout/_layout-2.tsx b/examples/react/basic-file-based/src/routes/_layout/_layout-2.tsx index 3b7dbf2903..905a78cc9a 100644 --- a/examples/react/basic-file-based/src/routes/_layout/_layout-2.tsx +++ b/examples/react/basic-file-based/src/routes/_layout/_layout-2.tsx @@ -1,4 +1,5 @@ -import { Link, Outlet, createFileRoute } from '@tanstack/react-router' +import { Outlet, createFileRoute } from '@tanstack/react-router' +import { Link } from '../../router' export const Route = createFileRoute('/_layout/_layout-2')({ component: LayoutComponent, diff --git a/examples/react/basic-file-based/src/routes/posts.$postId.tsx b/examples/react/basic-file-based/src/routes/posts.$postId.tsx index febb02ab2f..be783a9e49 100644 --- a/examples/react/basic-file-based/src/routes/posts.$postId.tsx +++ b/examples/react/basic-file-based/src/routes/posts.$postId.tsx @@ -1,6 +1,7 @@ import * as React from 'react' import { ErrorComponent, createFileRoute } from '@tanstack/react-router' import { fetchPost } from '../posts' +import { useNavigate } from '../router' import type { ErrorComponentProps } from '@tanstack/react-router' export const Route = createFileRoute('/posts/$postId')({ @@ -18,11 +19,16 @@ export function PostErrorComponent({ error }: ErrorComponentProps) { function PostComponent() { const post = Route.useLoaderData() + const navigate = useNavigate({ from: '/posts/$postId' }) + // typing does not work for Route.useNavigate: + // const navigateFromRoute = Route.useNavigate({from: '????'}) + // navigateFromRoute({to: '?????'}) return (

{post.title}

{post.body}
+
) } diff --git a/examples/react/basic-file-based/src/routes/posts.tsx b/examples/react/basic-file-based/src/routes/posts.tsx index c7a09ed7f8..2ebd25b17d 100644 --- a/examples/react/basic-file-based/src/routes/posts.tsx +++ b/examples/react/basic-file-based/src/routes/posts.tsx @@ -1,6 +1,7 @@ import * as React from 'react' -import { Link, Outlet, createFileRoute } from '@tanstack/react-router' +import { Outlet, createFileRoute } from '@tanstack/react-router' import { fetchPosts } from '../posts' +import { Link } from '../router' export const Route = createFileRoute('/posts')({ loader: fetchPosts, diff --git a/packages/react-router/src/fileRoute.ts b/packages/react-router/src/fileRoute.ts index 3cedea12c0..e84814b411 100644 --- a/packages/react-router/src/fileRoute.ts +++ b/packages/react-router/src/fileRoute.ts @@ -21,7 +21,7 @@ import type { UpdatableRouteOptions, } from './route' import type { MakeRouteMatch } from './Matches' -import type { AnyRouter, RegisteredRouter } from './router' +import type { RegisteredRouter } from './router' import type { RouteById, RouteIds } from './routeInfo' export interface FileRoutesByPath { diff --git a/packages/react-router/src/index.tsx b/packages/react-router/src/index.tsx index 1560645c90..720a9073f6 100644 --- a/packages/react-router/src/index.tsx +++ b/packages/react-router/src/index.tsx @@ -74,6 +74,7 @@ export type { LinkProps, LinkComponent, CreateLinkProps, + FromPathOption, } from './link' export type { ParsedLocation } from './location' diff --git a/packages/react-router/src/link.tsx b/packages/react-router/src/link.tsx index 2c728e2b94..35ddfae85c 100644 --- a/packages/react-router/src/link.tsx +++ b/packages/react-router/src/link.tsx @@ -944,8 +944,10 @@ export type CreateLinkProps = LinkProps< string > -export type LinkComponent = < - TRouter extends RegisteredRouter = RegisteredRouter, +export type LinkComponent< + TComp, + TRouter extends AnyRouter = RegisteredRouter, +> = < TFrom extends string = string, TTo extends string | undefined = undefined, TMaskFrom extends string = TFrom, @@ -954,9 +956,13 @@ export type LinkComponent = < props: LinkComponentProps, ) => React.ReactElement -export function createLink( +export function createLink< + const TComp, + TRouter extends AnyRouter = RegisteredRouter, +>( Comp: Constrain ReactNode>, -): LinkComponent { + router?: TRouter, +): LinkComponent { return React.forwardRef(function CreatedLink(props, ref) { return }) as any diff --git a/packages/react-router/src/route.ts b/packages/react-router/src/route.ts index 156494b2e3..09627060c0 100644 --- a/packages/react-router/src/route.ts +++ b/packages/react-router/src/route.ts @@ -8,11 +8,11 @@ import { useSearch } from './useSearch' import { notFound } from './not-found' import { useNavigate } from './useNavigate' import { rootRouteId } from './root' +import type { NavigateOptions, ParsePathParams, ToMaskOptions } from './link' import type * as React from 'react' import type { RootRouteId } from './root' import type { UseNavigateResult } from './useNavigate' import type { MakeRouteMatch, MakeRouteMatchUnion, RouteMatch } from './Matches' -import type { NavigateOptions, ParsePathParams, ToMaskOptions } from './link' import type { ParsedLocation } from './location' import type { RouteById, RouteIds, RoutePaths } from './routeInfo' import type { AnyRouter, RegisteredRouter, Router } from './router' diff --git a/packages/react-router/src/useNavigate.tsx b/packages/react-router/src/useNavigate.tsx index a9f5025411..ee1200e694 100644 --- a/packages/react-router/src/useNavigate.tsx +++ b/packages/react-router/src/useNavigate.tsx @@ -1,11 +1,12 @@ import * as React from 'react' import { useRouter } from './useRouter' import type { FromPathOption, NavigateOptions } from './link' -import type { RoutePaths } from './routeInfo' import type { AnyRouter, RegisteredRouter } from './router' -export type UseNavigateResult = < - TRouter extends RegisteredRouter, +export type UseNavigateResult< + TDefaultFrom extends string, + TRouter extends AnyRouter = RegisteredRouter, +> = < TTo extends string | undefined, TFrom extends string = TDefaultFrom, TMaskFrom extends string = TFrom, @@ -20,7 +21,7 @@ export function useNavigate< TDefaultFrom extends string = string, >(_defaultOpts?: { from?: FromPathOption -}): UseNavigateResult { +}): UseNavigateResult { const { navigate } = useRouter() return React.useCallback( @@ -30,7 +31,7 @@ export function useNavigate< }) }, [navigate], - ) as UseNavigateResult + ) as UseNavigateResult } // NOTE: I don't know of anyone using this. It's undocumented, so let's wait until someone needs it