refine icon indicating copy to clipboard operation
refine copied to clipboard

feat: add built-in support for TanStack Router (#6897)

Open Sri-Akshat5 opened this issue 4 months ago • 7 comments

This pull request adds built-in support for the TanStack Router in the Refine framework. It includes the implementation of a new package, @refinedev/tanstack-router, which provides the RouterBindings for seamless integration.

Key Features • RouterBindings Implementation: New package with go, back, parse, and Link functions. • Comprehensive Tests: Includes tests for router bindings functionality. • Example Application: A demonstration application showing TanStack Router integration. • Type-Safe Routing: Supports built-in data fetching and caching. • Modern Search Parameter Handling: Includes validation for easy configuration. • Seamless Integration: Works as a drop-in replacement for other Refine router providers.

Checklist Please ensure your pull request fulfills the following requirements: The commit message follows our guidelines (commit convention). Related issue(s) are linked—Closes #6897. Tests for the changes have been added. Documentation has been updated. Changesets have been added (creating a changeset).

Current Behavior Currently, Refine doesn't include built-in support for TanStack Router.

New Behavior The new implementation allows using the TanStack Router with Refine, providing advanced features like type-safe routing and modern search parameter handling.

Notes for Reviewers Feel free to reach out if you have any questions about the implementation details or need further clarifications.

Sri-Akshat5 avatar Aug 05 '25 11:08 Sri-Akshat5

⚠️ No Changeset found

Latest commit: 1cd1b48e57877a4741384561411184f1ee02380d

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

changeset-bot[bot] avatar Aug 05 '25 11:08 changeset-bot[bot]

Deploy Preview for refine-doc-live-previews failed.

Built without sensitive environment variables

Name Link
Latest commit 1cd1b48e57877a4741384561411184f1ee02380d
Latest deploy log https://app.netlify.com/projects/refine-doc-live-previews/deploys/68b6baa91ef5e900083a1845

netlify[bot] avatar Aug 05 '25 11:08 netlify[bot]

There should probably be additional review on this as there are signs of LLM generation involved.

pcfreak30 avatar Aug 05 '25 14:08 pcfreak30

At first glance, the PR looks great, thank you! However, the core team is busy with onging tasks (Refine v5 and Refine AI). We’ll be able to review this PR in about 2 weeks. We’re aiming to release it by the end of next month. Thanks again!

alicanerdurmaz avatar Aug 06 '25 11:08 alicanerdurmaz

Hello @Sri-Akshat5 thanks for the PR. We'll review it after releasing Refine 5.

Can you also add the necessary documentation? You can see how other router providers does it.

BatuhanW avatar Sep 02 '25 07:09 BatuhanW

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

stale[bot] avatar Nov 01 '25 10:11 stale[bot]

Any updates?

yf-hk avatar Nov 01 '25 14:11 yf-hk