Skip to content

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

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.

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Sri-Akshat5
Copy link

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.

- Add @refinedev/tanstack-router package with RouterBindings implementation
- Implement go, back, parse, and Link functions for TanStack Router integration
- Add comprehensive tests for router bindings functionality
- Create example application demonstrating TanStack Router integration
- Support type-safe routing with built-in data fetching and caching
- Enable modern search parameter handling with validation
- Provide seamless drop-in replacement for other Refine router providers

Closes refinedev#6897
@Sri-Akshat5 Sri-Akshat5 requested a review from a team as a code owner August 5, 2025 11:03
Copy link

changeset-bot bot commented Aug 5, 2025

⚠️ No Changeset found

Latest commit: 046818e

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

Copy link

netlify bot commented Aug 5, 2025

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

Built without sensitive environment variables

Name Link
🔨 Latest commit 046818e
🔍 Latest deploy log https://app.netlify.com/projects/refine-doc-live-previews/deploys/6891e51090ddb20008d83c77

@pcfreak30
Copy link

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

@alicanerdurmaz
Copy link
Member

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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[FEAT] built-in support for Tanstack-Router
3 participants