fix(iOS): allow to interactively swipe down the modal (#51483)

Summary:
This PR allows to interactively close the modal using the swipe down gesture.

It fixes 5 year old issue: https://github.com/facebook/react-native/issues/29319

In short it removes `modalInPresentation` which according to the documentation causes: "UIKit ignores events outside the view controller’s bounds and **prevents the interactive dismissal of the view controller while it is onscreen.**".

It also adds another delegate event to call onRequestClose whenever modal is closed by gesture.

https://github.com/user-attachments/assets/8849ecba-f762-47ec-a28b-b41c1991a882

## Changelog:

[IOS] [ADDED] - Allow to interactively swipe down the modal.
Add allowSwipeDismissal prop.

Pull Request resolved: https://github.com/facebook/react-native/pull/51483

Test Plan: Test if swiping down the modal calls onRequestClose

Reviewed By: rshest

Differential Revision: D75125438

Pulled By: javache

fbshipit-source-id: d4f2c8b59447680f405b725d0809573a937f97cf
This commit is contained in:
Oskar Kwaśniewski authored and Facebook GitHub Bot committed 2025-06-18 07:18:40 -07:00
1 parent ce75271d47
commit 28986a7599
13 files changed
+90 -8

No files matched your search

+8 -2
View File
@@ -35,9 +35,9 @@ export interface ModalBaseProps {
*/
visible?: boolean | undefined;
/**
* The `onRequestClose` callback is called when the user taps the hardware back button on Android or the menu button on Apple TV.
* The `onRequestClose` callback is called when the user taps the hardware back button on Android, dismisses the sheet using a gesture on iOS (when `allowSwipeDismissal` is set to true) or the menu button on Apple TV.
*
* This is required on Apple TV and Android.
* This is required on iOS and Android.
*/
onRequestClose?: ((event: NativeSyntheticEvent<any>) => void) | undefined;
/**
@@ -89,6 +89,12 @@ export interface ModalPropsIOS {
onOrientationChange?:
| ((event: NativeSyntheticEvent<any>) => void)
| undefined;
/**
* Controls whether the modal can be dismissed by swiping down on iOS.
* This requires you to implement the `onRequestClose` prop to handle the dismissal.
*/
allowSwipeDismissal?: boolean | undefined;
}
export interface ModalPropsAndroid {
+19 -2
View File
@@ -86,9 +86,9 @@ export type ModalBaseProps = {
*/
visible?: ?boolean,
/**
* The `onRequestClose` callback is called when the user taps the hardware back button on Android or the menu button on Apple TV.
* The `onRequestClose` callback is called when the user taps the hardware back button on Android, dismisses the sheet using a gesture on iOS (when `allowSwipeDismissal` is set to true) or the menu button on Apple TV.
*
* This is required on Apple TV and Android.
* This is required on iOS and Android.
*/
// onRequestClose?: (event: NativeSyntheticEvent<any>) => void;
onRequestClose?: ?DirectEventHandler<null>,
@@ -147,6 +147,12 @@ export type ModalPropsIOS = {
// | ((event: NativeSyntheticEvent<any>) => void)
// | undefined;
onOrientationChange?: ?DirectEventHandler<OrientationChangeEvent>,
/**
* Controls whether the modal can be dismissed by swiping down on iOS.
* This requires you to implement the `onRequestClose` prop to handle the dismissal.
*/
allowSwipeDismissal?: ?boolean,
};
export type ModalPropsAndroid = {
@@ -192,6 +198,16 @@ function confirmProps(props: ModalProps) {
'Modal with translucent navigation bar and without translucent status bar is not supported.',
);
}
if (
Platform.OS === 'ios' &&
props.allowSwipeDismissal === true &&
!props.onRequestClose
) {
console.warn(
'Modal requires the onRequestClose prop when used with `allowSwipeDismissal`. This is necessary to prevent state corruption.',
);
}
}
}
@@ -327,6 +343,7 @@ class Modal extends React.Component<ModalProps, ModalState> {
onStartShouldSetResponder={this._shouldSetResponder}
supportedOrientations={this.props.supportedOrientations}
onOrientationChange={this.props.onOrientationChange}
allowSwipeDismissal={this.props.allowSwipeDismissal}
testID={this.props.testID}>
<VirtualizedListContextResetter>
<ScrollView.Context.Provider value={null}>
@@ -5689,6 +5689,7 @@ export type ModalPropsIOS = {
>,
onDismiss?: ?() => void,
onOrientationChange?: ?DirectEventHandler<OrientationChangeEvent>,
allowSwipeDismissal?: ?boolean,
};
export type ModalPropsAndroid = {
hardwareAccelerated?: ?boolean,
@@ -22,8 +22,6 @@
}
_touchHandler = [RCTSurfaceTouchHandler new];
self.modalInPresentation = YES;
return self;
}
@@ -124,6 +124,7 @@ static ModalHostViewEventEmitter::OnOrientationChange onOrientationChangeStruct(
_viewController = [RCTFabricModalHostViewController new];
_viewController.modalTransitionStyle = UIModalTransitionStyleCoverVertical;
_viewController.delegate = self;
_viewController.modalInPresentation = YES;
}
return _viewController;
}
@@ -239,6 +240,7 @@ static ModalHostViewEventEmitter::OnOrientationChange onOrientationChangeStruct(
- (void)updateProps:(const Props::Shared &)props oldProps:(const Props::Shared &)oldProps
{
const auto &oldViewProps = static_cast<const ModalHostViewProps &>(*_props);
const auto &newProps = static_cast<const ModalHostViewProps &>(*props);
#if !TARGET_OS_TV
@@ -251,6 +253,10 @@ static ModalHostViewEventEmitter::OnOrientationChange onOrientationChangeStruct(
self.viewController.modalPresentationStyle = presentationConfiguration(newProps);
if (oldViewProps.allowSwipeDismissal != newProps.allowSwipeDismissal) {
self.viewController.modalInPresentation = !newProps.allowSwipeDismissal;
}
_shouldPresent = newProps.visible;
[self ensurePresentedOnlyIfNeeded];
@@ -283,6 +289,16 @@ static ModalHostViewEventEmitter::OnOrientationChange onOrientationChangeStruct(
}
}
- (void)presentationControllerDidDismiss:(UIPresentationController *)presentationController
{
auto eventEmitter = [self modalEventEmitter];
const auto &props = static_cast<const ModalHostViewProps &>(*_props);
if (eventEmitter && props.allowSwipeDismissal) {
eventEmitter->onRequestClose({});
}
}
@end
#ifdef __cplusplus
@@ -24,6 +24,7 @@
@property (nonatomic, copy) RCTDirectEventBlock onShow;
@property (nonatomic, assign) BOOL visible;
@property (nonatomic, assign) BOOL allowSwipeDismissal;
// Android only
@property (nonatomic, assign) BOOL statusBarTranslucent;
@@ -35,6 +35,7 @@ RCT_NOT_IMPLEMENTED(-(instancetype)initWithCoder : coder)
if ((self = [super initWithFrame:CGRectZero])) {
_bridge = bridge;
_modalViewController = [RCTModalHostViewController new];
_modalViewController.modalInPresentation = YES;
UIView *containerView = [UIView new];
containerView.autoresizingMask = UIViewAutoresizingFlexibleHeight | UIViewAutoresizingFlexibleWidth;
_modalViewController.view = containerView;
@@ -50,6 +51,14 @@ RCT_NOT_IMPLEMENTED(-(instancetype)initWithCoder : coder)
return self;
}
- (void)setAllowSwipeDismissal:(BOOL)allowSwipeDismissal
{
if (_allowSwipeDismissal != allowSwipeDismissal) {
_allowSwipeDismissal = allowSwipeDismissal;
_modalViewController.modalInPresentation = !allowSwipeDismissal;
}
}
- (void)notifyForBoundsChange:(CGRect)newBounds
{
if (_reactSubview && _isPresented) {
@@ -70,6 +79,13 @@ RCT_NOT_IMPLEMENTED(-(instancetype)initWithCoder : coder)
}
}
- (void)presentationControllerDidDismiss:(UIPresentationController *)presentationController
{
if (_onRequestClose != nil && _allowSwipeDismissal) {
_onRequestClose(nil);
}
}
- (void)notifyForOrientationChange
{
if (!_onOrientationChange) {
@@ -22,8 +22,6 @@
return nil;
}
self.modalInPresentation = YES;
_preferredStatusBarStyle = [RCTUIStatusBarManager() statusBarStyle];
_preferredStatusBarHidden = [RCTUIStatusBarManager() isStatusBarHidden];
@@ -119,6 +119,7 @@ RCT_EXPORT_VIEW_PROPERTY(supportedOrientations, NSArray)
RCT_EXPORT_VIEW_PROPERTY(onOrientationChange, RCTDirectEventBlock)
RCT_EXPORT_VIEW_PROPERTY(visible, BOOL)
RCT_EXPORT_VIEW_PROPERTY(onRequestClose, RCTDirectEventBlock)
RCT_EXPORT_VIEW_PROPERTY(allowSwipeDismissal, BOOL)
// Fabric only
RCT_EXPORT_VIEW_PROPERTY(onDismiss, RCTDirectEventBlock)
@@ -5306,6 +5306,7 @@ public class com/facebook/react/viewmanagers/ModalHostViewManagerDelegate : com/
}
public abstract interface class com/facebook/react/viewmanagers/ModalHostViewManagerInterface : com/facebook/react/uimanager/ViewManagerWithGeneratedInterface {
public abstract fun setAllowSwipeDismissal (Landroid/view/View;Z)V
public abstract fun setAnimated (Landroid/view/View;Z)V
public abstract fun setAnimationType (Landroid/view/View;Ljava/lang/String;)V
public abstract fun setHardwareAccelerated (Landroid/view/View;Z)V
@@ -85,6 +85,9 @@ internal class ReactModalHostManager :
@ReactProp(name = "identifier")
override fun setIdentifier(view: ReactModalHostView, value: Int): Unit = Unit
@ReactProp(name = "allowSwipeDismissal")
override fun setAllowSwipeDismissal(view: ReactModalHostView, value: Boolean): Unit = Unit
override fun setTestId(view: ReactModalHostView, value: String?) {
super.setTestId(view, value)
view.setDialogRootViewGroupTestId(value)
@@ -112,6 +112,12 @@ type RCTModalHostViewNativeProps = $ReadOnly<{
*/
animated?: WithDefault<boolean, false>,
/**
* Controls whether the modal can be dismissed by swiping down on iOS.
* This requires you to implement the `onRequestClose` prop to handle the dismissal.
*/
allowSwipeDismissal?: WithDefault<boolean, false>,
/**
* The `supportedOrientations` prop allows the modal to be rotated to any of the specified orientations.
*
@@ -49,6 +49,7 @@ function ModalPresentation() {
const onRequestClose = useCallback(() => {
console.log('onRequestClose');
setProps(prev => ({...prev, visible: false}));
}, []);
const [props, setProps] = useState<ModalProps>({
@@ -61,6 +62,7 @@ function ModalPresentation() {
ios: 'fullScreen',
default: undefined,
}),
allowSwipeDismissal: false,
supportedOrientations: Platform.select({
ios: ['portrait'],
default: undefined,
@@ -74,6 +76,7 @@ function ModalPresentation() {
const hardwareAccelerated = props.hardwareAccelerated;
const statusBarTranslucent = props.statusBarTranslucent;
const navigationBarTranslucent = props.navigationBarTranslucent;
const allowSwipeDismissal = props.allowSwipeDismissal;
const backdropColor = props.backdropColor;
const backgroundColor = useContext(RNTesterThemeContext).BackgroundColor;
@@ -131,6 +134,21 @@ function ModalPresentation() {
}
/>
</View>
<View style={styles.inlineBlock}>
<RNTesterText style={styles.title}>
Allow Swipe Dismissal ⚫️
</RNTesterText>
<Switch
value={allowSwipeDismissal}
onValueChange={enabled =>
setProps(prev => ({
...prev,
allowSwipeDismissal: enabled,
}))
}
/>
</View>
<View style={styles.block}>
<RNTesterText style={styles.title}>Presentation Style ⚫️</RNTesterText>
<View style={styles.row}>