Skip to content
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

Jump to bottom

fix-docs: return type of setValue in docs did not match the function typing #3871

Merged
merged 3 commits into from
Sep 12, 2023
Merged

fix-docs: return type of setValue in docs did not match the function typing #3871

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
305f319
fix: return type of setValue in docs did not match the function typing
DavideFrancescon Aug 21, 2023
09d81ce
Merge branch 'main' into fix/ISSUE-3846-setValue-docs
DavideFrancescon Sep 5, 2023
405578c
Merge pull request #1 from SophanySC/main
DavideFrancescon Sep 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/api/formik.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,7 +216,7 @@ Set `touched` imperatively. Calling this will trigger validation to run if `vali

If `validateOnBlur` is set to `true` and there are errors, they will be resolved in the returned `Promise`.

#### `setValues: (fields: React.SetStateAction<{ [field: string]: any }>, shouldValidate?: boolean) => void`
#### `setValues: (fields: React.SetStateAction<{ [field: string]: any }>, shouldValidate?: boolean) => Promise<void | FormikErrors<Values>>`

Set `values` imperatively. Calling this will trigger validation to run if `validateOnChange` is set to `true` (which it is by default). You can also explicitly prevent/skip validation by passing a second argument as `false`.

Expand Down