Back to React Native Paper

Modal

docs/public/1.0/modal.html

5.15.11.0 KB
Original Source

Modal

The Modal component is a simple way to present content above an enclosing view.

Usage

js
import * as React from 'react';
import { Modal, Text } from 'react-native-paper';

export default class MyComponent extends React.Component {
  state = {
    visible: false,
  };

  _showModal = () => this.setState({ visible: true });
  _hideModal = () => this.setState({ visible: false });

  render() {
    const { visible } = this.state;
    return (
      <Modal visible={visible} onDismiss={this._hideModal}>
        <Text>Example Modal</Text>
      </Modal>
    );
  }
}

Props

dismissable Type: boolean

Default value: true

Determines whether clicking outside the modal dismiss it.

onDismiss (required) Type: () => mixed

Callback that is called when the user dismisses the modal.

visible (required) Type: boolean

Default value: false

Determines Whether the modal is visible.

children (required) Type: React.Node

Content of the Modal.