optimistic-gold•4h ago
Refine v5
What does refine v5 come with
2 Replies
Hi @Harsh Maur (SaaS Alerts). I'm kapa.ai, your friendly support bot. I will try to answer your question by searching through the knowledge base. :wave:
----------------------
Refine v5 introduces several significant updates and improvements, focusing on modernization, compatibility, and cleanup:
- TanStack Query v5 Support: Refine v5 migrates its core data and mutation hooks (such as
useList
, useOne
, useMany
, useCreate
, useUpdate
, etc.) to use TanStack Query v5. This includes updating callback patterns (removing onSuccess
/onError
in favor of new approaches), updating query signatures, and ensuring compatibility with the latest TanStack Query features and requirements, such as queryKey
, queryFn
, and initialPageParam
for infinite queries Refine v5: TanStack Query v5 + React 19 Support.
- React 19 Support: Peer dependencies and types are updated to support both React 18 and the upcoming React 19, ensuring forward compatibility Refine v5: TanStack Query v5 + React 19 Support.
- Deprecation Cleanup: Refine v5 removes a wide range of deprecated properties and legacy APIs. This includes:
- Replacing deprecated resource properties (like options
, canDelete
, icon
, parentName
, key
, label
, route
) with the meta
object.
- Removing legacy helper functions and modules.
- Cleaning up deprecated components (such as old LoginPage
, ReadyPage
, WelcomePage
, and Layout
).
- Updating all test suites and documentation to reflect the new API patterns Refine v5: TanStack Query v5 + React 19 Support, feat(docs): update docs of hook return types.
- UI Package Modernization: All UI integrations (Ant Design, Material UI, Mantine, Chakra UI) are updated to align with the new core patterns, including button component props, hook parameters, and resource property usage Refine v5: TanStack Query v5 + React 19 Support.
- Improved Hook Return Types: The return types and destructuring patterns for hooks like useOne
, useMany
, and useTable
have been updated for consistency and clarity. For example:
feat(docs): update docs of hook return types
- Documentation and Migration Guide: The documentation is updated to reflect all breaking changes and new patterns, and a migration guide is planned to help users upgrade from previous versions Refine v5: TanStack Query v5 + React 19 Support.
In summary, Refine v5 brings modernized dependencies (TanStack Query v5, React 19), a cleaner and more consistent API, removal of deprecated features, and improved documentation, making it ready for the next generation of React applications.
----------------------
Note: you can ask me a follow up question by @ mentioning me again :speech_balloon:
----------------------<@1229671849034780702> Kapa.ai is still learning and improving, please let me know how I did by reacting below.