Interface EasyFormDialogProps

example/src/reactComponents.tsx:85–193

/** The props type of {@link EasyFormDialog | `EasyFormDialog`}. */
export interface EasyFormDialogProps {
    /** The title of the dialog. Can be a JSX element. */
    title: React.ReactNode;

    /** The text of the submit button. */
    submitButtonText: string;

    /** The CSS class of the submit button. */
    submitButtonClass?: string;

    /** The text of the cancel button. Defaults to "Cancel". */
    cancelButtonText?: string;

    /**
     * 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.
     */
    submitEnabled?: boolean;

    /** A boolean indicating if the form is valid. */
    formIsValid: boolean;

    /** A boolean indicating if validation feedback is being shown. */
    showValidation: boolean;

    /** A callback that fires when the dialog is submitted. */
    onShowValidationChange(showValidation: boolean): void;

    /**
     * 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.
     */
    onSuccess(payload: unknown | undefined): Promise<void>;

    /**
     * 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.
     */
    onClose(): void;

    /**
     * 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
     *
     * ```