-
-
Notifications
You must be signed in to change notification settings - Fork 2.8k
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.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix(docs): #3827 link ref to other doc pages is incorrect #3830
Changes from 3 commits
c12716b
b3c12e5
7dc8324
6ea9cb3
e84b889
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -93,11 +93,11 @@ to `<button onClick={handleReset}>...</button>` | |
|
||
#### `handleSubmit: (e: React.FormEvent<HTMLFormElement>) => void` | ||
|
||
Submit handler. This should be passed to `<form onSubmit={props.handleSubmit}>...</form>`. To learn more about the submission process, see [Form Submission](../docs/guides/form-submission.md). | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I don't think these changes are correct, they work properly on the current live site, see https://formik.org/docs/api/formik#handlesubmit-e-reactformeventhtmlformelement--void There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yes, I checked the live site is correct, but when navigating around directly in the md file in the GitHub repo will be incorrect |
||
Submit handler. This should be passed to `<form onSubmit={props.handleSubmit}>...</form>`. To learn more about the submission process, see [Form Submission](../guides/form-submission.md). | ||
|
||
#### `isSubmitting: boolean` | ||
|
||
Submitting state of the form. Returns `true` if submission is in progress and `false` otherwise. IMPORTANT: Formik will set this to `true` as soon as submission is _attempted_. To learn more about the submission process, see [Form Submission](../docs/guides/form-submission.md). | ||
Submitting state of the form. Returns `true` if submission is in progress and `false` otherwise. IMPORTANT: Formik will set this to `true` as soon as submission is _attempted_. To learn more about the submission process, see [Form Submission](../guides/form-submission.md). | ||
|
||
#### `isValid: boolean` | ||
|
||
|
@@ -107,7 +107,7 @@ Returns `true` if there are no `errors` (i.e. the `errors` object is empty) and | |
|
||
#### `isValidating: boolean` | ||
|
||
Returns `true` if Formik is running validation during submission, or by calling [`validateForm`] directly `false` otherwise. To learn more about what happens with `isValidating` during the submission process, see [Form Submission](../docs/guides/form-submission.md). | ||
Returns `true` if Formik is running validation during submission, or by calling [`validateForm`] directly `false` otherwise. To learn more about what happens with `isValidating` during the submission process, see [Form Submission](../guides/form-submission.md). | ||
|
||
#### `resetForm: (nextState?: Partial<FormikState<Values>>) => void` | ||
|
||
|
@@ -188,8 +188,8 @@ Trigger a form submission. The promise will be rejected if form is invalid. | |
|
||
#### `submitCount: number` | ||
|
||
Number of times user tried to submit the form. Increases when [`handleSubmit`](#handlesubmit-e-reactformevent-htmlformelement-void) is called, resets after calling | ||
[`handleReset`](#handlereset-void). `submitCount` is readonly computed property and should not be mutated directly. | ||
Number of times user tried to submit the form. Increases when [`handleSubmit`](#handlesubmit-e-reactformeventhtmlformelement--void) is called, resets after calling | ||
[`handleReset`](#handlereset---void). `submitCount` is readonly computed property and should not be mutated directly. | ||
|
||
#### `setFieldValue: (field: string, value: any, shouldValidate?: boolean) => Promise<void | FormikErrors>` | ||
|
||
|
@@ -206,7 +206,7 @@ use it to pass API responses back into your component in `handleSubmit`. | |
|
||
#### `setSubmitting: (isSubmitting: boolean) => void` | ||
|
||
Set `isSubmitting` imperatively. You would call it with `setSubmitting(false)` in your `onSubmit` handler to finish the cycle. To learn more about the submission process, see [Form Submission](../docs/guides/form-submission.md). | ||
Set `isSubmitting` imperatively. You would call it with `setSubmitting(false)` in your `onSubmit` handler to finish the cycle. To learn more about the submission process, see [Form Submission](../guides/form-submission.md). | ||
|
||
#### `setTouched: (fields: { [field: string]: boolean }, shouldValidate?: boolean) => void` | ||
|
||
|
@@ -223,7 +223,7 @@ otherwise be expressed/stored with other methods. This is useful for capturing | |
and passing through API responses to your inner component. | ||
|
||
`status` should only be modified by calling | ||
[`setStatus`](#setstatus-status-any-void). | ||
[`setStatus`](#setstatus-status-any--void). | ||
|
||
#### `touched: { [field: string]: boolean }` | ||
|
||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I didn't remove .md extension because, in the website src code, the extension will be remove before transforming to a link
and keep .md extension will help navigate around directly in the md file correctly.