The text of the cancel button. Defaults to "Cancel".
This prop accepts a ref object that holds a function of type () => void. You can execute the function to programmatically close the dialog:
closeRef.current()
Set to false to disable the default behavior of focusing the first
input.
A boolean indicating if the form is valid.
The CSS class added to the underlying Bootstrap modal.
Set to false to hide the modal footer, which contains the submit and
cancel buttons.
A boolean indicating if validation feedback is being shown.
The CSS class of the submit button.
The text of the submit button.
Allows you to disable the submit button even if getSubmitEnabled()
would return true.
This can be useful if you want to disable the submit button while a query is in progress.
The title of the dialog. Can be a JSX element.
An uncommonly-used callback that fires when the user clicks the cancel button.
A callback that fires when the dialog has completely closed. Your
onClose callback should update call, for example,
setDialogVisible(false) so that the EasyFormDialog is no longer
rendered.
A callback that fires when the dialog is submitted.
A callback that fires when the form is submitted. You will typically
perform an API call in your submit function.
Your submit function can optionally return an object in the shape
{
shouldClose?: boolean
responseData: unknown
}
Using formData is deprecated. Use controlled components instead.
formData will be {} if the optional peer dependency jquery is not
installed.
A callback that fires after the submit function succeeds.
If the submit function returned responseData, it is passed to your
onSuccess function.
Your onSuccess callback must return a promise. The submit button will
continue showing a loading indicator until the promise resolves. This is
to support refetching the data that was updated by the form submission.
Generated using TypeDoc
The props type of
EasyFormDialog.