api documentation for react-modal (v1.7.7)

Accessible modal dialog component for React.JS

table of contents

  1. module react-modal
    1. function react-modal (props, context, updater)
    2. function react-modal.Modal (props, context, updater)
    3. function react-modal.ModalPortal (props, context, updater)
    4. function react-modal.getDefaultProps ()
    5. function react-modal.injectCSS ()
    6. function react-modal.propTypes.appElement ()
    7. function react-modal.propTypes.ariaHideApp ()
    8. function react-modal.propTypes.closeTimeoutMS ()
    9. function react-modal.propTypes.onAfterOpen ()
    10. function react-modal.propTypes.portalClassName ()
    11. function react-modal.propTypes.style ()
    12. function react-modal.setAppElement (element)
    13. object react-modal.Modal.prototype
    14. object react-modal.Modal.prototype.__reactAutoBindPairs
    15. object react-modal.ModalPortal.prototype
    16. object react-modal.ariaAppHider
    17. object react-modal.defaultProps
    18. object react-modal.defaultStyles
    19. object react-modal.focusManager
    20. object react-modal.propTypes
    21. object react-modal.refCount
    22. string react-modal.displayName
  2. module react-modal.Modal
    1. function react-modal.Modal (props, context, updater)
    2. function react-modal.Modal.getDefaultProps ()
    3. function react-modal.Modal.injectCSS ()
    4. function react-modal.Modal.setAppElement (element)
    5. object react-modal.Modal.defaultProps
    6. object react-modal.Modal.defaultStyles
    7. object react-modal.Modal.propTypes
    8. string react-modal.Modal.displayName
  3. module react-modal.Modal.prototype
    1. function react-modal.Modal.prototype.componentDidMount ()
    2. function react-modal.Modal.prototype.componentWillReceiveProps (newProps)
    3. function react-modal.Modal.prototype.componentWillUnmount ()
    4. function react-modal.Modal.prototype.constructor (props, context, updater)
    5. function react-modal.Modal.prototype.removePortal ()
    6. function react-modal.Modal.prototype.render ()
    7. function react-modal.Modal.prototype.renderPortal (props)
    8. object react-modal.Modal.prototype.__reactAutoBindPairs
    9. object react-modal.Modal.prototype.childContextTypes
    10. object react-modal.Modal.prototype.componentDidUpdate
    11. object react-modal.Modal.prototype.componentWillMount
    12. object react-modal.Modal.prototype.componentWillUpdate
    13. object react-modal.Modal.prototype.contextTypes
    14. object react-modal.Modal.prototype.getChildContext
    15. object react-modal.Modal.prototype.getDefaultProps
    16. object react-modal.Modal.prototype.getInitialState
    17. object react-modal.Modal.prototype.mixins
    18. object react-modal.Modal.prototype.propTypes
    19. object react-modal.Modal.prototype.shouldComponentUpdate
    20. object react-modal.Modal.prototype.statics
    21. object react-modal.Modal.prototype.updateComponent
  4. module react-modal.Modal.prototype.__reactAutoBindPairs
    1. function react-modal.Modal.prototype.__reactAutoBindPairs.1 ()
    2. function react-modal.Modal.prototype.__reactAutoBindPairs.3 (props)
    3. string react-modal.Modal.prototype.__reactAutoBindPairs.0
    4. string react-modal.Modal.prototype.__reactAutoBindPairs.2
  5. module react-modal.ModalPortal
    1. function react-modal.ModalPortal (props, context, updater)
    2. function react-modal.ModalPortal.getDefaultProps ()
    3. object react-modal.ModalPortal.defaultProps
    4. string react-modal.ModalPortal.displayName
  6. module react-modal.ModalPortal.prototype
    1. function react-modal.ModalPortal.prototype.afterClose ()
    2. function react-modal.ModalPortal.prototype.buildClassName (which, additional)
    3. function react-modal.ModalPortal.prototype.close ()
    4. function react-modal.ModalPortal.prototype.closeWithTimeout ()
    5. function react-modal.ModalPortal.prototype.closeWithoutTimeout ()
    6. function react-modal.ModalPortal.prototype.componentDidMount ()
    7. function react-modal.ModalPortal.prototype.componentDidUpdate ()
    8. function react-modal.ModalPortal.prototype.componentWillReceiveProps (newProps)
    9. function react-modal.ModalPortal.prototype.componentWillUnmount ()
    10. function react-modal.ModalPortal.prototype.constructor (props, context, updater)
    11. function react-modal.ModalPortal.prototype.contentHasFocus ()
    12. function react-modal.ModalPortal.prototype.focusContent ()
    13. function react-modal.ModalPortal.prototype.getInitialState ()
    14. function react-modal.ModalPortal.prototype.handleContentOnClick ()
    15. function react-modal.ModalPortal.prototype.handleKeyDown (event)
    16. function react-modal.ModalPortal.prototype.handleOverlayOnClick (event)
    17. function react-modal.ModalPortal.prototype.open ()
    18. function react-modal.ModalPortal.prototype.ownerHandlesClose ()
    19. function react-modal.ModalPortal.prototype.render ()
    20. function react-modal.ModalPortal.prototype.requestClose (event)
    21. function react-modal.ModalPortal.prototype.setFocusAfterRender (focus)
    22. function react-modal.ModalPortal.prototype.shouldBeClosed ()
    23. object react-modal.ModalPortal.prototype.__reactAutoBindPairs
    24. object react-modal.ModalPortal.prototype.childContextTypes
    25. object react-modal.ModalPortal.prototype.componentWillMount
    26. object react-modal.ModalPortal.prototype.componentWillUpdate
    27. object react-modal.ModalPortal.prototype.contextTypes
    28. object react-modal.ModalPortal.prototype.getChildContext
    29. object react-modal.ModalPortal.prototype.getDefaultProps
    30. object react-modal.ModalPortal.prototype.mixins
    31. object react-modal.ModalPortal.prototype.propTypes
    32. object react-modal.ModalPortal.prototype.shouldClose
    33. object react-modal.ModalPortal.prototype.shouldComponentUpdate
    34. object react-modal.ModalPortal.prototype.statics
    35. object react-modal.ModalPortal.prototype.updateComponent
  7. module react-modal.ariaAppHider
    1. function react-modal.ariaAppHider.hide (appElement)
    2. function react-modal.ariaAppHider.resetForTesting ()
    3. function react-modal.ariaAppHider.setElement (element)
    4. function react-modal.ariaAppHider.show (appElement)
    5. function react-modal.ariaAppHider.toggle (shouldHide, appElement)
  8. module react-modal.defaultProps
    1. boolean react-modal.defaultProps.ariaHideApp
    2. boolean react-modal.defaultProps.isOpen
    3. boolean react-modal.defaultProps.shouldCloseOnOverlayClick
    4. function react-modal.defaultProps.parentSelector ()
    5. number react-modal.defaultProps.closeTimeoutMS
    6. string react-modal.defaultProps.portalClassName
  9. module react-modal.focusManager
    1. function react-modal.focusManager.markForFocusLater ()
    2. function react-modal.focusManager.returnFocus ()
    3. function react-modal.focusManager.setupScopedFocus (element)
    4. function react-modal.focusManager.teardownScopedFocus ()
  10. module react-modal.propTypes
    1. function react-modal.propTypes.appElement ()
    2. function react-modal.propTypes.ariaHideApp ()
    3. function react-modal.propTypes.closeTimeoutMS ()
    4. function react-modal.propTypes.contentLabel ()
    5. function react-modal.propTypes.isOpen ()
    6. function react-modal.propTypes.onAfterOpen ()
    7. function react-modal.propTypes.onRequestClose ()
    8. function react-modal.propTypes.parentSelector ()
    9. function react-modal.propTypes.portalClassName ()
    10. function react-modal.propTypes.role ()
    11. function react-modal.propTypes.shouldCloseOnOverlayClick ()
    12. function react-modal.propTypes.style ()
  11. module react-modal.propTypes.appElement
    1. function react-modal.propTypes.appElement ()
    2. function react-modal.propTypes.appElement.isRequired ()
  12. module react-modal.propTypes.ariaHideApp
    1. function react-modal.propTypes.ariaHideApp ()
    2. function react-modal.propTypes.ariaHideApp.isRequired ()
  13. module react-modal.propTypes.closeTimeoutMS
    1. function react-modal.propTypes.closeTimeoutMS ()
    2. function react-modal.propTypes.closeTimeoutMS.isRequired ()
  14. module react-modal.propTypes.onAfterOpen
    1. function react-modal.propTypes.onAfterOpen ()
    2. function react-modal.propTypes.onAfterOpen.isRequired ()
  15. module react-modal.propTypes.portalClassName
    1. function react-modal.propTypes.portalClassName ()
    2. function react-modal.propTypes.portalClassName.isRequired ()
  16. module react-modal.propTypes.style
    1. function react-modal.propTypes.style ()
    2. function react-modal.propTypes.style.isRequired ()
  17. module react-modal.refCount
    1. function react-modal.refCount.add (element)
    2. function react-modal.refCount.count ()
    3. function react-modal.refCount.remove (element)

