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

Envoc form components

import React, { MouseEventHandler } from 'react';
import { useAxiosRequestProps } from 'envoc-request';
export interface ConfirmBaseFormProps {
    /** Function to run when cancel button is clicked. */
    handleCancel?: MouseEventHandler<HTMLButtonElement>;
    /** Axios request upon confirmation */
    request: useAxiosRequestProps;
    style?: React.CSSProperties;
    /** `<h3/>` title text on top of the form. */
    title?: string;
    /** Custom confirm button text.
     * @defaultValue `Confirm`
     */
    confirmButtonText?: string;
    /** CSS class for the buttons. */
    confirmButtonClass?: string;
    /** Any components to be rendered in between the title and the buttons. */
    children?: React.ReactNode;
}
/**
 * Confimation dialog. Navigates to a different route to allow the user to either confirm or cancel an action.
 * Commonly used for confirming delete and archive.
 *
 * See `<ConfirmDeleteForm/>` if the confirmation is specifically for deletion.
 */
export default function ConfirmBaseForm({ handleCancel, request, style, title, confirmButtonText, confirmButtonClass, children, ...props }: ConfirmBaseFormProps): JSX.Element;