@carbon/ibm-products/lib/components/RemoveModal/RemoveModal.d.ts

Carbon for IBM Products

import { ComposedModal } from '@carbon/react';
import React, { ReactNode } from 'react';
export interface RemoveModalProps extends React.ComponentProps<typeof ComposedModal> {
    /**
     * The content to be displayed in the body of the modal
     */
    body: ReactNode;
    /**
     * Optional classname
     */
    className?: string;
    /**
     * Provide a description for "close" icon that can be read by screen readers
     */
    iconDescription: string;
    /**
     * Message showed when user input fails validation
     */
    inputInvalidText?: string;
    /**
     * Label for text box
     */
    inputLabelText?: ReactNode;
    /**
     * Placeholder for text box
     */
    inputPlaceholderText?: string;
    /**
     * Specify the modal label texts
     */
    label?: string;
    /**
     * Callback function that runs when user closes the modal
     */
    onClose?: () => void;
    /**
     * Callback function that runs when user submits the modal
     */
    onRequestSubmit?: () => void;
    /**
     * Specify whether the Modal is currently open
     */
    open: boolean;
    /**
     * The DOM node the tearsheet should be rendered within. Defaults to document.body.
     */
    portalTarget?: ReactNode;
    /**
     * Prevent closing on click outside of modal
     */
    preventCloseOnClickOutside?: boolean;
    /**
     * Specify whether the primary button should be disabled. This value will override textConfirmation
     */
    primaryButtonDisabled?: boolean;
    /**
     * Specify the text for the primary button
     */
    primaryButtonText?: string;
    /**
     * Specify the danger description on the primary button
     */
    primaryDangerDescription?: string;
    /**
     * The name of the resource being acted upon
     */
    resourceName: string;
    /**
     * Specify the text for the secondary button
     */
    secondaryButtonText?: string;
    /**
     * Specify whether or not to show the text confirmation input
     */
    textConfirmation?: boolean;
    /**
     * The text displayed at the top of the modal
     */
    title: string;
}
export declare let RemoveModal: React.ForwardRefExoticComponent<RemoveModalProps & {
    children?: ReactNode | undefined;
} & React.RefAttributes<unknown>>;