docs: add keepIsSubmitSuccessful to reset options table#1202
Merged
bluebill1049 merged 3 commits intoreact-hook-form:masterfrom Apr 19, 2026
Merged
Conversation
Contributor
|
@dfedoryshchev is attempting to deploy a commit to the BEEKAI OSS Team on Vercel. A member of the Team first needs to authorize it. |
✅ Deploy Preview for sage-cassata-31d224 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
bluebill1049
approved these changes
Apr 19, 2026
There was a problem hiding this comment.
Pull request overview
Updates the reset() API documentation to include the missing keepIsSubmitSuccessful option so the docs match the behavior available in react-hook-form.
Changes:
- Add a new
keepIsSubmitSuccessfulrow to thereset()options table. - Reformat the markdown table alignment (Prettier reflow).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| | `values` | | <TypeText>object \| (values: Object) => Object </TypeText> | An optional object to reset form values, and it's recommended to provide the **entire** defaultValues when supplied. | | ||
| | `options` | `keepErrors` | <TypeText>boolean</TypeText> | All errors will remain. This will not guarantee with further user actions. | | ||
| | | `keepDirty` | <TypeText>boolean</TypeText> | `DirtyFields` form state will remain, and `isDirty` will temporarily remain as the current state until further user's action.<br/><br/>**Important:** this keep option doesn't reflect form input values but only dirty fields form state. | | ||
| | | `keepDirtyValues` | <TypeText>boolean</TypeText> | `DirtyFields` and `isDirty` will remained, and only none dirty fields will be updated to the latest rest value. [Check out the example.](https://codesandbox.io/s/react-keepdirtyvalues-o8to91)<br/><br/>**Important:** formState `dirtyFields` will need to be subscribed. | |
| | `values` | | <TypeText>object \| (values: Object) => Object </TypeText> | An optional object to reset form values, and it's recommended to provide the **entire** defaultValues when supplied. | | ||
| | `options` | `keepErrors` | <TypeText>boolean</TypeText> | All errors will remain. This will not guarantee with further user actions. | | ||
| | | `keepDirty` | <TypeText>boolean</TypeText> | `DirtyFields` form state will remain, and `isDirty` will temporarily remain as the current state until further user's action.<br/><br/>**Important:** this keep option doesn't reflect form input values but only dirty fields form state. | | ||
| | | `keepDirtyValues` | <TypeText>boolean</TypeText> | `DirtyFields` and `isDirty` will remained, and only none dirty fields will be updated to the latest rest value. [Check out the example.](https://codesandbox.io/s/react-keepdirtyvalues-o8to91)<br/><br/>**Important:** formState `dirtyFields` will need to be subscribed. | |
| | `values` | | <TypeText>object \| (values: Object) => Object </TypeText> | An optional object to reset form values, and it's recommended to provide the **entire** defaultValues when supplied. | | ||
| | `options` | `keepErrors` | <TypeText>boolean</TypeText> | All errors will remain. This will not guarantee with further user actions. | | ||
| | | `keepDirty` | <TypeText>boolean</TypeText> | `DirtyFields` form state will remain, and `isDirty` will temporarily remain as the current state until further user's action.<br/><br/>**Important:** this keep option doesn't reflect form input values but only dirty fields form state. | | ||
| | | `keepDirtyValues` | <TypeText>boolean</TypeText> | `DirtyFields` and `isDirty` will remained, and only none dirty fields will be updated to the latest rest value. [Check out the example.](https://codesandbox.io/s/react-keepdirtyvalues-o8to91)<br/><br/>**Important:** formState `dirtyFields` will need to be subscribed. | |
| | | `keepDefaultValues` | <TypeText>boolean</TypeText> | Keep the same defaultValues which are initialised via `useForm`.<ul><li>`isDirty` will be checked again: it is set to be the result of the comparison of any new values provided against the original `defaultValues`.</li> <li>`dirtyFields` will be updated again if values are provided: it is set to be result of the comparison between the new values provided against the original `defaultValues`.</li></ul> | | ||
| | | `keepIsSubmitted` | <TypeText>boolean</TypeText> | `isSubmitted` state will be unchanged. | | ||
| | | `keepIsSubmitSuccessful` | <TypeText>boolean</TypeText> | `isSubmitSuccessful` state will be unchanged. | | ||
| | | `keepTouched` | <TypeText>boolean</TypeText> | `isTouched` state will be unchanged. | |
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
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.
Closes #1050.
Adds a missing entry for the
keepIsSubmitSuccessfuloption in thereset()props table ondocs/useform/reset.The flag was added to the main repo in react-hook-form#9640 (commit
5dbe834) but never documented here.Commits:
docs: add keepIsSubmitSuccessful to reset options table- the +1 row additionchore: prettier format reset.mdx table alignment- auto-format reflow fromprettier --writeafter the new row introduced a wider column