} from 'react-native-reanimated-modal';
Modal is a function component with forwardRef; its props are ModalProps, its ref is ModalRef.
| Prop |
Type |
Default |
Description |
visible |
boolean |
— |
Whether the modal is shown. A change animates it in or out |
children |
ReactNode |
— |
The content |
closable |
boolean |
true |
Whether a backdrop press or a swipe can close it. Platforms |
style |
StyleProp<ViewStyle> |
— |
The full-screen container the content is laid out in (flex: 1, justifyContent: 'center') |
contentContainerStyle |
StyleProp<ViewStyle> |
— |
The animated wrapper of the content |
coverScreen |
boolean |
false |
Draws the modal in your tree instead of a native Modal. Multiple modals |
| Prop |
Type |
Default |
Description |
animation |
ModalAnimationConfigUnion | ModalAnimation |
{ type: 'fade', duration: 300 } |
A preset name or a config. Animations |
swipe |
ModalSwipeConfig | false |
{ enabled: true, directions: ['down'], threshold: 100 } |
Swipe to dismiss; false turns it off. Swipe to dismiss |
backdrop |
ModalBackdropConfig | ReactNode | false |
{ enabled: true, color: 'black', opacity: 0.7 } |
A config, your element, or false for none. Backdrop |
onBackdropPress |
(() => void) | false |
— |
Replaces the close on a backdrop press; false ignores presses. Backdrop |
| Prop |
Type |
Description |
onShow |
() => void |
Called when the opening animation has finished |
onHide |
() => void |
Called when the closing animation has finished — set visible to false here. Without it the swipe is off |
onBackButtonPress |
() => void |
Android: replaces the close on a hardware back press while the modal is open. Platforms |
Passed through to React Native’s Modal; ignored with coverScreen. Platforms
| Prop |
Platform |
statusBarTranslucent |
Android |
navigationBarTranslucent |
Android |
hardwareAccelerated |
Android |
supportedOrientations |
iOS |
onOrientationChange |
iOS |
| Prop |
Type |
Default |
containerTestID |
string |
'modal-container' |
backdropTestID |
string |
'modal-backdrop' |
contentTestID |
string |
'modal-content' |
Testing
| Method |
Description |
open() |
Opens the modal with its animation. Does nothing if it is open or animating |
close() |
Closes it with its animation, then calls onHide. Does nothing if it is closed or animating |
Ref API