docs: explain trigger function

AstroPlant · Jan 18, 2024 · a001700 · a001700
1 parent 1251762
commit a001700
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/astroplant-frontend/src/Components/ModalDialog.tsx b/astroplant-frontend/src/Components/ModalDialog.tsx
@@ -142,6 +142,10 @@ export type UseModalConfirmDialogValue = {
 /**
  * A hook to imperatively trigger a modal confirm dialog.
  *
+ * Calling `trigger` shows the dialog. It returns a promise that resolve to
+ * whether the dialog was confirmed or not. If `trigger` is called with a
+ * dialog still outstanding, the previous call to `trigger` resolves to false.
+ *
  * Example:
  *
  * ```tsx