Modal
The Modal component is a simple way to present content above an enclosing view.
Note: If you need more control over how to present modals over the rest of your app, then consider using a top-level Navigator.
import React, {Component} from 'react';
import {Modal, Text, TouchableHighlight, View} from 'react-native';
class ModalExample extends Component {
state = {
modalVisible: false,
};
setModalVisible(visible) {
this.setState({modalVisible: visible});
}
render() {
return (
<View style={{marginTop: 22}}>
<Modal
animationType="slide"
transparent={false}
visible={this.state.modalVisible}
onRequestClose={() => {
alert('Modal has been closed.');
}}>
<View style={{marginTop: 22}}>
<View>
<Text>Hello World!</Text>
<TouchableHighlight
onPress={() => {
this.setModalVisible(!this.state.modalVisible);
}}>
<Text>Hide Modal</Text>
</TouchableHighlight>
</View>
</View>
</Modal>
<TouchableHighlight
onPress={() => {
this.setModalVisible(true);
}}>
<Text>Show Modal</Text>
</TouchableHighlight>
</View>
);
}
}
Props
animationType
onShow
transparent
visible
hardwareAccelerated
onRequestClose
onOrientationChange
presentationStyle
supportedOrientations
animated
Reference
Props
animationType
The animationType
prop controls how the modal animates.
slide
slides in from the bottomfade
fades into viewnone
appears without an animation
Default is set to none
.
Type | Required |
---|---|
enum('none', 'slide', 'fade') | No |
onShow
The onShow
prop allows passing a function that will be called once the modal has been shown.
Type | Required |
---|---|
function | No |
transparent
The transparent
prop determines whether your modal will fill the entire view. Setting this to true
will render the modal over a transparent background.
Type | Required |
---|---|
bool | No |
visible
The visible
prop determines whether your modal is visible.
Type | Required |
---|---|
bool | No |
hardwareAccelerated
The hardwareAccelerated
prop controls whether to force hardware acceleration for the underlying window.
Type | Required | Platform |
---|---|---|
bool | No | Android |
onRequestClose
The onRequestClose
callback is called when the user taps the hardware back button.
Type | Required | Platform |
---|---|---|
Platform.OS === 'android' ? PropTypes.func.isRequired : PropTypes.func | No | Android |
onOrientationChange
The onOrientationChange
callback is called when the orientation changes while the modal is being displayed. The orientation provided is only 'portrait' or 'landscape'. This callback is also called on initial render, regardless of the current orientation.
Type | Required | Platform |
---|---|---|
function | No | iOS |
presentationStyle
The presentationStyle
prop controls how the modal appears (generally on larger devices such as iPad or plus-sized iPhones). See https://developer.apple.com/reference/uikit/uimodalpresentationstyle for details.
fullScreen
covers the screen completelypageSheet
covers portrait-width view centered (only on larger devices)formSheet
covers narrow-width view centered (only on larger devices)overFullScreen
covers the screen completely, but allows transparency
Default is set to overFullScreen
or fullScreen
depending on transparent
property.
Type | Required | Platform |
---|---|---|
enum('fullScreen', 'pageSheet', 'formSheet', 'overFullScreen') | No | iOS |
supportedOrientations
The supportedOrientations
prop allows the modal to be rotated to any of the specified orientations. On iOS, the modal is still restricted by what's specified in your app's Info.plist's UISupportedInterfaceOrientations field. When using presentationStyle
of pageSheet
or formSheet
, this property will be ignored by iOS.
Type | Required | Platform |
---|---|---|
array of enum('portrait', 'portrait-upside-down', 'landscape', 'landscape-left', 'landscape-right') | No | iOS |
animated
Deprecated. Use the animationType
prop instead.
Type | Required |
---|---|
bool | No |