feat(react-router): generic router history

[matthiasschwarz]

Changes type of history in router to a generic type parameter to support advanced use cases like providing an own implementation of a RouterHistory or to enchance a specific RouterHistory with additional features.

[nx-cloud]

☁️ Nx Cloud Report

CI is running/has finished running commands for commit cd3787e. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution

---

🟥 Failed Commands
nx affected --targets=test:eslint,test:unit,test:e2e,test:types,test:build,build --parallel=3

✅ Successfully ran 1 target

• nx run-many --target=build --exclude=examples/** --exclude=e2e/**

---

Sent with 💌 from NxCloud.

[pkg-pr-new]

Open in Stackblitz

More templates

• tanstack-router-react-example-authenticated-routes
• tanstack-router-react-example-basic
• tanstack-router-react-example-basic-default-search-params
• tanstack-router-react-example-basic-file-based
• tanstack-router-react-example-basic-file-based-codesplitting
• tanstack-router-react-example-react-query
• tanstack-router-react-example-basic-react-query-file-based
• tanstack-router-react-example-basic-ssr-file-based
• tanstack-router-react-example-basic-ssr-streaming-file-based
• tanstack-router-react-example-basic-virtual-file-based
• tanstack-router-react-example-basic-virtual-inside-file-based
• tanstack-router-react-example-deferred-data
• tanstack-router-react-example-kitchen-sink
• tanstack-router-react-example-kitchen-sink-file-based
• tanstack-router-react-example-kitchen-sink-react-query
• tanstack-router-react-example-kitchen-sink-react-query-file-based
• tanstack-router-react-example-large-file-based
• tanstack-router-react-example-location-masking
• tanstack-router-react-example-navigation-blocking
• tanstack-router-react-example-quickstart
• tanstack-router-react-example-quickstart-esbuild-file-based
• tanstack-router-react-example-quickstart-file-based
• tanstack-router-react-example-quickstart-rspack-file-based
• tanstack-router-react-example-quickstart-webpack-file-based
• router-monorepo-react-query
• router-mono-simple
• tanstack-router-react-example-scroll-restoration
• tanstack-search-validator-adapters
• tanstack-start-example-basic
• tanstack-start-example-basic-auth
• tanstack-start-example-basic-react-query
• tanstack-start-example-basic-rsc
• tanstack-start-example-clerk-basic
• tanstack-start-example-convex-trellaux
• tanstack-start-example-counter
• tanstack-start-example-supabase-basic
• tanstack-start-example-trellaux
• tanstack-router-react-example-with-framer-motion
• tanstack-router-react-example-with-trpc
• tanstack-router-react-example-with-trpc-react-query

@tanstack/arktype-adapter

pnpm add https://pkg.pr.new/@tanstack/arktype-adapter@2782

@tanstack/create-router

pnpm add https://pkg.pr.new/@tanstack/create-router@2782

@tanstack/history

pnpm add https://pkg.pr.new/@tanstack/history@2782

@tanstack/eslint-plugin-router

pnpm add https://pkg.pr.new/@tanstack/eslint-plugin-router@2782

@tanstack/react-cross-context

pnpm add https://pkg.pr.new/@tanstack/react-cross-context@2782

@tanstack/react-router

pnpm add https://pkg.pr.new/@tanstack/react-router@2782

@tanstack/react-router-with-query

pnpm add https://pkg.pr.new/@tanstack/react-router-with-query@2782

@tanstack/router-cli

pnpm add https://pkg.pr.new/@tanstack/router-cli@2782

@tanstack/router-devtools

pnpm add https://pkg.pr.new/@tanstack/router-devtools@2782

@tanstack/router-generator

pnpm add https://pkg.pr.new/@tanstack/router-generator@2782

@tanstack/router-plugin

pnpm add https://pkg.pr.new/@tanstack/router-plugin@2782

@tanstack/router-vite-plugin

pnpm add https://pkg.pr.new/@tanstack/router-vite-plugin@2782

@tanstack/start

pnpm add https://pkg.pr.new/@tanstack/start@2782

@tanstack/start-vite-plugin

pnpm add https://pkg.pr.new/@tanstack/start-vite-plugin@2782

@tanstack/valibot-adapter

pnpm add https://pkg.pr.new/@tanstack/valibot-adapter@2782

@tanstack/virtual-file-routes

pnpm add https://pkg.pr.new/@tanstack/virtual-file-routes@2782

@tanstack/zod-adapter

pnpm add https://pkg.pr.new/@tanstack/zod-adapter@2782

commit: cd3787e

[schiller-manuel]

thanks for the contibution!

please have a look at the build failures and fix those.
please also add a type test (e.g. in packages/react-router/tests/router.test-d.tsx)

[matthiasschwarz]

thanks for the contibution!

please have a look at the build failures and fix those. please also add a type test (e.g. in packages/react-router/tests/router.test-d.tsx)

• Fixed the build issues of the monorepo examples. This is a breaking change though since it was required to add @tanstack/history as dependency for the build typescript declarations of the router packages. I'm not sure if this is the correct way to handle that issue.
• The e2e tasks that are still failing are running successfully on my machine.
• Added tests for the history type of the router.

[schiller-manuel]

@chorobin please have a look about the type changes