An object defining configuration properties for the Popover UI component.
Configures UI component visibility animations. This object contains two fields: show and hide.
The following code specifies the default value of the object:
{ show: { type: 'fade', from: 0, to: 1 }, hide: { type: 'fade', from: 1, to: 0 } }
Set this object to null
or undefined
to disable animations.
Specifies the container in which to render the UI component.
This property accepts one of the following values:
A CSS selector, or a jQuery selector if you use jQuery
jQuery$(function(){ $("#popoverContainer").dxPopover({ // ... container: '#containerElement' }); });Angular
<dx-popover ... container="#containerElement" > </dx-popover>Vue
<template> <DxPopover ... container="#containerElement" > </DxPopover> </template> <script> import { DxPopover } from 'devextreme-vue/popover'; export default { components: { DxPopover } }; </script>React
import Popover from 'devextreme-react/popover'; // ... function App() { return ( <Popover ... container="#containerElement" > </Popover> ); }
A jQuery wrapper
jQuery$(function(){ $("#popoverContainer").dxPopover({ // ... container: $('#containerElement') }); });
A DOM element
jQuery$(function(){ $("#popoverContainer").dxPopover({ // ... container: document.getElementById('#containerElement') }); });Angular
<dx-popover ... [container]="containerElement" > </dx-popover>
// ... export class AppComponent { containerElement: Element; constructor() { this.containerElement = document.getElementById('#containerElement') as Element; } }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
import 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
Specifies a custom template for the UI component content.
Specifies whether to render the UI component's content when it is displayed. If false, the content is rendered immediately.
AngularIf you set the deferRendering
property to true, wrap the content in the Angular named template.
If you set the deferRendering
property to true, wrap the content in the Vue named template.
Specifies whether the UI component responds to user interaction.
Specifies whether to enable page scrolling when the UI component is visible.
Disable this property to hide the body scrollbar and prevent scrolling of the page.
Specifies the UI component's 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"
.
The Popover calculates its height relative to the window.
Specifies properties of popover hiding. Ignored if the shading property is set to true.
Selector: HideEvent
Default Value: undefined
The target property specifies a target element for the Popover hideEvent.
If you assign only a string that specifies event names on which the UI component is hidden, the UI component will not apply any delay.
Specifies whether to hide the UI component if a user clicks outside the popover window or outside the target element.
true if the UI component should be hidden; otherwise false.
Default Value: true
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.
Specifies whether to hide the Popover when users scroll one of its parent elements.
Specifies text for a hint that appears when a user pauses on the UI component.
Specifies whether the UI component changes its state when a user pauses on it.
Specifies the maximum height the UI component can reach while resizing.
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"
.
Specifies the maximum width the UI component can reach while resizing.
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"
.
Specifies the minimum height the UI component can reach while resizing.
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"
.
Specifies the minimum width the UI component can reach while resizing.
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"
.
A function that is executed when the UI component is rendered and each time the component is repainted.
Function parameters:Information about the event.
Object structure:
Default Value: null
A function that is executed before the UI component is disposed of.
Function parameters:Information about the event.
Object structure:
Default Value: null
A function that is executed after the UI component is hidden.
Function parameters:Information about the event.
Object structure:
Default Value: null
A function that is executed before the UI component is hidden.
Function parameters:Information about the event.
Object structure:
Default Value: null
A function used in JavaScript frameworks to save the UI component instance.
Function parameters:Information about the event.
Object structure:
Default Value: null
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
App.vue (Composition API)
<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 jQuery
A function that is executed after a UI component property is changed.
Function parameters:Information about the event.
Object structure:
Name Type Description value anyThe modified property's new value.
previousValue anyThe UI component's previous value.
nameThe modified property if it belongs to the first level. Otherwise, the first-level property it is nested into.
fullNameThe path to the modified property that includes all parent properties.
elementThe UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
componentThe UI component's instance.
Default Value: null
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} /> ); }
A function that is executed before the UI component is displayed.
Function parameters:Information about the event.
Object structure:
Name Type Description elementThe UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
componentThe UI component's instance.
cancelSet this field to true if you want to prevent the Popover from being displayed.
Default Value: null
A function that is executed after the UI component is displayed.
Function parameters:Information about the event.
Object structure:
Default Value: null
A function that is executed when the UI component's title is rendered.
Function parameters:Information about the event.
Object structure:
Default Value: null
An object defining UI component positioning properties.
Selector: Position
Default Value: { my: 'top center', at: 'bottom center', collision: 'fit flip' }
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.
Switches the UI component to a right-to-left representation.
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 });
DataGrid Demo Navigation UI Demo Editors Demo
Specifies whether to shade the background when the UI component is active.
Shading always applies to the window.
Specifies the shading color. Applies only if shading is enabled.
Specifies whether or not the UI component displays the Close button.
Default Value: false, false (Material), true (desktop)
The property makes sense only if the
showTitleproperty is set to
true.
Specifies properties for displaying the UI component.
Selector: ShowEvent
Default Value: undefined
The target property specifies a target element for the Popover showEvent.
If you assign only a string that specifies event names on which the UI component is shown, the UI component will not apply any delay.
A Boolean value specifying whether or not to display the title in the overlay window.
Specifies the element against which to position the Popover. If target is undefined
, the component cannot be displayed.
This property accepts one of the following values:
jQuery$(function(){ $("#popoverContainer").dxPopover({ // ... target: '#targetElement' }); });
A jQuery wrapper
$(function(){ $("#popoverContainer").dxPopover({ // ... target: $('#targetElement') }); });
A DOM element
$(function(){ $("#popoverContainer").dxPopover({ // ... target: document.getElementById('#targetElement') }); });
<dx-popover ... target="#targetElement" > </dx-popover>
The component supports only valid CSS identifiers. To target elements with invalid identifiers, specify an attribute selector instead.
<dx-popover ... target="#111" // An invalid CSS identifier > </dx-popover> <dx-popover ... target="[id='#111']" // An attribute selector > </dx-popover>
A DOM element
<dx-popover ... [target]="targetElement" > </dx-popover>
// ... export class AppComponent { targetElement: Element; constructor() { this.targetElement = document.getElementById('#targetElement') as Element; } }
<template> <DxPopover ... target="#targetElement" > </DxPopover> </template> <script setup lang="ts"> import { DxPopover } from 'devextreme-vue/popover'; </script>
The component supports only valid CSS identifiers. To target elements with invalid identifiers, specify an attribute selector instead.
<template> <DxPopover ... target="#111" // An invalid CSS identifier > </DxPopover> <DxPopover ... target="[id='#111']" // An attribute selector > </DxPopover> </template>
A DOM element
<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>
import Popover from 'devextreme-react/popover'; // ... function App() { return ( <Popover ... target="#targetElement" > </Popover> ); }
The component supports only valid CSS identifiers. To target elements with invalid identifiers, specify an attribute selector instead.
import Popover from 'devextreme-react/popover'; // ... function App() { return ( <Popover ... target="#111" // An invalid CSS identifier > </Popover> <Popover ... target="[id='#111']" // An attribute selector > </Popover> ); }
A DOM element
import 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> ); }
Target type affects the initialization of the component's events:
undefined
This changes event propagation and the behavior of methods like stopPropagation().
AngularTarget type affects the initialization of the component's events:
undefined
This changes event propagation and the behavior of methods like stopPropagation().
VueTarget type affects the initialization of the component's events:
undefined
This changes event propagation and the behavior of methods like stopPropagation().
ReactTarget type affects the initialization of the component's events:
undefined
This changes event propagation and the behavior of methods like stopPropagation().
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.
The title in the overlay window.
Specifies a custom template for the UI component title. Does not apply if the title is defined.
Configures toolbar items.
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-popup-toolbar-item text="Title" location="before"> </dxi-popup-toolbar-item> <dxi-popup-toolbar-item widget="dxButton" location="after" [options]="{ text: 'Refresh', onClick: refresh }"> </dxi-popup-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;
A Boolean value specifying whether or not the UI component is visible.
Specifies the UI component's 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"
.
The Popover calculates its width relative to the window.
Specifies the global attributes for the UI component's wrapper element.
Type: any
Default Value: {}
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')") )Feel free to share topic-related thoughts here.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4