yrexpert-js
Version:
L'interface Web pour votre système expert...
4,958 lines (837 loc) • 67 kB
HTML
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Global</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Global</h1>
<section>
<header>
<h2></h2>
</header>
<article>
<div class="container-overview">
<dl class="details">
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="animation"><span class="type-signature"></span>animation<span class="type-signature"></span></h4>
<div class="description">
Use animation
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line23109">line 23109</a>
</li></ul></dd>
</dl>
<h4 class="name" id="animation"><span class="type-signature"></span>animation<span class="type-signature"></span></h4>
<div class="description">
Open and close the Modal with a slide and fade animation.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line20986">line 20986</a>
</li></ul></dd>
</dl>
<h4 class="name" id="autoFocus"><span class="type-signature"></span>autoFocus<span class="type-signature"></span></h4>
<div class="description">
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.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line21001">line 21001</a>
</li></ul></dd>
</dl>
<h4 class="name" id="autoFocus"><span class="type-signature"></span>autoFocus<span class="type-signature"></span></h4>
<div class="description">
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.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line30773">line 30773</a>
</li></ul></dd>
</dl>
<h4 class="name" id="backdrop"><span class="type-signature"></span>backdrop<span class="type-signature"></span></h4>
<div class="description">
Include a backdrop component.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line30701">line 30701</a>
</li></ul></dd>
</dl>
<h4 class="name" id="backdrop"><span class="type-signature"></span>backdrop<span class="type-signature"></span></h4>
<div class="description">
Include a backdrop component. Specify 'static' for a backdrop that doesn't
trigger an "onHide" when clicked.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line20976">line 20976</a>
</li></ul></dd>
</dl>
<h4 class="name" id="backdropClassName"><span class="type-signature"></span>backdropClassName<span class="type-signature"></span></h4>
<div class="description">
A css class or classes for the backdrop component.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line30731">line 30731</a>
</li></ul></dd>
</dl>
<h4 class="name" id="backdropStyle"><span class="type-signature"></span>backdropStyle<span class="type-signature"></span></h4>
<div class="description">
A style object for the backdrop component.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line30726">line 30726</a>
</li></ul></dd>
</dl>
<h4 class="name" id="backdropTransitionTimeout"><span class="type-signature"></span>backdropTransitionTimeout<span class="type-signature"></span></h4>
<div class="description">
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.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line30763">line 30763</a>
</li></ul></dd>
</dl>
<h4 class="name" id="container"><span class="type-signature"></span>container<span class="type-signature"></span></h4>
<div class="description">
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.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line30683">line 30683</a>
</li></ul></dd>
</dl>
<h4 class="name" id="containerClassName"><span class="type-signature"></span>containerClassName<span class="type-signature"></span></h4>
<div class="description">
A css class or set of classes applied to the modal container when the modal is open,
and removed when it is closed.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line30737">line 30737</a>
</li></ul></dd>
</dl>
<h4 class="name" id="defaultOverlayShown"><span class="type-signature"></span>defaultOverlayShown<span class="type-signature"></span></h4>
<div class="description">
The initial visibility state of the Overlay. For more nuanced visibility
control, consider using the Overlay component directly.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line23292">line 23292</a>
</li></ul></dd>
</dl>
<h4 class="name" id="delay"><span class="type-signature"></span>delay<span class="type-signature"></span></h4>
<div class="description">
A millisecond delay amount to show and hide the Overlay once triggered
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line23277">line 23277</a>
</li></ul></dd>
</dl>
<h4 class="name" id="delayHide"><span class="type-signature"></span>delayHide<span class="type-signature"></span></h4>
<div class="description">
A millisecond delay amount before hiding the Overlay once triggered.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line23285">line 23285</a>
</li></ul></dd>
</dl>
<h4 class="name" id="delayShow"><span class="type-signature"></span>delayShow<span class="type-signature"></span></h4>
<div class="description">
A millisecond delay amount before showing the Overlay once triggered.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line23281">line 23281</a>
</li></ul></dd>
</dl>
<h4 class="name" id="dialogComponentClass"><span class="type-signature"></span>dialogComponentClass<span class="type-signature"></span></h4>
<div class="description">
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.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line20993">line 20993</a>
</li></ul></dd>
</dl>
<h4 class="name" id="dialogTransitionTimeout"><span class="type-signature"></span>dialogTransitionTimeout<span class="type-signature"></span></h4>
<div class="description">
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.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line30755">line 30755</a>
</li></ul></dd>
</dl>
<h4 class="name" id="enforceFocus"><span class="type-signature"></span>enforceFocus<span class="type-signature"></span></h4>
<div class="description">
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.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line21008">line 21008</a>
</li></ul></dd>
</dl>
<h4 class="name" id="enforceFocus"><span class="type-signature"></span>enforceFocus<span class="type-signature"></span></h4>
<div class="description">
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.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line30781">line 30781</a>
</li></ul></dd>
</dl>
<h4 class="name" id="isPersistent"><span class="type-signature"></span>isPersistent<span class="type-signature"></span></h4>
<div class="description">
Checks if this event should be released back into the pool.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line46287">line 46287</a>
</li></ul></dd>
</dl>
<h4 class="name" id="keyboard"><span class="type-signature"></span>keyboard<span class="type-signature"></span></h4>
<div class="description">
Close the modal when escape key is pressed
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line30742">line 30742</a>
</li></ul></dd>
</dl>
<h4 class="name" id="keyboard"><span class="type-signature"></span>keyboard<span class="type-signature"></span></h4>
<div class="description">
Close the modal when escape key is pressed
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line20981">line 20981</a>
</li></ul></dd>
</dl>
<h4 class="name" id="manager"><span class="type-signature"></span>manager<span class="type-signature"></span></h4>
<div class="description">
A ModalManager instance used to track and manage the state of open
Modals. Useful when customizing how modals interact within a container
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line30817">line 30817</a>
</li></ul></dd>
</dl>
<h4 class="name" id="onBackdropClick"><span class="type-signature"></span>onBackdropClick<span class="type-signature"></span></h4>
<div class="description">
A callback fired when the backdrop, if specified, is clicked.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line30721">line 30721</a>
</li></ul></dd>
</dl>
<h4 class="name" id="onEnter"><span class="type-signature"></span>onEnter<span class="type-signature"></span></h4>
<div class="description">
Callback fired before the Modal transitions in
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line21024">line 21024</a>
</li></ul></dd>
</dl>
<h4 class="name" id="onEnter"><span class="type-signature"></span>onEnter<span class="type-signature"></span></h4>
<div class="description">
Callback fired before the Overlay transitions in
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line23114">line 23114</a>
</li></ul></dd>
</dl>
<h4 class="name" id="onEnter"><span class="type-signature"></span>onEnter<span class="type-signature"></span></h4>
<div class="description">
Callback fired before the Modal transitions in
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line30786">line 30786</a>
</li></ul></dd>
</dl>
<h4 class="name" id="onEnter"><span class="type-signature"></span>onEnter<span class="type-signature"></span></h4>
<div class="description">
Callback fired before the Overlay transitions in
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line31500">line 31500</a>
</li></ul></dd>
</dl>
<h4 class="name" id="onEntered"><span class="type-signature"></span>onEntered<span class="type-signature"></span></h4>
<div class="description">
Callback fired after the Modal finishes transitioning in
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line21034">line 21034</a>
</li></ul></dd>
</dl>
<h4 class="name" id="onEntered"><span class="type-signature"></span>onEntered<span class="type-signature"></span></h4>
<div class="description">
Callback fired after the Overlay finishes transitioning in
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line23124">line 23124</a>
</li></ul></dd>
</dl>
<h4 class="name" id="onEntered"><span class="type-signature"></span>onEntered<span class="type-signature"></span></h4>
<div class="description">
Callback fired after the Modal finishes transitioning in
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line30796">line 30796</a>
</li></ul></dd>
</dl>
<h4 class="name" id="onEntered"><span class="type-signature"></span>onEntered<span class="type-signature"></span></h4>
<div class="description">
Callback fired after the Overlay finishes transitioning in
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line31510">line 31510</a>
</li></ul></dd>
</dl>
<h4 class="name" id="onEntering"><span class="type-signature"></span>onEntering<span class="type-signature"></span></h4>
<div class="description">
Callback fired as the Modal begins to transition in
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line30791">line 30791</a>
</li></ul></dd>
</dl>
<h4 class="name" id="onEntering"><span class="type-signature"></span>onEntering<span class="type-signature"></span></h4>
<div class="description">
Callback fired as the Overlay begins to transition in
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line23119">line 23119</a>
</li></ul></dd>
</dl>
<h4 class="name" id="onEntering"><span class="type-signature"></span>onEntering<span class="type-signature"></span></h4>
<div class="description">
Callback fired as the Overlay begins to transition in
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line31505">line 31505</a>
</li></ul></dd>
</dl>
<h4 class="name" id="onEntering"><span class="type-signature"></span>onEntering<span class="type-signature"></span></h4>
<div class="description">
Callback fired as the Modal begins to transition in
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line21029">line 21029</a>
</li></ul></dd>
</dl>
<h4 class="name" id="onEscapeKeyUp"><span class="type-signature"></span>onEscapeKeyUp<span class="type-signature"></span></h4>
<div class="description">
A callback fired when the escape key, if specified in `keyboard`, is pressed.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line30716">line 30716</a>
</li></ul></dd>
</dl>
<h4 class="name" id="onExit"><span class="type-signature"></span>onExit<span class="type-signature"></span></h4>
<div class="description">
Callback fired right before the Modal transitions out
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line21039">line 21039</a>
</li></ul></dd>
</dl>
<h4 class="name" id="onExit"><span class="type-signature"></span>onExit<span class="type-signature"></span></h4>
<div class="description">
Callback fired right before the Overlay transitions out
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line31515">line 31515</a>
</li></ul></dd>
</dl>
<h4 class="name" id="onExit"><span class="type-signature"></span>onExit<span class="type-signature"></span></h4>
<div class="description">
Callback fired right before the Modal transitions out
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line30801">line 30801</a>
</li></ul></dd>
</dl>
<h4 class="name" id="onExit"><span class="type-signature"></span>onExit<span class="type-signature"></span></h4>
<div class="description">
Callback fired right before the Overlay transitions out
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line23129">line 23129</a>
</li></ul></dd>
</dl>
<h4 class="name" id="onExited"><span class="type-signature"></span>onExited<span class="type-signature"></span></h4>
<div class="description">
Callback fired after the Overlay finishes transitioning out
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line23139">line 23139</a>
</li></ul></dd>
</dl>
<h4 class="name" id="onExited"><span class="type-signature"></span>onExited<span class="type-signature"></span></h4>
<div class="description">
Callback fired after the Overlay finishes transitioning out
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line31525">line 31525</a>
</li></ul></dd>
</dl>
<h4 class="name" id="onExited"><span class="type-signature"></span>onExited<span class="type-signature"></span></h4>
<div class="description">
Callback fired after the Modal finishes transitioning out
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line30811">line 30811</a>
</li></ul></dd>
</dl>
<h4 class="name" id="onExited"><span class="type-signature"></span>onExited<span class="type-signature"></span></h4>
<div class="description">
Callback fired after the Modal finishes transitioning out
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line21049">line 21049</a>
</li></ul></dd>
</dl>
<h4 class="name" id="onExiting"><span class="type-signature"></span>onExiting<span class="type-signature"></span></h4>
<div class="description">
Callback fired as the Overlay begins to transition out
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line31520">line 31520</a>
</li></ul></dd>
</dl>
<h4 class="name" id="onExiting"><span class="type-signature"></span>onExiting<span class="type-signature"></span></h4>
<div class="description">
Callback fired as the Overlay begins to transition out
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line23134">line 23134</a>
</li></ul></dd>
</dl>
<h4 class="name" id="onExiting"><span class="type-signature"></span>onExiting<span class="type-signature"></span></h4>
<div class="description">
Callback fired as the Modal begins to transition out
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line21044">line 21044</a>
</li></ul></dd>
</dl>
<h4 class="name" id="onExiting"><span class="type-signature"></span>onExiting<span class="type-signature"></span></h4>
<div class="description">
Callback fired as the Modal begins to transition out
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line30806">line 30806</a>
</li></ul></dd>
</dl>
<h4 class="name" id="onHide"><span class="type-signature"></span>onHide<span class="type-signature"></span></h4>
<div class="description">
A callback fired when the header closeButton or non-static backdrop is
clicked. Required if either are specified.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line21019">line 21019</a>
</li></ul></dd>
</dl>
<h4 class="name" id="onHide"><span class="type-signature"></span>onHide<span class="type-signature"></span></h4>
<div class="description">
A callback invoked by the overlay when it wishes to be hidden. Required if
`rootClose` is specified.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line23104">line 23104</a>
</li></ul></dd>
</dl>
<h4 class="name" id="onHide"><span class="type-signature"></span>onHide<span class="type-signature"></span></h4>
<div class="description">
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.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line30696">line 30696</a>
</li></ul></dd>
</dl>
<h4 class="name" id="onShow"><span class="type-signature"></span>onShow<span class="type-signature"></span></h4>
<div class="description">
A callback fired when the Modal is opening.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line30688">line 30688</a>
</li></ul></dd>
</dl>
<h4 class="name" id="overlay"><span class="type-signature"></span>overlay<span class="type-signature"></span></h4>
<div class="description">
An element or text to overlay next to the target.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line23297">line 23297</a>
</li></ul></dd>
</dl>
<h4 class="name" id="placement"><span class="type-signature"></span>placement<span class="type-signature"></span></h4>
<div class="description">
Sets the direction of the Overlay.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line23144">line 23144</a>
</li></ul></dd>
</dl>
<h4 class="name" id="ReactEventListener"><span class="type-signature"></span>ReactEventListener<span class="type-signature"></span></h4>
<div class="description">
Injectable event backend
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line37293">line 37293</a>
</li></ul></dd>
</dl>
<h4 class="name" id="renderBackdrop"><span class="type-signature"></span>renderBackdrop<span class="type-signature"></span></h4>
<div class="description">
A function that returns a backdrop component. Useful for custom
backdrop rendering.
```js
renderBackdrop={props => <MyBackdrop {...props} />}
```
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line30711">line 30711</a>
</li></ul></dd>
</dl>
<h4 class="name" id="rootClose"><span class="type-signature"></span>rootClose<span class="type-signature"></span></h4>
<div class="description">
Specify whether the overlay should trigger onHide when the user clicks outside the overlay
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line23099">line 23099</a>
</li></ul></dd>
</dl>
<h4 class="name" id="rootClose"><span class="type-signature"></span>rootClose<span class="type-signature"></span></h4>
<div class="description">
Specify whether the overlay should trigger `onHide` when the user clicks outside the overlay
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line31469">line 31469</a>
</li></ul></dd>
</dl>
<h4 class="name" id="show"><span class="type-signature"></span>show<span class="type-signature"></span></h4>
<div class="description">
Set the visibility of the Modal
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line30675">line 30675</a>
</li></ul></dd>
</dl>
<h4 class="name" id="show"><span class="type-signature"></span>show<span class="type-signature"></span></h4>
<div class="description">
Set the visibility of the Overlay
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line31464">line 31464</a>
</li></ul></dd>
</dl>
<h4 class="name" id="show"><span class="type-signature"></span>show<span class="type-signature"></span></h4>
<div class="description">
When `true` The modal will show itself.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line21013">line 21013</a>
</li></ul></dd>
</dl>
<h4 class="name" id="show"><span class="type-signature"></span>show<span class="type-signature"></span></h4>
<div class="description">
Set the visibility of the Overlay
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line23095">line 23095</a>
</li></ul></dd>
</dl>
<h4 class="name" id="tabClassName"><span class="type-signature"></span>tabClassName<span class="type-signature"></span></h4>
<div class="description">
tabClassName is used as className for the associated NavItem
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line25758">line 25758</a>
</li></ul></dd>
</dl>
<h4 class="name" id="title"><span class="type-signature"></span>title<span class="type-signature"></span></h4>
<div class="description">
The content of the split button.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line25584">line 25584</a>
</li></ul></dd>
</dl>
<h4 class="name" id="toggleLabel"><span class="type-signature"></span>toggleLabel<span class="type-signature"></span></h4>
<div class="description">
Accessible label for the toggle; the value of `title` if not specified.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line25588">line 25588</a>
</li></ul></dd>
</dl>
<h4 class="name" id="transition"><span class="type-signature"></span>transition<span class="type-signature"></span></h4>
<div class="description">
A `<Transition/>` component used to animate the overlay changes visibility.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line31495">line 31495</a>
</li></ul></dd>
</dl>
<h4 class="name" id="transition"><span class="type-signature"></span>transition<span class="type-signature"></span></h4>
<div class="description">
A `<Transition/>` component to use for the dialog and backdrop components.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line30747">line 30747</a>
</li></ul></dd>
</dl>
<h4 class="name" id="trigger"><span class="type-signature"></span>trigger<span class="type-signature"></span></h4>
<div class="description">
Specify which action or actions trigger Overlay visibility
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line23272">line 23272</a>
</li></ul></dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="componentWillReceiveProps"><span class="type-signature"></span>componentWillReceiveProps<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
If a prop switches from controlled to Uncontrolled
reset its value to the defaultValue
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line32971">line 32971</a>
</li></ul></dd>
</dl>
<h4 class="name" id="destructor"><span class="type-signature"></span>destructor<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
`PooledClass` looks for `destructor` on each instance it releases.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line46292">line 46292</a>
</li></ul></dd>
</dl>
<h4 class="name" id="ensureScrollValueMonitoring"><span class="type-signature"></span>ensureScrollValueMonitoring<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
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.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line37425">line 37425</a>
</li></ul></dd>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="http://www.quirksmode.org/dom/events/scroll.html">http://www.quirksmode.org/dom/events/scroll.html</a></li>
</ul>
</dd>
</dl>
<h4 class="name" id="getData"><span class="type-signature"></span>getData<span class="signature">()</span><span class="type-signature"> → {string}</span></h4>
<div class="description">
Determine the differing substring between the initially stored
text content and the current content.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line36538">line 36538</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
<h4 class="name" id="getText"><span class="type-signature"></span>getText<span class="signature">()</span><span class="type-signature"> → {string}</span></h4>
<div class="description">
Get current text of input.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line36525">line 36525</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
<h4 class="name" id="isEnabled"><span class="type-signature"></span>isEnabled<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_js_bundle.js.html">src/js/bundle.js</a>, <a href="src_js_bundle.js.html#line37319">line 37319</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<d