Commit e8a847c

authored

fix: update validatingFields type from boolean to object in documentation (#1142)

1 parent 608d8c1 commit e8a847cCopy full SHA for e8a847c

File tree

-3

lines changed

-3

lines changed

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -183,7 +183,7 @@ export const FormStateApi = ({`
`183`	`183`	`<code>validatingFields</code>`
`184`	`184`	`</td>`
`185`	`185`	`<td>`
`186`		`- <code className={typographyStyles.typeText}>boolean</code>`
	`186`	`+ <code className={typographyStyles.typeText}>object</code>`
`187`	`187`	`</td>`
`188`	`188`	`<td>{(api \|\| API).formState.validatingFields}</td>`
`189`	`189`	`</tr>`

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ This object contains information about the entire form state. It helps you to ke`
`30`	`30`	\| `submitCount` \| <TypeText>number</TypeText> \| Number of times the form was submitted. \|
`31`	`31`	\| `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> \|
`32`	`32`	\| `isValidating` \| <TypeText>boolean</TypeText> \| Set to `true` during validation. \|
`33`		-\| `validatingFields` \| <TypeText>boolean</TypeText> \| Capture fields which are getting async validation. \|
	`33`	+\| `validatingFields` \| <TypeText>object</TypeText> \| Capture fields which are getting async validation. \|
`34`	`34`	\| `errors` \| <TypeText>object</TypeText> \| An object with field errors. There is also an [ErrorMessage](/docs/useformstate/errormessage) component to retrieve error message easily. \|
`35`	`35`	\| `disabled` \| <TypeText>boolean</TypeText> \| Set to true if the form is disabled via the disabled prop in [useForm](/docs/useform). \|
`36`	`36`	\| `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])`}/> \|

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ This custom hook allows you to subscribe to each form state, and isolate the re-`
`45`	`45`	\| `submitCount` \| <TypeText>number</TypeText> \| Number of times the form was submitted. \|
`46`	`46`	\| `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> \|
`47`	`47`	\| `isValidating` \| <TypeText>boolean</TypeText> \| Set to `true` during validation. \|
`48`		-\| `validatingFields` \| <TypeText>boolean</TypeText> \| Capture fields which are getting async validation. \|
	`48`	+\| `validatingFields` \| <TypeText>object</TypeText> \| Capture fields which are getting async validation. \|
`49`	`49`	\| `errors` \| <TypeText>object</TypeText> \| An object with field errors. There is also an [ErrorMessage](/docs/useformstate/errormessage) component to retrieve error message easily. \|
`50`	`50`	\| `disabled` \| <TypeText>boolean</TypeText> \| Set to true if the form is disabled via the disabled prop in [useForm](/docs/useform). \|
`51`	`51`

Comments

(0)