Skip to content

docs(modal): document isDismissing on ModalDragEventDetail - #4612

Open
thetaPC wants to merge 1 commit into
major-9.0from
FW-7123
Open

docs(modal): document isDismissing on ModalDragEventDetail#4612
thetaPC wants to merge 1 commit into
major-9.0from
FW-7123

Conversation

@thetaPC

@thetaPC thetaPC commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

Issue URL: ionic-team/ionic-framework#31001

What is the current behavior?

ModalDragEventDetail documents currentY, deltaY, velocityY, progress, and snapBreakpoint. The isDismissing property added in ionic-framework#31002 is
undocumented, so there is no reference for when it is true or which event includes it.

What is the new behavior?

Documents isDismissing in the ModalDragEventDetail interface:

  • When it is true for sheet modals, snapping to a breakpoint of 0, and for card modals, passing the threshold required to close.
  • That a canDismiss callback can still cancel the dismiss after the event is emitted, and that ionModalDidDismiss confirms the modal closed.
  • That the property is only included on ionDragEnd, not ionDragMove.
  • A use case, reacting as soon as the user releases the modal, such as dismissing the keyboard.

Does this introduce a breaking change?

  • Yes
  • No

Other information

Preview

@thetaPC
thetaPC requested a review from a team as a code owner July 31, 2026 23:04
@thetaPC
thetaPC requested review from gnbm and removed request for a team July 31, 2026 23:04
@vercel

vercel Bot commented Jul 31, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
ionic-docs Ready Ready Preview Jul 31, 2026 11:13pm

Request Review

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant