Edit

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. Go here to compare navigation options.

import React, {Component} from 'react';
import {Modal, Text, TouchableHighlight, View} from 'react-native';

class ModalExample extends Component {
  constructor(props) {
    super(props);
    this.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
• onRequestClose
• onShow
• transparent
• visible
• onOrientationChange
• supportedOrientations
• animated

---

Reference

Props

animationType

The animationType prop controls how the modal animates.

• slide slides in from the bottom
• fade fades into view
• none appears without an animation

Type	Required
PropTypes.oneOf(['none', 'slide', 'fade'])	No

---

onRequestClose

The onRequestClose prop allows passing a function that will be called once the modal has been dismissed.

On the Android platform, this is a required function.

Type	Required
Platform.OS === 'android' ? PropTypes.func.isRequired : PropTypes.func	No

---

onShow

The onShow prop allows passing a function that will be called once the modal has been shown.

Type	Required
PropTypes.func	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
PropTypes.bool	No

---

visible

The visible prop determines whether your modal is visible.

Type	Required
PropTypes.bool	No

---

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
PropTypes.func	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.

Type	Required	Platform
PropTypes.arrayOf(PropTypes.oneOf(['portrait', 'portrait-upside-down', 'landscape', 'landscape-left', 'landscape-right']))	No	iOS

---

animated

Deprecated. Use the animationType prop instead.

Type	Required
bool	No