Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »


3.1.6 • Public • Published


Accessible modal dialog component for React.JS

Build Status Code Climate Coverage Status gzip size

Table of Contents


To install, you can use npm or yarn:

$ npm install react-modal
$ yarn add react-modal


The Modal object has one required prop:

  • isOpen to render its children.


  <h1>Modal Content</h1>

Use the prop contentLabel which adds aria-label to the modal if there is no label text visible on the screen, otherwise specify the element including the label text using aria-labelledby

App Element

The app element allows you to specify the portion of your app that should be hidden (via aria-hidden) to prevent assistive technologies such as screenreaders from reading content outside of the content of your modal.

If you are doing server-side rendering, you should use this property.

It can be specified in the following ways:

  • DOMElement
  • query selector - uses the first element found if you pass in a class.

Additional Aria Attributes

Use the property aria to pass any additional aria attributes. It accepts an object where the keys are the names of the attributes without the prefix aria-.


    labelledby: "heading",
    describedby: "full_description"
  <h1 id="heading">H1</h1>
  <div id="full_description">
    <p>Description goes here.</p>


Styles are passed as an object with 2 keys, 'overlay' and 'content' like so

  overlay : {
    position          : 'fixed',
    top               : 0,
    left              : 0,
    right             : 0,
    bottom            : 0,
    backgroundColor   : 'rgba(255, 255, 255, 0.75)'
  content : {
    position                   : 'absolute',
    top                        : '40px',
    left                       : '40px',
    right                      : '40px',
    bottom                     : '40px',
    border                     : '1px solid #ccc',
    background                 : '#fff',
    overflow                   : 'auto',
    WebkitOverflowScrolling    : 'touch',
    borderRadius               : '4px',
    outline                    : 'none',
    padding                    : '20px'

Styles passed to the modal are merged in with the above defaults and applied to their respective elements. At this time, media queries will need to be handled by the consumer.

Using CSS Classes

If you prefer not to use inline styles or are unable to do so in your project, you can pass className and overlayClassName props to the Modal. If you do this then none of the default styles will apply and you will have full control over styling via CSS.

If you want to override default content and overlay classes you can pass object with three required properties: base, afterOpen, beforeClose.

    base: 'myClass',
    afterOpen: 'myClass_after-open',
    beforeClose: 'myClass_before-close'
    base: 'myOverlayClass',
    afterOpen: 'myOverlayClass_after-open',
    beforeClose: 'myOverlayClass_before-close'

You can also pass a portalClassName to change the wrapper's class (ReactModalPortal). This doesn't affect styling as no styles are applied to this element by default.

Overriding styles globally

The default styles above are available on Modal.defaultStyles. Changes to this object will apply to all instances of the modal.

Appended to custom node

You can choose an element for the modal to be appended to, rather than using body tag. To do this, provide a function to parentSelector prop that return the element to be used.

function getParent() {
  return document.querySelector('#root');
  <p>Modal Content.</p>

Body class

When the modal is opened a ReactModal__Body--open class is added to the body tag. You can use this to remove scrolling on the body while the modal is open.

/* Remove scroll on the body when react-modal is open */
.ReactModal__Body--open {
    overflow: hidden;


Inside an app:

import React from 'react';
import ReactDOM from 'react-dom';
import Modal from 'react-modal';
const customStyles = {
  content : {
    top                   : '50%',
    left                  : '50%',
    right                 : 'auto',
    bottom                : 'auto',
    marginRight           : '-50%',
    transform             : 'translate(-50%, -50%)'
class App extends React.Component {
  constructor() {
    this.state = {
      modalIsOpen: false
    this.openModal = this.openModal.bind(this);
    this.afterOpenModal = this.afterOpenModal.bind(this);
    this.closeModal = this.closeModal.bind(this);
  openModal() {
    this.setState({modalIsOpen: true});
  afterOpenModal() {
    // references are now sync'd and can be accessed. = '#f00';
  closeModal() {
    this.setState({modalIsOpen: false});
  render() {
    return (
        <button onClick={this.openModal}>Open Modal</button>
          contentLabel="Example Modal"
          <h2 ref={subtitle => this.subtitle = subtitle}>Hello</h2>
          <button onClick={this.closeModal}>close</button>
          <div>I am a modal</div>
            <input />
            <button>tab navigation</button>
            <button>the modal</button>
ReactDOM.render(<App />, appElement);


When using React Test Utils with this library, here are some things to keep in mind:

  • You need to set isOpen={true} on the modal component for it to render its children.
  • You need to use the .portal property, as in ReactDOM.findDOMNode(renderedModal.portal) or TestUtils.scryRenderedDOMComponentsWithClass(Modal.portal, 'my-modal-class') to acquire a handle to the inner contents of your modal.

By default the modal is closed when clicking outside of it (the overlay area). If you want to prevent this behavior you can pass the 'shouldCloseOnOverlayClick' prop with 'false' value.

  contentLabel="No Overlay Click Modal"
  <h1>Force Modal</h1>
  <p>Modal cannot be closed when clicking the overlay area</p>
  <button onClick={handleCloseFunc}>Close Modal...</button>



npm i @sheerun/react-modal

Downloadsweekly downloads









last publish


  • avatar