# Global

##

### Members

#### animation

Use animation

Source:
  - src/js/bundle.js, line 23109

#### animation

Open and close the Modal with a slide and fade animation.

Source:
  - src/js/bundle.js, line 20986

#### autoFocus

When `true` The modal will automatically shift focus to itself when it opens, and replace it to the last focused element when it closes. Generally this should never be set to false as it makes the Modal less accessible to assistive technologies, like screen-readers.

Source:
  - src/js/bundle.js, line 21001

#### autoFocus

When `true` The modal will automatically shift focus to itself when it opens, and replace it to the last focused element when it closes. This also works correctly with any Modal children that have the `autoFocus` prop. Generally this should never be set to `false` as it makes the Modal less accessible to assistive technologies, like screen readers.

Source:
  - src/js/bundle.js, line 30773

#### backdrop

Include a backdrop component.

Source:
  - src/js/bundle.js, line 30701

#### backdrop

Include a backdrop component. Specify 'static' for a backdrop that doesn't trigger an "onHide" when clicked.

Source:
  - src/js/bundle.js, line 20976

#### backdropClassName

A css class or classes for the backdrop component.

Source:
  - src/js/bundle.js, line 30731

#### backdropStyle

A style object for the backdrop component.

Source:
  - src/js/bundle.js, line 30726

#### backdropTransitionTimeout

The `timeout` of the backdrop transition if specified. This number is used to ensure that transition callbacks are always fired, even if browser transition events are canceled. See the Transition `timeout` prop for more infomation.

Source:
  - src/js/bundle.js, line 30763

#### container

A Node, Component instance, or function that returns either. The Modal is appended to it's container element. For the sake of assistive technologies, the container should usually be the document body, so that the rest of the page content can be placed behind a virtual backdrop as well as a visual one.

Source:
  - src/js/bundle.js, line 30683

#### containerClassName

A css class or set of classes applied to the modal container when the modal is open, and removed when it is closed.

Source:
  - src/js/bundle.js, line 30737

#### defaultOverlayShown

The initial visibility state of the Overlay. For more nuanced visibility control, consider using the Overlay component directly.

Source:
  - src/js/bundle.js, line 23292

#### delay

A millisecond delay amount to show and hide the Overlay once triggered

Source:
  - src/js/bundle.js, line 23277

#### delayHide

A millisecond delay amount before hiding the Overlay once triggered.

Source:
  - src/js/bundle.js, line 23285

#### delayShow

A millisecond delay amount before showing the Overlay once triggered.

Source:
  - src/js/bundle.js, line 23281

#### dialogComponentClass

A Component type that provides the modal content Markup. This is a useful prop when you want to use your own styles and markup to create a custom modal component.

Source:
  - src/js/bundle.js, line 20993

#### dialogTransitionTimeout

The `timeout` of the dialog transition if specified. This number is used to ensure that transition callbacks are always fired, even if browser transition events are canceled. See the Transition `timeout` prop for more infomation.

Source:
  - src/js/bundle.js, line 30755

#### enforceFocus

When `true` The modal will prevent focus from leaving the Modal while open. Consider leaving the default value here, as it is necessary to make the Modal work well with assistive technologies, such as screen readers.

Source:
  - src/js/bundle.js, line 21008

#### enforceFocus

When `true` The modal will prevent focus from leaving the Modal while open. Generally this should never be set to `false` as it makes the Modal less accessible to assistive technologies, like screen readers.

Source:
  - src/js/bundle.js, line 30781

#### isPersistent

Checks if this event should be released back into the pool.

Source:
  - src/js/bundle.js, line 46287

#### keyboard

Close the modal when escape key is pressed

Source:
  - src/js/bundle.js, line 30742

#### keyboard

Close the modal when escape key is pressed

Source:
  - src/js/bundle.js, line 20981

#### manager

A ModalManager instance used to track and manage the state of open Modals. Useful when customizing how modals interact within a container

Source:
  - src/js/bundle.js, line 30817

#### onBackdropClick

A callback fired when the backdrop, if specified, is clicked.

Source:
  - src/js/bundle.js, line 30721

#### onEnter

Callback fired before the Modal transitions in

Source:
  - src/js/bundle.js, line 21024

#### onEnter

Callback fired before the Overlay transitions in

Source:
  - src/js/bundle.js, line 23114

#### onEnter

Callback fired before the Modal transitions in

Source:
  - src/js/bundle.js, line 30786

#### onEnter

Callback fired before the Overlay transitions in

Source:
  - src/js/bundle.js, line 31500

