React Popup API

The Popup UI component is a pop-up window overlaying the current view.

import Popup from "devextreme-react/popup"

Type: PopupTypes.default

Configuration

An object defining configuration properties for the Popup UI component.

Name	Description
accessKey	Specifies the shortcut key that sets focus on the UI component.
animation	Configures UI component visibility animations. This object contains two fields: show and hide.
closeOnOutsideClick	Specifies whether to close the UI component if a user clicks outside it.
container	Specifies the container in which to render the UI component.
contentComponent	An alias for the contentTemplate property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.
contentRender	An alias for the contentTemplate property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.
contentTemplate	Specifies a custom template for the UI component content.
deferRendering	Specifies whether to render the UI component's content when it is displayed. If false, the content is rendered immediately.
disabled	Specifies whether the UI component responds to user interaction.
dragEnabled	Specifies whether or not to allow a user to drag the popup window.
elementAttr	Specifies the global attributes to be attached to the UI component's container element.
focusStateEnabled	Specifies whether the UI component can be focused using keyboard navigation.
fullScreen	Specifies whether to display the Popup in full-screen mode.
height	Specifies the UI component's height in pixels.
hint	Specifies text for a hint that appears when a user pauses on the UI component.
hoverStateEnabled	Specifies whether the UI component changes its state when a user pauses on it.
maxHeight	Specifies the maximum height the UI component can reach while resizing.
maxWidth	Specifies the maximum width the UI component can reach while resizing.
minHeight	Specifies the minimum height the UI component can reach while resizing.
minWidth	Specifies the minimum width the UI component can reach while resizing.
onContentReady	A function that is executed when the UI component's content is ready and each time the content is changed.
onDisposing	A function that is executed before the UI component is disposed of.
onHidden	A function that is executed after the UI component is hidden.
onHiding	A function that is executed before the UI component is hidden.
onInitialized	A function used in JavaScript frameworks to save the UI component instance.
onOptionChanged	A function that is executed after a UI component property is changed.
onResize	A function that is executed each time the UI component is resized by one pixel.
onResizeEnd	A function that is executed when resizing ends.
onResizeStart	A function that is executed when resizing starts.
onShowing	A function that is executed before the UI component is displayed.
onShown	A function that is executed after the UI component is displayed.
onTitleRendered	A function that is executed when the UI component's title is rendered.
position	Positions the UI component.
resizeEnabled	Specifies whether or not an end user can resize the UI component.
rtlEnabled	Switches the UI component to a right-to-left representation.
shading	Specifies whether to shade the background when the UI component is active.
shadingColor	Specifies the shading color. Applies only if shading is enabled.
showCloseButton	Specifies whether or not the UI component displays the Close button.
showTitle	A Boolean value specifying whether or not to display the title in the popup window.
tabIndex	Specifies the number of the element when the Tab key is used for navigating.
title	The title in the overlay window.
titleComponent	An alias for the titleTemplate property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.
titleRender	An alias for the titleTemplate property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.
titleTemplate	Specifies a custom template for the UI component title. Does not apply if the title is defined.
toolbarItems	Configures toolbar items.
visible	A Boolean value specifying whether or not the UI component is visible.
width	Specifies the UI component's width in pixels.

Methods

This section describes members used to manipulate the UI component.

Name	Description
beginUpdate()	Prevents the UI component from refreshing until the endUpdate() method is called.
content()	Gets the UI component's content.
defaultOptions(rule)	Specifies the device-dependent default configuration properties for this component.
dispose()	Disposes of all the resources allocated to the Popup instance.
element()	Gets the root UI component element.
endUpdate()	Refreshes the UI component after a call of the beginUpdate() method.
focus()	Sets focus on the UI component.
getInstance(element)	Gets the instance of a UI component found using its DOM node.
hide()	Hides the UI component.
instance()	Gets the UI component's instance. Use it to access other methods of the UI component.
off(eventName)	Detaches all event handlers from a single event.
off(eventName, eventHandler)	Detaches a particular event handler from a single event.
on(eventName, eventHandler)	Subscribes to an event.
on(events)	Subscribes to events.
option()	Gets all UI component properties.
option(optionName)	Gets the value of a single property.
option(optionName, optionValue)	Updates the value of a single property.
option(options)	Updates the values of several properties.
registerKeyHandler(key, handler)	Registers a handler to be executed when a user presses a specific key.
repaint()	Recalculates the UI component's size and position without rerendering.
resetOption(optionName)	Resets a property to its default value.
show()	Shows the UI component.
toggle(showing)	Shows or hides the UI component depending on the argument.

Events

This section describes events fired by this UI component.

Name	Description
contentReady	Raised when the UI component's content is ready.
disposing	Raised before the UI component is disposed of.
hidden	Raised after the UI component is hidden.
hiding	Raised before the UI component is hidden.
initialized	Raised only once, after the UI component is initialized.
optionChanged	Raised after a UI component property is changed.
resize	Raised each time the UI component is resized by one pixel.
resizeEnd	Raised when resizing ends.
resizeStart	Raised when resizing starts.
showing	Raised before the UI component is displayed.
shown	Raised after the UI component is displayed.
titleRendered	Raised when the UI component's title is rendered.

React Popup API

See Also

Configuration

See Also

Methods

Events

See Also