Skip to content

fix: update validatingFields field in docs #1142

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 3, 2025
Merged

fix: update validatingFields field in docs #1142

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/components/FormStateApi.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ export const FormStateApi = ({
<code>validatingFields</code>
</td>
<td>
<code className={typographyStyles.typeText}>boolean</code>
<code className={typographyStyles.typeText}>object</code>
</td>
<td>{(api || API).formState.validatingFields}</td>
</tr>
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/useform/formstate.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ This object contains information about the entire form state. It helps you to ke
| `submitCount` | <TypeText>number</TypeText> | Number of times the form was submitted. |
| `isValid` | <TypeText>boolean</TypeText> | Set to `true` if the form doesn't have any errors.<ul><li>`setError` has no effect on `isValid` `formState`, `isValid` will always derived via the entire form validation result.</li></ul> |
| `isValidating` | <TypeText>boolean</TypeText> | Set to `true` during validation. |
| `validatingFields` | <TypeText>boolean</TypeText> | Capture fields which are getting async validation. |
| `validatingFields` | <TypeText>object</TypeText> | Capture fields which are getting async validation. |
| `errors` | <TypeText>object</TypeText> | An object with field errors. There is also an [ErrorMessage](/docs/useformstate/errormessage) component to retrieve error message easily. |
| `disabled` | <TypeText>boolean</TypeText> | Set to true if the form is disabled via the disabled prop in [useForm](/docs/useform). |
| `isReady` | <TypeText>boolean</TypeText> | Set to true when `formState` subscription setup is ready. <CodeArea withOutCopy rawData={`const {\n setValue,\n formState: { isReady }\n} = useForm();\n\nuseEffect(() => isReady && setValue('test', 'data'), [isReady])`}/> |
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/useformstate.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ This custom hook allows you to subscribe to each form state, and isolate the re-
| `submitCount` | <TypeText>number</TypeText> | Number of times the form was submitted. |
| `isValid` | <TypeText>boolean</TypeText> | Set to `true` if the form doesn't have any errors.<ul><li>`setError` has no effect on `isValid` `formState`, `isValid` will always derived via the entire form validation result.</li></ul> |
| `isValidating` | <TypeText>boolean</TypeText> | Set to `true` during validation. |
| `validatingFields` | <TypeText>boolean</TypeText> | Capture fields which are getting async validation. |
| `validatingFields` | <TypeText>object</TypeText> | Capture fields which are getting async validation. |
| `errors` | <TypeText>object</TypeText> | An object with field errors. There is also an [ErrorMessage](/docs/useformstate/errormessage) component to retrieve error message easily. |
| `disabled` | <TypeText>boolean</TypeText> | Set to true if the form is disabled via the disabled prop in [useForm](/docs/useform). |

Expand Down