fix(react-hook-form): reset form state on query data change to fix useFieldArray on revisit#7452
Open
devavijha wants to merge 1 commit into
Open
Conversation
…eFieldArray on revisit
When navigating back to an edit form in a SPA, useFieldArray.fields was empty
on every visit after the first. The field-by-field setValue approach relied on
syncedFieldsRef which accumulated paths across navigations, causing the guard
to skip re-populating fields registered by useFieldArray on re-mount.
Replace applyValuesToFields with reset(data, { keepDirtyValues: true }). This
re-initialises the full form state including field arrays on each new query
result. The keepDirtyValues option preserves user edits that are already in
progress.
Fixes refinedev#7401
🦋 Changeset detectedLatest commit: 8415faa The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Problem
When navigating away from an edit form and returning to it within a SPA,
useFieldArray.fieldsis empty on every visit after the first. The issue is inpackages/react-hook-form/src/useForm/index.ts.The existing approach calls
applyValuesToFields(getRegisteredFields(), data, false)which usessetValueon individual field paths and tracks synced paths insyncedFieldsRef. On re-visit:syncedFieldsRefaccumulates paths across mount/unmount cyclesuseFieldArrayare not present in the set when the effect runs again on the second visituseFieldArray.fieldsstays emptyMinimal reproduction is in the issue: https://codesandbox.io/p/sandbox/t6pxft
Fix
Replace
applyValuesToFields(getRegisteredFields(), data, false)withreset(data, { keepDirtyValues: true }).The
resetAPI from react-hook-form re-initialises the entire form state, including all field arrays, on each new query result. ThekeepDirtyValuesoption ensures that any in-progress user edits are not discarded.Changes:
resetto the destructured result fromuseHookFormapplyValuesToFieldscall insideapplyQueryValueswithreset(data, { keepDirtyValues: true })Closes #7401