Skip to content

Add allowSwipeDismissal documentation #4658

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
javache merged 2 commits into from
Jun 19, 2025
Merged

Add allowSwipeDismissal documentation #4658

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1c8658a
Update moda docs
okwasniewski Jun 18, 2025
09ae472
Apply suggestions from code review
okwasniewski Jun 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion docs/modal.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,10 +176,21 @@ The `onOrientationChange` callback is called when the orientation changes while

---

### `allowSwipeDismissal` <div class="label ios">iOS</div>

Controls whether the modal can be dismissed by swiping down on iOS.
This requires you to implement the `onRequestClose` prop to handle the dismissal.

| Type | Default |
| ---- | ------- |
| bool | `false` |

---

### `onRequestClose`

The `onRequestClose` callback is called when the user taps the hardware back button on Android or the menu button on Apple TV. Because of this required prop, be aware that `BackHandler` events will not be emitted as long as the modal is open.
On iOS, this callback is called when a Modal is being dismissed using a drag gesture when `presentationStyle` is `pageSheet or formSheet`
On iOS, this callback is called when a Modal is being dismissed using a drag gesture when `presentationStyle` is `pageSheet or formSheet`. When `allowSwipeDismissal` is enabled this callback will be called after dismissing the modal.

| Type |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
Expand Down