#### onEntered

Callback fired after the Modal finishes transitioning in

Source:
  - src/js/bundle.js, line 21034

#### onEntered

Callback fired after the Overlay finishes transitioning in

Source:
  - src/js/bundle.js, line 23124

#### onEntered

Callback fired after the Modal finishes transitioning in

Source:
  - src/js/bundle.js, line 30796

#### onEntered

Callback fired after the Overlay finishes transitioning in

Source:
  - src/js/bundle.js, line 31510

#### onEntering

Callback fired as the Modal begins to transition in

Source:
  - src/js/bundle.js, line 30791

#### onEntering

Callback fired as the Overlay begins to transition in

Source:
  - src/js/bundle.js, line 23119

#### onEntering

Callback fired as the Overlay begins to transition in

Source:
  - src/js/bundle.js, line 31505

#### onEntering

Callback fired as the Modal begins to transition in

Source:
  - src/js/bundle.js, line 21029

#### onEscapeKeyUp

A callback fired when the escape key, if specified in `keyboard`, is pressed.

Source:
  - src/js/bundle.js, line 30716

#### onExit

Callback fired right before the Modal transitions out

Source:
  - src/js/bundle.js, line 21039

#### onExit

Callback fired right before the Overlay transitions out

Source:
  - src/js/bundle.js, line 31515

#### onExit

Callback fired right before the Modal transitions out

Source:
  - src/js/bundle.js, line 30801

#### onExit

Callback fired right before the Overlay transitions out

Source:
  - src/js/bundle.js, line 23129

#### onExited

Callback fired after the Overlay finishes transitioning out

Source:
  - src/js/bundle.js, line 23139

#### onExited

Callback fired after the Overlay finishes transitioning out

Source:
  - src/js/bundle.js, line 31525

#### onExited

Callback fired after the Modal finishes transitioning out

Source:
  - src/js/bundle.js, line 30811

#### onExited

Callback fired after the Modal finishes transitioning out

Source:
  - src/js/bundle.js, line 21049

#### onExiting

Callback fired as the Overlay begins to transition out

Source:
  - src/js/bundle.js, line 31520

#### onExiting

Callback fired as the Overlay begins to transition out

Source:
  - src/js/bundle.js, line 23134

#### onExiting

Callback fired as the Modal begins to transition out

Source:
  - src/js/bundle.js, line 21044

#### onExiting

Callback fired as the Modal begins to transition out

Source:
  - src/js/bundle.js, line 30806

#### onHide

A callback fired when the header closeButton or non-static backdrop is clicked. Required if either are specified.

Source:
  - src/js/bundle.js, line 21019

#### onHide

A callback invoked by the overlay when it wishes to be hidden. Required if `rootClose` is specified.

Source:
  - src/js/bundle.js, line 23104

#### onHide

A callback fired when either the backdrop is clicked, or the escape key is pressed. The `onHide` callback only signals intent from the Modal, you must actually set the `show` prop to `false` for the Modal to close.

Source:
  - src/js/bundle.js, line 30696

#### onShow

A callback fired when the Modal is opening.

Source:
  - src/js/bundle.js, line 30688

#### overlay

An element or text to overlay next to the target.

Source:
  - src/js/bundle.js, line 23297

#### placement

Sets the direction of the Overlay.

Source:
  - src/js/bundle.js, line 23144

#### ReactEventListener

Injectable event backend

Source:
  - src/js/bundle.js, line 37293

#### renderBackdrop

A function that returns a backdrop component. Useful for custom backdrop rendering. ```js renderBackdrop={props => <MyBackdrop {...props} />} ```

Source:
  - src/js/bundle.js, line 30711

#### rootClose

Specify whether the overlay should trigger onHide when the user clicks outside the overlay

Source:
  - src/js/bundle.js, line 23099

#### rootClose

Specify whether the overlay should trigger `onHide` when the user clicks outside the overlay

Source:
  - src/js/bundle.js, line 31469

#### show

Set the visibility of the Modal

Source:
  - src/js/bundle.js, line 30675

#### show

Set the visibility of the Overlay

Source:
  - src/js/bundle.js, line 31464

#### show

When `true` The modal will show itself.

Source:
  - src/js/bundle.js, line 21013

#### show

Set the visibility of the Overlay

Source:
  - src/js/bundle.js, line 23095

#### tabClassName

tabClassName is used as className for the associated NavItem

Source:
  - src/js/bundle.js, line 25758

#### title

The content of the split button.

Source:
  - src/js/bundle.js, line 25584