module react-modal

function react-modal (props, context, updater)

function react-modal.Modal (props, context, updater)

function react-modal.ModalPortal (props, context, updater)

function react-modal.getDefaultProps ()

function react-modal.injectCSS ()

function react-modal.propTypes.appElement ()

function react-modal.propTypes.ariaHideApp ()

function react-modal.propTypes.closeTimeoutMS ()

function react-modal.propTypes.onAfterOpen ()

function react-modal.propTypes.portalClassName ()

function react-modal.propTypes.style ()

function react-modal.setAppElement (element)

module react-modal.Modal

function react-modal.Modal (props, context, updater)

function react-modal.Modal.getDefaultProps ()

function react-modal.Modal.injectCSS ()

function react-modal.Modal.setAppElement (element)

module react-modal.Modal.prototype

function react-modal.Modal.prototype.componentDidMount ()

function react-modal.Modal.prototype.componentWillReceiveProps (newProps)

function react-modal.Modal.prototype.componentWillUnmount ()

function react-modal.Modal.prototype.constructor (props, context, updater)

function react-modal.Modal.prototype.removePortal ()

function react-modal.Modal.prototype.render ()

function react-modal.Modal.prototype.renderPortal (props)

module react-modal.Modal.prototype.__reactAutoBindPairs

function react-modal.Modal.prototype.__reactAutoBindPairs.1 ()

