@grafana/ui
Version:
Grafana Components Library
34 lines (33 loc) • 1.43 kB
TypeScript
import { ReactElement } from 'react';
import { ComponentSize } from '../../types/size';
import { ButtonVariant } from '../Button/Button';
export interface Props {
/** Confirm action callback */
onConfirm(): void;
children: string | ReactElement;
/** Custom button styles */
className?: string;
/** Button size */
size?: ComponentSize;
/** Text for the Confirm button */
confirmText?: string;
/** Disable button click action */
disabled?: boolean;
/** Variant of the Confirm button */
confirmVariant?: ButtonVariant;
/** Hide confirm actions when after of them is clicked */
closeOnConfirm?: boolean;
/** Optional on click handler for the original button */
onClick?(): void;
/** Callback for the cancel action */
onCancel?(): void;
}
/**
* The ConfirmButton is an interactive component that adds a double-confirm option to a clickable action. When clicked, the action is replaced by an inline confirmation with the option to cancel. In Grafana, this is used, for example, for editing values in settings tables.
*
* https://developers.grafana.com/ui/latest/index.html?path=/docs/inputs-confirmbutton--docs
*/
export declare const ConfirmButton: {
({ children, className, closeOnConfirm, confirmText, confirmVariant, disabled, onCancel, onClick, onConfirm, size, }: Props): import("react/jsx-runtime").JSX.Element;
displayName: string;
};