feat: Reset form programmatically #14779
Open
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.
fixes #14754
fixes #14210
fixes #14787
Implements a
form.reset()method that clears the form values, issues, result, submitted, and touched states. In addition, the dev is provided options to not reset certain parts, and the ability to reset the form to new values.Includes SSR support, so the dev could also use
form.reset({ values: { ... } })in the script block instead ofform.fields.set({ ... })if they wanted to. One advantage is that it allows aDeepPartial<Input>type, instead of requiring the whole object. Unlike.set()this method is only for the base path.Demo
It does provide an alternative solution to this issue too:
When navigating to a new page and back on the client, the values (
input),issues, andresultare not reset. Looking into this, I see that the instance is only deleted on submit if the form has akeyfrom.for(key). This PR would give developers the ability to reset without using.for().Please don't delete this checklist! Before submitting the PR, please make sure you do the following:
Tests
pnpm testand lint the project withpnpm lintandpnpm checkChangesets
pnpm changesetand following the prompts. Changesets that add features should beminorand those that fix bugs should bepatch. Please prefix changeset messages withfeat:,fix:, orchore:.Edits