ConfirmModalProps interface

Signature

  1. export interface ConfirmModalProps

Import

  1. import { ConfirmModalProps } from '@grafana/ui';

Properties

PropertyTypeDescription
alternativeTextstringText for alternative button
bodyReact.ReactNodeModal content
confirmationTextstringText user needs to fill in before confirming
confirmTextstringText for confirm button
descriptionReact.ReactNodeModal description
dismissTextstringText for dismiss button
iconIconNameIcon for the modal header
isOpenbooleanToggle modal’s open/closed state
titlestringTitle for the modal header

Methods

MethodDescription
onAlternative()Alternative action callback
onConfirm()Confirm action callback
onDismiss()Dismiss action callback

alternativeText property

Text for alternative button

Signature

  1. alternativeText?: string;

body property

Modal content

Signature

  1. body: React.ReactNode;

confirmationText property

Text user needs to fill in before confirming

Signature

  1. confirmationText?: string;

confirmText property

Text for confirm button

Signature

  1. confirmText: string;

description property

Modal description

Signature

  1. description?: React.ReactNode;

dismissText property

Text for dismiss button

Signature

  1. dismissText?: string;

icon property

Icon for the modal header

Signature

  1. icon?: IconName;

isOpen property

Toggle modal’s open/closed state

Signature

  1. isOpen: boolean;

title property

Title for the modal header

Signature

  1. title: string;

onAlternative method

Alternative action callback

Signature

  1. onAlternative?(): void;

Returns:

void

onConfirm method

Confirm action callback

Signature

  1. onConfirm(): void;

Returns:

void

onDismiss method

Dismiss action callback

Signature

  1. onDismiss(): void;

Returns:

void