diff --git a/docs/api/modal.md b/docs/api/modal.md index a9153305e6..95823929a6 100644 --- a/docs/api/modal.md +++ b/docs/api/modal.md @@ -321,6 +321,23 @@ interface ModalDragEventDetail { * snap to upon release. */ snapBreakpoint?: number; + /** + * Whether the modal will begin dismissing when the drag gesture ends. + * + * In a sheet modal, this is `true` when the modal will snap to a + * breakpoint of 0. In a card modal, it is `true` when the gesture + * passed the threshold required to close the modal. + * + * If a `canDismiss` callback is set, it can still cancel the dismiss + * after this event is emitted. Listen for `ionModalDidDismiss` to + * confirm that the modal closed. + * + * This property is only included on `ionDragEnd`. + * + * This can be used to react as soon as the user releases the modal, + * such as dismissing the keyboard while the modal animates away. + */ + isDismissing?: boolean; } ```