function react-modal.Modal.prototype.__reactAutoBindPairs.3 (props)

module react-modal.ModalPortal

function react-modal.ModalPortal (props, context, updater)

function react-modal.ModalPortal.getDefaultProps ()

module react-modal.ModalPortal.prototype

function react-modal.ModalPortal.prototype.afterClose ()

function react-modal.ModalPortal.prototype.buildClassName (which, additional)

function react-modal.ModalPortal.prototype.close ()

function react-modal.ModalPortal.prototype.closeWithTimeout ()

function react-modal.ModalPortal.prototype.closeWithoutTimeout ()

function react-modal.ModalPortal.prototype.componentDidMount ()

function react-modal.ModalPortal.prototype.componentDidUpdate ()

function react-modal.ModalPortal.prototype.componentWillReceiveProps (newProps)

function react-modal.ModalPortal.prototype.componentWillUnmount ()

function react-modal.ModalPortal.prototype.constructor (props, context, updater)

function react-modal.ModalPortal.prototype.contentHasFocus ()

function react-modal.ModalPortal.prototype.focusContent ()

function react-modal.ModalPortal.prototype.getInitialState ()

function react-modal.ModalPortal.prototype.handleContentOnClick ()

function react-modal.ModalPortal.prototype.handleKeyDown (event)

function react-modal.ModalPortal.prototype.handleOverlayOnClick (event)

function react-modal.ModalPortal.prototype.open ()

function react-modal.ModalPortal.prototype.ownerHandlesClose ()

function react-modal.ModalPortal.prototype.render ()

function react-modal.ModalPortal.prototype.requestClose (event)

function react-modal.ModalPortal.prototype.setFocusAfterRender (focus)

function react-modal.ModalPortal.prototype.shouldBeClosed ()

module react-modal.ariaAppHider

function react-modal.ariaAppHider.hide (appElement)

function react-modal.ariaAppHider.resetForTesting ()

function react-modal.ariaAppHider.setElement (element)

function react-modal.ariaAppHider.show (appElement)

function react-modal.ariaAppHider.toggle (shouldHide, appElement)

module react-modal.defaultProps

function react-modal.defaultProps.parentSelector ()

module react-modal.focusManager

function react-modal.focusManager.markForFocusLater ()

function react-modal.focusManager.returnFocus ()

function react-modal.focusManager.setupScopedFocus (element)

function react-modal.focusManager.teardownScopedFocus ()

module react-modal.propTypes

function react-modal.propTypes.appElement ()

function react-modal.propTypes.ariaHideApp ()

function react-modal.propTypes.closeTimeoutMS ()

function react-modal.propTypes.contentLabel ()

function react-modal.propTypes.isOpen ()

function react-modal.propTypes.onAfterOpen ()

function react-modal.propTypes.onRequestClose ()

function react-modal.propTypes.parentSelector ()

function react-modal.propTypes.portalClassName ()

function react-modal.propTypes.role ()

function react-modal.propTypes.shouldCloseOnOverlayClick ()

function react-modal.propTypes.style ()

module react-modal.propTypes.appElement

function react-modal.propTypes.appElement ()

function react-modal.propTypes.appElement.isRequired ()

module react-modal.propTypes.ariaHideApp

function react-modal.propTypes.ariaHideApp ()

function react-modal.propTypes.ariaHideApp.isRequired ()

module react-modal.propTypes.closeTimeoutMS

function react-modal.propTypes.closeTimeoutMS ()

function react-modal.propTypes.closeTimeoutMS.isRequired ()

module react-modal.propTypes.onAfterOpen

function react-modal.propTypes.onAfterOpen ()

function react-modal.propTypes.onAfterOpen.isRequired ()

module react-modal.propTypes.portalClassName

function react-modal.propTypes.portalClassName ()

function react-modal.propTypes.portalClassName.isRequired ()

module react-modal.propTypes.style

function react-modal.propTypes.style ()

function react-modal.propTypes.style.isRequired ()

module react-modal.refCount

function react-modal.refCount.add (element)

function react-modal.refCount.count ()

function react-modal.refCount.remove (element)

[ this document was created with utility2 ]