Angular Popover Properties
See Also
closeOnOutsideClick
Use the hideOnOutsideClick property instead.
Specifies whether to close the UI component if a user clicks outside the popover window or outside the target element.
Event (jQuery or EventObject)
The event that caused UI component closing. It is a EventObject or a jQuery.Event when you use jQuery.
container
This property accepts one of the following values:
A CSS selector, or a jQuery selector if you use jQuery
jQuery
index.js$(function(){ $("#popoverContainer").dxPopover({ // ... container: '#containerElement' }); });
Angular
app.component.html<dx-popover ... container="#containerElement" > </dx-popover>
Vue
App.vue<template> <DxPopover ... container="#containerElement" > </DxPopover> </template> <script> import { DxPopover } from 'devextreme-vue/popover'; export default { components: { DxPopover } }; </script>
React
App.jsimport Popover from 'devextreme-react/popover'; // ... function App() { return ( <Popover ... container="#containerElement" > </Popover> ); }
A jQuery wrapper
jQuery
index.js$(function(){ $("#popoverContainer").dxPopover({ // ... container: $('#containerElement') }); });
A DOM element
jQuery
index.js$(function(){ $("#popoverContainer").dxPopover({ // ... container: document.getElementById('#containerElement') }); });
Angular
app.component.htmlapp.component.ts<dx-popover ... [container]="containerElement" > </dx-popover>
// ... export class AppComponent { containerElement: Element; constructor() { this.containerElement = document.getElementById('#containerElement') as Element; } }
Vue
App.vue<template> <DxPopover ... :container="containerElement" > </DxPopover> </template> <script> import { DxPopover } from 'devextreme-vue/popover'; export default { components: { DxPopover }, data() { return { containerElement: null } }, mounted() { this.containerElement = document.getElementById('containerElement'); } }; </script>
React
App.jsimport React, { useEffect, useState } from 'react'; import Popover from 'devextreme-react/popover'; // ... function App() { const [containerElement, setContainerElement] = useState(null); useEffect(() => { setContainerElement(document.getElementById('containerElement')); }, []); return ( <Popover ... container={containerElement} > </Popover> ); }
The UI component defines the default container on its initialization. This default container can be one of the following (if the element is absent, the component selects the next one):
.dx-viewport
body
copyRootClassesToWrapper
This property allows you to use CSS for wrapper element configuration. You can customize the shade, resize, and drag zones.
The following markup illustrates relations between wrapper and root elements when you set copyRootClassesToWrapper to true:
<body> <!-- The following element is the root element on which the component is initialized. --> <!-- Specify classes to be copied to the wrapper element here. --> <div id="popover" class="custom-class" ... ></div> <!-- The following element is the wrapper element. --> <!-- Custom classes are automatically copied from the root element. --> <div class="dx-overlay-wrapper dx-popover-wrapper custom-class" ... > <!-- The following element contains component content. --> <div class="dx-overlay-content" ... > <!-- ... --> </div> </div> </body>
deferRendering
Specifies whether to render the UI component's content when it is displayed. If false, the content is rendered immediately.
elementAttr
Use the wrapperAttr property instead.
Specifies the global attributes to be attached to the UI component's container element.
jQuery
$(function(){ $("#popoverContainer").dxPopover({ // ... elementAttr: { id: "elementId", class: "class-name" } }); });
Angular
<dx-popover ... [elementAttr]="{ id: 'elementId', class: 'class-name' }"> </dx-popover>
import { DxPopoverModule } from "devextreme-angular"; // ... export class AppComponent { // ... } @NgModule({ imports: [ // ... DxPopoverModule ], // ... })
Vue
<template> <DxPopover ... :element-attr="popoverAttributes"> </DxPopover> </template> <script> import DxPopover from 'devextreme-vue/popover'; export default { components: { DxPopover }, data() { return { popoverAttributes: { id: 'elementId', class: 'class-name' } } } } </script>
React
import React from 'react'; import Popover from 'devextreme-react/popover'; class App extends React.Component { popoverAttributes = { id: 'elementId', class: 'class-name' } render() { return ( <Popover ... elementAttr={this.popoverAttributes}> </Popover> ); } } export default App;
height
This property accepts a value of one of the following types:
Number
The height in pixels.String
A CSS-accepted measurement of height. For example,"55px"
,"20vh"
,"80%"
,"inherit"
.Function (deprecated since v21.2)
Refer to the W0017 warning description for information on how you can migrate to viewport units.
The Popover calculates its height relative to the window.
hideOnOutsideClick
Specifies whether to hide the UI component if a user clicks outside the popover window or outside the target element.
Event (jQuery or EventObject)
The event that caused UI component hiding. It is a EventObject or a jQuery.Event when you use jQuery.
The function passed to this property enables you to specify a custom condition for UI component hiding. For instance, you can prevent hiding until a user clicks a certain element.
jQuery
$(function () { $("#popoverContainer").dxPopover({ // ... hideOnOutsideClick: function(e) { return e.target === $("#someElement").get()[0]; } }); });
Angular
import { DxPopoverModule } from "devextreme-angular"; // ... export class AppComponent { // ... hideOnOutsideClick(e) { return e.target === document.getElementById("someElement"); } } @NgModule({ imports: [ // ... DxPopoverModule ], // ... })
<dx-popover ... [hideOnOutsideClick]="hideOnOutsideClick"> </dx-popover>
Vue
<template> <DxPopover .... :hide-on-outside-click="hideOnOutsideClick"> </DxPopover> </template> <script> import 'devextreme/dist/css/dx.light.css'; import DxPopover from 'devextreme-vue/popover'; export default { components: { DxPopover }, methods: { hideOnOutsideClick (e) { return e.target === document.getElementById("someElement"); } } } </script>
React
import React from 'react'; import 'devextreme/dist/css/dx.light.css'; import Popover from 'devextreme-react/popover'; const hideOnOutsideClick = (e) => { return e.target === document.getElementById("someElement"); }; export default function App() { return ( <Popover ... hideOnOutsideClick={hideOnOutsideClick}> </Popover> ); }
The hideOnOutsideClick function is called when a user clicks the UI component or outside it.
maxHeight
This property accepts a value of one of the following types:
Number
The height in pixels.String
A CSS-accepted measurement of height. For example,"55px"
,"20vh"
,"80%"
,"inherit"
.Function (deprecated since v21.2)
Refer to the W0017 warning description for information on how you can migrate to viewport units.
maxWidth
This property accepts a value of one of the following types:
Number
The width in pixels.String
A CSS-accepted measurement of width. For example,"55px"
,"20vw"
,"80%"
,"auto"
,"inherit"
.Function (deprecated since v21.2)
Refer to the W0017 warning description for information on how you can migrate to viewport units.
minHeight
This property accepts a value of one of the following types:
Number
The height in pixels.String
A CSS-accepted measurement of height. For example,"55px"
,"20vh"
,"80%"
,"inherit"
.Function (deprecated since v21.2)
Refer to the W0017 warning description for information on how you can migrate to viewport units.
minWidth
This property accepts a value of one of the following types:
Number
The width in pixels.String
A CSS-accepted measurement of width. For example,"55px"
,"20vw"
,"80%"
,"auto"
,"inherit"
.Function (deprecated since v21.2)
Refer to the W0017 warning description for information on how you can migrate to viewport units.
onContentReady
A function that is executed when the UI component is rendered and each time the component is repainted.
Name | Type | Description |
---|---|---|
model | any |
The model data. Available only if you use Knockout. |
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
onDisposing
A function that is executed before the UI component is disposed of.
Name | Type | Description |
---|---|---|
model | any |
The model data. Available only if you use Knockout. |
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
onHidden
Name | Type | Description |
---|---|---|
model | any |
Model data. Available only if Knockout is used. |
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
onHiding
Name | Type | Description |
---|---|---|
model | any |
Model data. Available only if Knockout is used. |
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
|
cancel |
Set this field to true if you want the Popover to remain visible. |
onInitialized
Name | Type | Description |
---|---|---|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
Angular
<dx-popover ... (onInitialized)="saveInstance($event)"> </dx-popover>
import { Component } from "@angular/core"; import Popover from "devextreme/ui/data_grid"; // ... export class AppComponent { popoverInstance: Popover; saveInstance (e) { this.popoverInstance = e.component; } }
Vue
<template> <div> <DxPopover ... @initialized="saveInstance"> </DxPopover> </div> </template> <script> import DxPopover from 'devextreme-vue/popover'; export default { components: { DxPopover }, data: function() { return { popoverInstance: null }; }, methods: { saveInstance: function(e) { this.popoverInstance = e.component; } } }; </script>
<template> <div> <DxPopover ... @initialized="saveInstance"> </DxPopover> </div> </template> <script setup> import DxPopover from 'devextreme-vue/popover'; let popoverInstance = null; const saveInstance = (e) => { popoverInstance = e.component; } </script>
React
import Popover from 'devextreme-react/popover'; class App extends React.Component { constructor(props) { super(props); this.saveInstance = this.saveInstance.bind(this); } saveInstance(e) { this.popoverInstance = e.component; } render() { return ( <div> <Popover onInitialized={this.saveInstance} /> </div> ); } }
See Also
onOptionChanged
Name | Type | Description |
---|---|---|
value | any |
The modified property's new value. |
previousValue | any |
The UI component's previous value. |
name |
The modified property if it belongs to the first level. Otherwise, the first-level property it is nested into. |
|
model | any |
Model data. Available only if you use Knockout. |
fullName |
The path to the modified property that includes all parent properties. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
The following example shows how to subscribe to component property changes:
jQuery
$(function() { $("#popoverContainer").dxPopover({ // ... onOptionChanged: function(e) { if(e.name === "changedProperty") { // handle the property change here } } }); });
Angular
<dx-popover ... (onOptionChanged)="handlePropertyChange($event)"> </dx-popover>
import { Component } from '@angular/core'; @Component({ selector: 'app-root', templateUrl: './app.component.html', styleUrls: ['./app.component.css'] }) export class AppComponent { // ... handlePropertyChange(e) { if(e.name === "changedProperty") { // handle the property change here } } }
import { BrowserModule } from '@angular/platform-browser'; import { NgModule } from '@angular/core'; import { AppComponent } from './app.component'; import { DxPopoverModule } from 'devextreme-angular'; @NgModule({ declarations: [ AppComponent ], imports: [ BrowserModule, DxPopoverModule ], providers: [ ], bootstrap: [AppComponent] }) export class AppModule { }
Vue
<template> <DxPopover ... @option-changed="handlePropertyChange" /> </template> <script> import 'devextreme/dist/css/dx.light.css'; import DxPopover from 'devextreme-vue/popover'; export default { components: { DxPopover }, // ... methods: { handlePropertyChange: function(e) { if(e.name === "changedProperty") { // handle the property change here } } } } </script>
React
import React from 'react'; import 'devextreme/dist/css/dx.light.css'; import Popover from 'devextreme-react/popover'; const handlePropertyChange = (e) => { if(e.name === "changedProperty") { // handle the property change here } } export default function App() { return ( <Popover ... onOptionChanged={handlePropertyChange} /> ); }
onShowing
Name | Type | Description |
---|---|---|
model | any |
Model data. Available only if Knockout is used. |
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
|
cancel |
Set this field to true if you want to prevent the Popover from being displayed. |
onShown
Name | Type | Description |
---|---|---|
model | any |
Model data. Available only if Knockout is used. |
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
onTitleRendered
A function that is executed when the UI component's title is rendered.
Name | Type | Description |
---|---|---|
model | any |
Model data. Available only if Knockout is used. |
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
position
An object defining UI component positioning properties.
You can use the position.of property and the Popover's target property to specify the element against which the UI component will be positioned. If you set both these properties, position.of takes precedence.
Besides the position configuration object, the property can take on the following string values, which are shortcuts for the corresponding position configuration.
- "top" - places the popover over the target element
- "bottom" - places the popover under the target element
- "left" - places the popover to the left of the target element
- "right" - places the popover to the right of the target element
rtlEnabled
When this property is set to true, the UI component text flows from right to left, and the layout of elements is reversed. To switch the entire application/site to the right-to-left representation, assign true to the rtlEnabled field of the object passed to the DevExpress.config(config) method.
DevExpress.config({ rtlEnabled: true });
shadingColor
Specifies the shading color. Applies only if shading is enabled.
This property supports the following colors:
- Hexadecimal colors
- RGB colors
- RGBA colors
- Predefined/cross-browser color names
- Predefined SVG colors
- Paint server address
showCloseButton
target
This property accepts one of the following values:
A CSS selector, or a jQuery selector if you use jQuery
jQuery
index.js$(function(){ $("#popoverContainer").dxPopover({ // ... target: '#targetElement' }); });
Angular
app.component.html<dx-popover ... target="#targetElement" > </dx-popover>
Vue
App.vue<template> <DxPopover ... target="#targetElement" > </DxPopover> </template> <script> import { DxPopover } from 'devextreme-vue/popover'; export default { components: { DxPopover } }; </script>
React
App.jsimport Popover from 'devextreme-react/popover'; // ... function App() { return ( <Popover ... target="#targetElement" > </Popover> ); }
A jQuery wrapper
jQuery
index.js$(function(){ $("#popoverContainer").dxPopover({ // ... target: $('#targetElement') }); });
A DOM element
jQuery
index.js$(function(){ $("#popoverContainer").dxPopover({ // ... target: document.getElementById('#targetElement') }); });
Angular
app.component.htmlapp.component.ts<dx-popover ... [target]="targetElement" > </dx-popover>
// ... export class AppComponent { targetElement: Element; constructor() { this.targetElement = document.getElementById('#targetElement') as Element; } }
Vue
App.vue<template> <DxPopover ... :target="targetElement" > </DxPopover> </template> <script> import { DxPopover } from 'devextreme-vue/popover'; export default { components: { DxPopover }, data() { return { targetElement: null } }, mounted() { this.targetElement = document.getElementById('targetElement'); } }; </script>
React
App.jsimport React, { useEffect, useState } from 'react'; import Popover from 'devextreme-react/popover'; // ... function App() { const [targetElement, setTargetElement] = useState(null); useEffect(() => { setTargetElement(document.getElementById('targetElement')); }, []); return ( <Popover ... target={targetElement} > </Popover> ); }
To change the Popover position against this element, use the position property.
This property also specifies a target element for the Popover showEvent and hideEvent.
titleTemplate
Specifies a custom template for the UI component title. Does not apply if the title is defined.
toolbarItems[]
In the following code, two items are defined on the toolbar: one is plain text, another is the Button UI component:
jQuery
$(function() { $("#popoverContainer").dxPopover({ // ... toolbarItems: [{ text: "Title", location: "before" }, { widget: "dxButton", location: "after", options: { text: "Refresh", onClick: function(e) { /* ... */ } } }] }); });
<div id="popoverContainer"> <p>Popover content</p> </div>
Angular
<dx-popover ... > <div *dxTemplate="let data of 'content'"> <p>Popover content</p> </div> <dxi-toolbar-item text="Title" location="before"> </dxi-toolbar-item> <dxi-toolbar-item widget="dxButton" location="after" [options]="{ text: 'Refresh', onClick: refresh }"> </dxi-toolbar-item> </dx-popover>
import { Component } from '@angular/core'; @Component({ selector: 'app-root', templateUrl: './app.component.html', styleUrls: ['./app.component.css'] }) export class AppComponent { refresh () { /* ... */ } }
import { BrowserModule } from '@angular/platform-browser'; import { NgModule } from '@angular/core'; import { AppComponent } from './app.component'; import { DxPopoverModule } from 'devextreme-angular'; @NgModule({ declarations: [ AppComponent ], imports: [ BrowserModule, DxPopoverModule ], providers: [], bootstrap: [AppComponent] }) export class AppModule { }
ASP.NET MVC Controls
@(Html.DevExtreme().Popover() <!-- ... --> .ContentTemplate(@<text> <p>Popover content</p> </text>) .ToolbarItems(ti => { ti.Add() .Text("Title") .Location(ToolbarItemLocation.Before); ti.Add() .Widget(w => w.Button() .Text("Refresh") .OnClick("refresh")) .Location(ToolbarItemLocation.After); } ) <script type="text/javascript"> function refresh() { /* ... */ } </script>
Vue
<template> <DxPopover ... > <p>Popover content</p> <DxToolbarItem text="Title" location="before"> </DxToolbarItem> <DxToolbarItem widget="dxButton" :options="buttonOptions" location="after"> </DxToolbarItem> </DxPopover> </template> <script> import 'devextreme/dist/css/dx.light.css'; import DxPopover, { DxToolbarItem } from 'devextreme-vue/popover'; export default { components: { DxPopover }, data() { return { buttonOptions: { text: 'Refresh', onClick: function(e) { /* ... */ } } } } } </script>
React
import React from 'react'; import 'devextreme/dist/css/dx.light.css'; import { Popover, ToolbarItem } from 'devextreme-react/popover'; class App extends React.Component { constructor() { this.buttonOptions = { text: 'Refresh', onClick: function(e) { /* ... */ } }; } render() { return ( <Popover ... > <p>Popover Content</p> <ToolbarItem text="Title" location="before"> </ToolbarItem> <ToolbarItem widget="dxButton" location="after" options={this.buttonOptions}> </ToolbarItem> </Popover> ); } } export default App;
width
This property accepts a value of one of the following types:
Number
The width in pixels.String
A CSS-accepted measurement of width. For example,"55px"
,"20vw"
,"80%"
,"auto"
,"inherit"
.Function (deprecated since v21.2)
Refer to the W0017 warning description for information on how you can migrate to viewport units.
The Popover calculates its width relative to the window.
wrapperAttr
Specifies the global attributes for the UI component's wrapper element.
jQuery
$(function(){ $("#popoverContainer").dxPopover({ // ... wrapperAttr: { id: "elementId", class: "class-name" } }); });
Angular
<dx-popover ... [wrapperAttr]="{ id: 'elementId', class: 'class-name' }"> </dx-popover>
import { Component } from '@angular/core'; // ... @Component({ selector: 'app-root', templateUrl: './app.component.html', styleUrls: ['./app.component.css'] }) export class AppComponent { // ... }
import { BrowserModule } from '@angular/platform-browser'; import { NgModule } from '@angular/core'; import { AppComponent } from './app.component'; import { DxPopoverModule } from 'devextreme-angular'; @NgModule({ declarations: [ AppComponent ], imports: [ BrowserModule, DxPopoverModule ], providers: [ ], bootstrap: [AppComponent] }) export class AppModule { }
Vue
<template> <DxPopover ... :wrapper-attr="popoverAttributes"> </DxPopover> </template> <script> import DxPopover from 'devextreme-vue/popover'; export default { components: { DxPopover }, data() { return { popoverAttributes: { id: 'elementId', class: 'class-name' } } } } </script>
React
import React, { useMemo } from 'react'; import Popover from 'devextreme-react/popover'; function App() { const popoverAttributes = useMemo(() => { return { id: 'elementId', class: 'class-name' } }, []); return ( <Popover ... wrapperAttr={popoverAttributes}> </Popover> ); } export default App;
The code above specifies the id
and class
attributes for the wrapper element and produces markup similar to this:
<body> <!-- The following is the wrapper element. --> <!-- It is nested inside an element defined by the `container` property (`<body>` by default). --> <div id="elementId" class="dx-overlay-wrapper dx-popover-wrapper class-name" ... > <!-- The following element contains component content. --> <div class="dx-overlay-content"> <!-- The following element displays content specified in the `contentTemplate`. --> <div class="dx-popup-content" ... > <!-- ... --> </div> </div> </div> </body>
jQuery
You can specify attributes to the component's root element directly in HTML code:
<div id="myPopover" class="myClass"></div>
Angular
You can specify attributes to the component's root element directly in HTML code:
<dx-popover ... class="myClass"> </dx-popover>
React
You can specify attributes to the component's root element directly in HTML code:
<Popover ... className="myClass" />
ASP.NET Core Controls
To add an attribute to an ASP.NET Core control, use its OnInitialized method:
@(Html.DevExtreme().Popover()... .OnInitialized("(e) => e.element.addClass('myClass')") )
ASP.NET MVC Controls
To add an attribute to an ASP.NET MVC control, use its OnInitialized method:
@(Html.DevExtreme().Popover()... .OnInitialized("(e) => e.element.addClass('myClass')") )
If you have technical questions, please create a support ticket in the DevExpress Support Center.