envoc-form/es/ConfirmDeleteForm/ConfirmDeleteForm.d.ts

Envoc form components

import React from 'react';
import { ConfirmBaseFormProps } from '../ConfirmBaseForm/ConfirmBaseForm';
export interface ConfirmDeleteFormProps extends Pick<ConfirmBaseFormProps, 'style'> {
    /** Url to navigate to on success. */
    successUrl?: string;
    /** Form name (key) to apply the confirmation on. */
    form: string;
    /** Custom message to display.
     * @defaultValue `Are you sure you want to delete this?`
     */
    title?: string;
    /** Custom function when the axios request succeeds. */
    handleComplete?: Function;
    /** Custom function when the axios request fails. */
    handleError?: Function;
    /** Any components to be rendered in between the title and the buttons. */
    children?: React.ReactNode;
}
/**
 * Deletion confirmation. Navigates to a different route to allow the user to either confirm or cancel an action.
 *
 * Wraps `<ConfirmBaseForm/>`.
 */
export default function ConfirmDeleteForm({ successUrl, form, title, handleComplete, handleError, children, ...props }: ConfirmDeleteFormProps): JSX.Element;