From 126683929c138eeffa725e7fe109cdbc46be1f56 Mon Sep 17 00:00:00 2001
From: Alex Khomenko <Clarity-89@users.noreply.github.com>
Date: Fri, 11 Sep 2020 16:45:39 +0300
Subject: [PATCH] Grafana-UI: Expand ConfirmModal docs (#27541)

---
 .../src/components/ConfirmModal/ConfirmModal.mdx   | 14 ++++++++++++++
 .../src/components/ConfirmModal/ConfirmModal.tsx   |  8 ++++++++
 2 files changed, 22 insertions(+)

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
+<ConfirmModal
+  isOpen={false}
+  title='Delete user'
+  body='Are you sure you want to delete this user?'
+  confirmText='Confirm'
+  icon='exclamation-triangle'
+  onConfirm={() => console.log('Confirm action')}
+  onDismiss={() => console.log('Dismiss action')}
+/>
+```
+
+
 <Props of={ConfirmModal} />
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;
 }