diff --git a/packages/grafana-ui/src/components/ConfirmModal/ConfirmModal.mdx b/packages/grafana-ui/src/components/ConfirmModal/ConfirmModal.mdx index d9bebe6c2a8..3f7846412af 100644 --- a/packages/grafana-ui/src/components/ConfirmModal/ConfirmModal.mdx +++ b/packages/grafana-ui/src/components/ConfirmModal/ConfirmModal.mdx @@ -7,4 +7,18 @@ import { ConfirmModal } from './ConfirmModal'; Used to request user for action confirmation, e.g. deleting items. Triggers provided 'onConfirm' callback. +# Usage +```jsx + console.log('Confirm action')} + onDismiss={() => console.log('Dismiss action')} +/> +``` + + diff --git a/packages/grafana-ui/src/components/ConfirmModal/ConfirmModal.tsx b/packages/grafana-ui/src/components/ConfirmModal/ConfirmModal.tsx index 9beea2bc4dc..c260579e547 100644 --- a/packages/grafana-ui/src/components/ConfirmModal/ConfirmModal.tsx +++ b/packages/grafana-ui/src/components/ConfirmModal/ConfirmModal.tsx @@ -8,13 +8,21 @@ import { GrafanaTheme } from '@grafana/data'; import { HorizontalGroup } from '..'; export interface Props { + /** Toggle modal's open/closed state */ isOpen: boolean; + /** Title for the modal header */ title: string; + /** Modal content */ body: React.ReactNode; + /** Text for confirm button */ confirmText: string; + /** Text for dismiss button */ dismissText?: string; + /** Icon for the modal header */ icon?: IconName; + /** Confirm action callback */ onConfirm(): void; + /** Dismiss action callback */ onDismiss(): void; }