Fix react-admin requires custom routers to be data routers #9723
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The reimplentation of the `warnWhenUnsavedChanges` feature with react-router's `useBlocker` created a breaking change. As `useBlocker` throws an error when not called in a DataRouter, and since we cannot call hooks conditionally, this meant that react-admin MUST be used inside a data router. By moving the `warnWhenUnsavedChanges` logic from the `useAugmentedForm` hook to a custom component, we can now call the component conditionally - and avoid calling it when not inside a data router.
fzaninotto
commented
Mar 14, 2024
| import { | ||
| FormProvider, | ||
| FieldValues, | ||
| UseFormProps, | ||
| SubmitHandler, | ||
| } from 'react-hook-form'; | ||
| import { | ||
| UNSAFE_DataRouterContext, |
There was a problem hiding this comment.
Unfortunately react-router doesn't expose the DataRouterContext, see remix-run/react-router#11347
slax57
reviewed
Mar 15, 2024
docs/AccordionForm.md
Outdated
| @@ -351,7 +351,7 @@ export const TagEdit = () => ( | |||
| ); | |||
| ``` | |||
|
|
|||
| **Warning**: This feature only works if you have a dependency on react-router 6.3.0 **at most**. The react-router team disabled this possibility in react-router 6.4, so `warnWhenUnsavedChanges` will silently fail with react-router 6.4 or later. | |||
| **Note**: Due to limitations in react-router, this feature only works if you use the default router provided by react-admin, or if you use a Data Router. | |||
There was a problem hiding this comment.
nitpick: I'd add a link to react-router's documentation for those not knowing what a Data Router is
Co-authored-by: Jean-Baptiste Kaiser <jb@marmelab.com>
djhi
approved these changes
Mar 15, 2024
slax57
approved these changes
Mar 15, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The reimplentation of the
warnWhenUnsavedChangesfeature with react-router'suseBlockerin #9657 created a breaking change. AsuseBlockerthrows an error when not called in a DataRouter, and since we cannot call hooks conditionally, this meant that react-admin MUST be used inside a data router.By moving the
warnWhenUnsavedChangeslogic from theuseAugmentedFormhook to a custom component, we can now call the component conditionally - and avoid calling it when not inside a data router.