formState: Object
This object contains information about the entire form state. It helps you to keep on track with the user's interaction with your form application.
Return
Name | Type | Description |
---|---|---|
isDirty | boolean | Set to
|
dirtyFields | object | An object with the user-modified fields. Make sure to provide all inputs' defaultValues via useForm, so the library can compare against the Dirty fields will not represent as |
touchedFields | object | An object containing all the inputs the user has interacted with. |
isSubmitted | boolean | Set to true after the form is submitted. Will remain true until the reset method is invoked. |
isSubmitSuccessful | boolean | Indicate the form was successfully submitted without any |
isSubmitting | boolean | true if the form is currently being submitted. false otherwise. |
submitCount | number | Number of times the form was submitted. |
isValid | boolean | Set to true if the form doesn't have any errors.Note: |
isValidating | boolean | Set to true during validation. |
errors | object | An object with field errors. There is also an ErrorMessage component to retrieve error message easily. |
Rules
formState
is wrapped with a Proxy to improve render performance and skip extra logic if specific state is not subscribed to. Therefore make sure you invoke or read it before arender
in order to enable the state update.formState
is updated in batch. If you want to subscribe toformState
viauseEffect
, make sure that you place the entireformState
in the optional array.Pay attention to the logical operator when subscription to
formState
.
Examples
Video
The following video will explain in detail different form states.
Thank you for your support
If you find React Hook Form to be useful in your project, please consider to star and support it.