React Popup API
DevExtreme widgets are integrated with many popular libraries and frameworks. See the Installation section (for JavaScript libraries) or the Prerequisites and Installation section (for ASP.NET MVC framework) to find details on setting up DevExtreme with a particular library or framework.
The following code shows how to create the Popup widget using every supported library and framework. For more details on working with widgets in these libraries and frameworks, see the Widget Basics topic for jQuery, Angular, AngularJS, Knockout or ASP.NET MVC.
jQuery
<div id="popup"> <p>Popup content</p> </div>
$(function () { $("#popup").dxPopup({ title: "Popup Title", visible: true }); });
Angular
<dx-popup title="Popup Title" [(visible)]="isPopupVisible"> <div *dxTemplate="let data of 'content'"> <p>Popup content</p> </div> </dx-popup>
import { DxPopupModule } from "devextreme-angular" // ... export class AppComponent { isPopupVisible = true; } @NgModule({ imports: [ // ... DxPopupModule ], // ... })
AngularJS
<div ng-controller="DemoController"> <div dx-popup="{ title: 'Popup Title', bindingOptions: { visible: 'isPopupVisible' } }"> <p>Popup content</p> </div> </div>
angular.module("DemoApp", ["dx"]) .controller("DemoController", function DemoController($scope) { $scope.isPopupVisible = true; });
Knockout
<div data-bind="dxPopup: { title: 'Popup Title', visible: isPopupVisible }"></div>
var viewModel = { isPopupVisible: ko.observable(true) }; ko.applyBindings(viewModel);
ASP.NET MVC Controls
@(Html.DevExtreme().Popup() .ID("popover") .Title("Popup Title") .Visible(true) .ContentTemplate(@<text> <p>Popup content</p> </text>) )
@Code Html.DevExtreme().Popup() _ .ID("popover") _ .Title("Popup Title") _ .Visible(True) _ .ContentTemplate(Sub() @<text> <p>Popup content</p> </text> End Sub).Render() End Code
See Also
Props
Name | Description |
---|---|
accessKey |
Specifies the shortcut key that sets focus on the widget. |
animation |
Configures widget visibility animations. This object contains two fields: show and hide. |
closeOnBackButton |
A Boolean value specifying whether or not the widget is closed if a user presses the Back hardware button. |
closeOnOutsideClick |
Specifies whether to close the widget if a user clicks outside it. |
container |
Specifies the container in which to place the widget. |
contentTemplate |
Specifies a custom template for the widget content. |
deferRendering |
Specifies whether to render the widget's content when it is displayed. If false, the content is rendered immediately. |
disabled |
Specifies whether the widget responds to user interaction. |
dragEnabled |
Specifies whether or not to allow a user to drag the popup window. |
elementAttr |
Specifies the attributes to be attached to the widget's root element. |
focusStateEnabled |
Specifies whether the widget can be focused using keyboard navigation. |
fullScreen |
A Boolean value specifying whether or not to display the widget in full-screen mode. |
height |
Specifies the widget's height in pixels. |
hint |
Specifies text for a hint that appears when a user pauses on the widget. |
hoverStateEnabled |
Specifies whether the widget changes its state when a user pauses on it. |
maxHeight |
Specifies the maximum height the widget can reach while resizing. |
maxWidth |
Specifies the maximum width the widget can reach while resizing. |
minHeight |
Specifies the minimum height the widget can reach while resizing. |
minWidth |
Specifies the minimum width the widget can reach while resizing. |
onContentReady |
A function that is executed when the widget's content is ready and each time the content is changed. |
onDisposing |
A function that is executed before the widget is disposed of. |
onHidden |
A function that is executed after the widget is hidden. |
onHiding |
A function that is executed before the widget is hidden. |
onInitialized |
A function used in JavaScript frameworks to save the widget instance. |
onOptionChanged |
A function that is executed after a widget option is changed. |
onResize |
A function that is executed each time the widget 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 widget is displayed. |
onShown |
A function that is executed after the widget is displayed. |
onTitleRendered |
A function that is executed when the widget's title is rendered. |
position |
Positions the widget. |
resizeEnabled |
Specifies whether or not an end user can resize the widget. |
rtlEnabled |
Switches the widget to a right-to-left representation. |
shading |
Specifies whether to shade the container when the widget is active. |
shadingColor |
Specifies the shading color. |
showCloseButton |
Specifies whether or not the widget 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. |
titleTemplate |
Specifies a custom template for the widget title. Does not apply if the title is defined. |
toolbarItems |
Configures toolbar items. |
visible |
A Boolean value specifying whether or not the widget is visible. |
width |
Specifies the widget's width in pixels. |
Methods
Name | Description |
---|---|
beginUpdate() |
Prevents the widget from refreshing until the endUpdate() method is called. |
content() |
Gets the widget's content. |
defaultOptions(rule) |
Specifies the device-dependent default configuration options for this component. |
dispose() |
Disposes of all the resources allocated to the Popup instance. |
element() |
Gets the root widget element. |
endUpdate() |
Refreshes the widget after a call of the beginUpdate() method. |
focus() |
Sets focus on the widget. |
getInstance(element) |
Gets the instance of a widget found using its DOM node. |
hide() |
Hides the widget. |
instance() |
Gets the widget's instance. Use it to access other methods of the widget. |
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 widget options. |
option(optionName) |
Gets the value of a single option. |
option(optionName, optionValue) |
Updates the value of a single option. |
option(options) |
Updates the values of several options. |
registerKeyHandler(key, handler) |
Registers a handler to be executed when a user presses a specific key. |
repaint() |
Recalculates the widget's size and position without rerendering. |
show() |
Shows the widget. |
toggle(showing) |
Shows or hides the widget depending on the argument. |
Events
Name | Description |
---|---|
contentReady |
Raised when the widget's content is ready. |
disposing |
Raised before the widget is disposed of. |
hidden |
Raised after the widget is hidden. |
hiding |
Raised before the widget is hidden. |
initialized |
Raised only once, after the widget is initialized. |
optionChanged |
Raised after a widget option is changed. |
resize |
Raised each time the widget is resized by one pixel. |
resizeEnd |
Raised when resizing ends. |
resizeStart |
Raised when resizing starts. |
showing |
Raised before the widget is displayed. |
shown |
Raised after the widget is displayed. |
titleRendered |
Raised when the widget's title is rendered. |
If you have technical questions, please create a support ticket in the DevExpress Support Center.