#### toggleLabel

Accessible label for the toggle; the value of `title` if not specified.

Source:
  - src/js/bundle.js, line 25588

#### transition

A `<Transition/>` component used to animate the overlay changes visibility.

Source:
  - src/js/bundle.js, line 31495

#### transition

A `<Transition/>` component to use for the dialog and backdrop components.

Source:
  - src/js/bundle.js, line 30747

#### trigger

Specify which action or actions trigger Overlay visibility

Source:
  - src/js/bundle.js, line 23272

### Methods

#### componentWillReceiveProps()

If a prop switches from controlled to Uncontrolled reset its value to the defaultValue

Source:
  - src/js/bundle.js, line 32971

#### destructor()

`PooledClass` looks for `destructor` on each instance it releases.

Source:
  - src/js/bundle.js, line 46292

#### ensureScrollValueMonitoring()

Listens to window scroll and resize events. We cache scroll values so that application code can access them without triggering reflows. ViewportMetrics is only used by SyntheticMouse/TouchEvent and only when pageX/pageY isn't supported (legacy browsers). NOTE: Scroll events do not bubble.

Source:
  - src/js/bundle.js, line 37425
See:
  - http://www.quirksmode.org/dom/events/scroll.html

#### getData() → {string}

Determine the differing substring between the initially stored text content and the current content.

Source:
  - src/js/bundle.js, line 36538

##### Returns:

Type
  string

#### getText() → {string}

Get current text of input.

Source:
  - src/js/bundle.js, line 36525

##### Returns:

Type
  string

#### isEnabled() → {boolean}

Source:
  - src/js/bundle.js, line 37319

##### Returns:

True if callbacks are enabled.

Type
  boolean

#### isExpanded(keypath, value) → {Boolean}

Decide whether the leaf node at given `keypath` should be expanded initially.

##### Parameters:

Name | Type | Description
--- | --- | ---
`keypath` | String |
`value` | Any |

Source:
  - src/js/bundle.js, line 50581

##### Returns:

Type
  Boolean

#### listenTo(registrationName, contentDocumentHandle)

We listen for bubbled touch events on the document object. Firefox v8.01 (and possibly others) exhibited strange behavior when mounting `onmousemove` events at some node that was not the document element. The symptoms were that if your mouse is not moving over something contained within that mount point (for example on the background) the top-level listeners for `onmousemove` won't be called. However, if you register the `mousemove` on the document object, then it will of course catch all `mousemove`s. This along with iOS quirks, justifies restricting top-level listeners to the document object only, at least for these movement types of events and possibly all events.

##### Parameters:

Name | Type | Description
--- | --- | ---
`registrationName` | string | Name of listener (e.g. `onClick`).
`contentDocumentHandle` | object | Document which owns the container

Source:
  - src/js/bundle.js, line 37344
See:
  - http://www.quirksmode.org/blog/archives/2010/09/click_event_del.html Also, `keyup`/`keypress`/`keydown` do not bubble to the window on IE, but they bubble to document.

#### mountComponent(transaction) → {string}

Creates the markup for this text node. This node is not intended to have any features besides containing text content.

##### Parameters:

Name | Type | Description
--- | --- | ---
`transaction` | ReactReconcileTransaction | ReactServerRenderingTransaction |

Source:
  - src/js/bundle.js, line 41076

##### Returns:

Markup for this text node.

Type
  string

#### onHide()

A Callback fired by the Overlay when it wishes to be hidden. __required__ when `rootClose` is `true`.

Source:
  - src/js/bundle.js, line 31478

#### persist()

We release all dispatched `SyntheticEvent`s after each event loop, adding them back into the pool. This allows a way to hold onto a reference that won't be added back into the pool.

Source:
  - src/js/bundle.js, line 46278

#### receiveComponent(nextText, transaction)

Updates this component by updating the text content.

##### Parameters:

Name | Type | Description
--- | --- | ---
`nextText` | ReactText | The next text content
`transaction` | ReactReconcileTransaction |

Source:
  - src/js/bundle.js, line 41130

#### setEnabled(enabled)

Sets whether or not any created callbacks should be enabled.

##### Parameters:

Name | Type | Description
--- | --- | ---
`enabled` | boolean | True if callbacks should be enabled.

Source:
  - src/js/bundle.js, line 37310

#### supportsEventPageXY()

Protect against document.createEvent() returning null Some popup blocker extensions appear to do this: https://github.com/facebook/react/issues/6887

Source:
  - src/js/bundle.js, line 37406