Members
animation
Use animation
- Source:
animation
Open and close the Modal with a slide and fade animation.
- Source:
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:
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:
backdrop
Include a backdrop component.
- Source:
backdrop
Include a backdrop component. Specify 'static' for a backdrop that doesn't
trigger an "onHide" when clicked.
- Source:
backdropClassName
A css class or classes for the backdrop component.
- Source:
backdropStyle
A style object for the backdrop component.
- Source:
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:
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:
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:
defaultOverlayShown
The initial visibility state of the Overlay. For more nuanced visibility
control, consider using the Overlay component directly.
- Source:
delay
A millisecond delay amount to show and hide the Overlay once triggered
- Source:
delayHide
A millisecond delay amount before hiding the Overlay once triggered.
- Source:
delayShow
A millisecond delay amount before showing the Overlay once triggered.
- Source:
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:
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:
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:
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:
isPersistent
Checks if this event should be released back into the pool.
- Source:
keyboard
Close the modal when escape key is pressed
- Source:
keyboard
Close the modal when escape key is pressed
- Source:
manager
A ModalManager instance used to track and manage the state of open
Modals. Useful when customizing how modals interact within a container
- Source:
onBackdropClick
A callback fired when the backdrop, if specified, is clicked.
- Source:
onEnter
Callback fired before the Modal transitions in
- Source:
onEnter
Callback fired before the Overlay transitions in
- Source:
onEnter
Callback fired before the Modal transitions in
- Source:
onEnter
Callback fired before the Overlay transitions in
- Source:
onEntered
Callback fired after the Modal finishes transitioning in
- Source:
onEntered
Callback fired after the Overlay finishes transitioning in
- Source:
onEntered
Callback fired after the Modal finishes transitioning in
- Source:
onEntered
Callback fired after the Overlay finishes transitioning in
- Source:
onEntering
Callback fired as the Modal begins to transition in
- Source:
onEntering
Callback fired as the Overlay begins to transition in
- Source:
onEntering
Callback fired as the Overlay begins to transition in
- Source:
onEntering
Callback fired as the Modal begins to transition in
- Source:
onEscapeKeyUp
A callback fired when the escape key, if specified in `keyboard`, is pressed.
- Source:
onExit
Callback fired right before the Modal transitions out
- Source:
onExit
Callback fired right before the Overlay transitions out
- Source:
onExit
Callback fired right before the Modal transitions out
- Source:
onExit
Callback fired right before the Overlay transitions out
- Source:
onExited
Callback fired after the Overlay finishes transitioning out
- Source:
onExited
Callback fired after the Overlay finishes transitioning out
- Source:
onExited
Callback fired after the Modal finishes transitioning out
- Source:
onExited
Callback fired after the Modal finishes transitioning out
- Source:
onExiting
Callback fired as the Overlay begins to transition out
- Source:
onExiting
Callback fired as the Overlay begins to transition out
- Source:
onExiting
Callback fired as the Modal begins to transition out
- Source:
onExiting
Callback fired as the Modal begins to transition out
- Source:
onHide
A callback fired when the header closeButton or non-static backdrop is
clicked. Required if either are specified.
- Source:
onHide
A callback invoked by the overlay when it wishes to be hidden. Required if
`rootClose` is specified.
- Source:
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:
onShow
A callback fired when the Modal is opening.
- Source:
overlay
An element or text to overlay next to the target.
- Source:
placement
Sets the direction of the Overlay.
- Source:
ReactEventListener
Injectable event backend
- Source:
renderBackdrop
A function that returns a backdrop component. Useful for custom
backdrop rendering.
```js
renderBackdrop={props =>
- Source:
rootClose
Specify whether the overlay should trigger onHide when the user clicks outside the overlay
- Source:
rootClose
Specify whether the overlay should trigger `onHide` when the user clicks outside the overlay
- Source:
show
Set the visibility of the Modal
- Source:
show
Set the visibility of the Overlay
- Source:
show
When `true` The modal will show itself.
- Source:
show
Set the visibility of the Overlay
- Source:
tabClassName
tabClassName is used as className for the associated NavItem
- Source:
title
The content of the split button.
- Source:
toggleLabel
Accessible label for the toggle; the value of `title` if not specified.
- Source:
transition
A `
- Source:
transition
A `
- Source:
trigger
Specify which action or actions trigger Overlay visibility
- Source:
Methods
componentWillReceiveProps()
If a prop switches from controlled to Uncontrolled
reset its value to the defaultValue
- Source:
destructor()
`PooledClass` looks for `destructor` on each instance it releases.
- Source:
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.
getData() → {string}
Determine the differing substring between the initially stored
text content and the current content.
- Source:
Returns:
- Type
- string
getText() → {string}
Get current text of input.
- Source:
Returns:
- Type
- string
isEnabled() → {boolean}
- Source:
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:
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:
- See:
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:
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:
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:
receiveComponent(nextText, transaction)
Updates this component by updating the text content.
Parameters:
| Name | Type | Description |
|---|---|---|
nextText |
ReactText | The next text content |
transaction |
ReactReconcileTransaction |
- Source:
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:
supportsEventPageXY()
Protect against document.createEvent() returning null
Some popup blocker extensions appear to do this:
https://github.com/facebook/react/issues/6887
- Source: