All docs
V20.2
21.1
20.2
20.1
19.2
The page you are viewing does not exist in version 19.2. This link will take you to the root page.
19.1
The page you are viewing does not exist in version 19.1. This link will take you to the root page.
18.2
The page you are viewing does not exist in version 18.2. This link will take you to the root page.
18.1
The page you are viewing does not exist in version 18.1. This link will take you to the root page.
17.2
The page you are viewing does not exist in version 17.2. This link will take you to the root page.

Configuration

An object defining configuration properties for the Popover UI component.

See Also

animation

Configures UI component visibility animations. This object contains two fields: show and hide.

Type:

Object

Default Value: { show: { type: 'fade', from: 0, to: 1 }, hide: { type: 'fade', to: 0 } }

Set this object to null or undefined to disable animation.

closeOnOutsideClick

Specifies whether to close the UI component if a user clicks outside the popover window or outside the target element.

Type:

Boolean

|

Function

Function parameters:
event:

Event (jQuery or dxEvent)

The event that caused UI component closing. It is a dxEvent or a jQuery.Event when you use jQuery.

Return Value:

Boolean

true if the UI component should be closed; otherwise false.

Default Value: true

The function passed to this property enables you to specify a custom condition for UI component closing. For instance, you can prevent closing until a user clicks a certain element.

jQuery
JavaScript
$(function () {
    $("#popoverContainer").dxPopover({
        // ...
        closeOnOutsideClick: function(e) {
            return e.target === $("#someElement").get()[0];
        }
    });
});
Angular
TypeScript
HTML
import { DxPopoverModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
    closeOnOutsideClick(e) {
        return e.target === document.getElementById("someElement");
    }
}
@NgModule({
     imports: [
         // ...
         DxPopoverModule
     ],
     // ...
 })
<dx-popover ...
    [closeOnOutsideClick]="closeOnOutsideClick">
</dx-popover>
Vue
App.vue
<template>
    <DxPopover ....
        :close-on-outside-click="closeOnOutsideClick">
    </DxPopover>
</template>

<script>
import 'devextreme/dist/css/dx.light.css';

import DxPopover from 'devextreme-vue/popover';

export default {
    components: {
        DxPopover
    },
    methods: {
        closeOnOutsideClick (e) {
            return e.target === document.getElementById("someElement");
        }
    }
}
</script>
React
App.js
import React from 'react';
import 'devextreme/dist/css/dx.light.css';

import Popover from 'devextreme-react/popover';

const closeOnOutsideClick = (e) => {
    return e.target === document.getElementById("someElement");
};

export default function App() {
    return (
        <Popover ...
            closeOnOutsideClick={closeOnOutsideClick}>
        </Popover>
    );
}

The closeOnOutsideClick function is called when a user clicks the UI component or outside it.

container

Specifies the container in which to render the UI component.

Type:

String

|

Element

|

jQuery

Default Value: undefined

The container is defined during the UI component's initialization. The container by default is the viewport. If the viewport is not found, it is the body element. If the viewport and the body element are absent, the container is the parent element.

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.

Type:

template

Template Data: undefined
Default Name: 'content'

deferRendering

Specifies whether to render the UI component's content when it is displayed. If false, the content is rendered immediately.

Type:

Boolean

Default Value: true

disabled

Specifies whether the UI component responds to user interaction.

Type:

Boolean

Default Value: false

elementAttr

Specifies the global attributes to be attached to the UI component's container element.

Type:

Object

Default Value: {}

jQuery
$(function(){
    $("#popoverContainer").dxPopover({
        // ...
        elementAttr: {
            id: "elementId",
            class: "class-name"
        }
    });
});
Angular
HTML
TypeScript
<dx-popover ...
    [elementAttr]="{ id: 'elementId', class: 'class-name' }">
</dx-popover>
import { DxPopoverModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxPopoverModule
    ],
    // ...
})
Vue
App.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
App.js
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

Specifies the UI component's height.

Type:

Number

|

String

|

Function

Return Value:

Number

|

String

The UI component height.

Default Value: 'auto'
Raised Events: resize

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", "80%", "inherit".

  • Function
    A function returning either of the above. For example:

    JavaScript
    height: function() {
        return window.innerHeight / 1.5;
    }

hideEvent

Specifies properties of popover hiding.

Type:

Object

|

String

Default Value: undefined

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.

JavaScript
hideEvent: "mouseleave"

hint

Specifies text for a hint that appears when a user pauses on the UI component.

Type:

String

Default Value: undefined

hoverStateEnabled

Specifies whether the UI component changes its state when a user pauses on it.

Type:

Boolean

Default Value: false

maxHeight

Specifies the maximum height the UI component can reach while resizing.

Type:

Number

|

String

|

Function

Return Value:

Number

|

String

The maximum height.

Default Value: null

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", "80%", "inherit".

  • Function
    A function returning either of the above. For example:

    JavaScript
    height: function() {
        return window.innerHeight / 1.5;
    }

maxWidth

Specifies the maximum width the UI component can reach while resizing.

Type:

Number

|

String

|

Function

Return Value:

Number

|

String

The maximum width.

Default Value: null

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", "80%", "auto", "inherit".

  • Function
    A function returning either of the above. For example:

    JavaScript
    width: function() {
        return window.innerWidth / 1.5;
    }

minHeight

Specifies the minimum height the UI component can reach while resizing.

Type:

Number

|

String

|

Function

Return Value:

Number

|

String

The minimum height.

Default Value: null

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", "80%", "inherit".

  • Function
    A function returning either of the above. For example:

    JavaScript
    height: function() {
        return window.innerHeight / 1.5;
    }

minWidth

Specifies the minimum width the UI component can reach while resizing.

Type:

Number

|

String

|

Function

Return Value:

Number

|

String

The minimum width.

Default Value: null

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", "80%", "auto", "inherit".

  • Function
    A function returning either of the above. For example:

    JavaScript
    width: function() {
        return window.innerWidth / 1.5;
    }

onContentReady

A function that is executed when the UI component's content is ready and each time the content is changed.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Popover

The UI component's instance.

element

HTMLElement or jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

model

Object

Model data. Available only when using Knockout.

Default Value: null

onDisposing

A function that is executed before the UI component is disposed of.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Popover

The UI component's instance.

element

HTMLElement or jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

model

Object

Model data. Available only if you use Knockout.

Default Value: null

onHidden

A function that is executed after the UI component is hidden.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Popover

The UI component's instance.

element

HTMLElement or jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

model

Object

Model data. Available only if Knockout is used.

Default Value: null

onHiding

A function that is executed before the UI component is hidden.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
cancel

Boolean

Allows you to cancel overlay hiding.

component

Popover

The UI component's instance.

element

HTMLElement or jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

model

Object

Model data. Available only if Knockout is used.

Default Value: null

onInitialized

A function used in JavaScript frameworks to save the UI component instance.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Popover

The UI component's instance.

element

HTMLElement or jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

Default Value: null

See Also

onOptionChanged

A function that is executed after a UI component property is changed.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Popover

The UI component's instance.

fullName

String

The path to the modified property that includes all parent properties.

name

String

The modified property if it belongs to the first level. Otherwise, the first-level property it is nested into.

value any

The modified property's new value.

element

HTMLElement or jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

model

Object

Model data. Available only if you use Knockout.

Default Value: null

The following example shows how to subscribe to component property changes:

jQuery
index.js
$(function() {
    $("#popoverContainer").dxPopover({
        // ...
        onOptionChanged: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    });
});
Angular
app.component.html
app.component.ts
app.module.ts
<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
App.vue
<template> 
    <DxPopover ...
        @option-changed="handlePropertyChange"
    />            
</template> 

<script> 
import 'devextreme/dist/css/dx.common.css'; 
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
App.js
import React from 'react'; 
import 'devextreme/dist/css/dx.common.css'; 
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

A function that is executed before the UI component is displayed.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Popover

The UI component's instance.

element

HTMLElement or jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

model

Object

Model data. Available only if Knockout is used.

Default Value: null

onShown

A function that is executed after the UI component is displayed.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Popover

The UI component's instance.

element

HTMLElement or jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

model

Object

Model data. Available only if Knockout is used.

Default Value: null

onTitleRendered

A function that is executed when the UI component's title is rendered.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Popover

The UI component's instance.

element

HTMLElement or jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

model

Object

Model data. Available only if Knockout is used.

titleElement

HTMLElement or jQuery

The title's container. It is an HTML Element or a jQuery Element when you use jQuery.

Default Value: null

position

An object defining UI component positioning properties.

Default Value: 'bottom'
Accepted Values: 'bottom' | 'left' | 'right' | 'top'
Raised Events: positioned

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

Switches the UI component to a right-to-left representation.

Type:

Boolean

Default Value: false

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.

JavaScript
DevExpress.config({
    rtlEnabled: true
});
See Also

shading

Specifies whether to shade the background when the UI component is active.

Type:

Boolean

Default Value: false

Shading is applied to the first element with a position value different from static. The sequence is the following: container => parent elements => window.

shadingColor

Specifies the shading color. Applies only if shading is enabled.

Type:

String

Default Value: ''

This property supports the following colors:

showCloseButton

Specifies whether or not the UI component displays the Close button.

Type:

Boolean

Default Value: false, true (desktop)

NOTE
The property makes sense only if the showTitle property is set to true.

showEvent

Specifies properties for displaying the UI component.

Type:

Object

|

String

Default Value: undefined

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.

JavaScript
showEvent: "mouseenter"

showTitle

A Boolean value specifying whether or not to display the title in the overlay window.

Type:

Boolean

Default Value: false

target

The target element associated with the Popover.

Type:

String

|

Element

|

jQuery

Default Value: Window

This property accepts one of the following values.

  • A CSS selector, or a jQuery selector if you use jQuery

    target: '#targetElement';
  • A jQuery wrapper

    target: $('#targetElement');
  • A DOM element

    target: document.getElementById('#targetElement');

To align the Popover against this element, use the position property.

title

The title in the overlay window.

Type:

String

Default Value: ''

NOTE
If the title property is specified, the titleTemplate property value is ignored.

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.

Type:

template

Template Data: undefined
Default Name: 'title'

toolbarItems[]

Configures toolbar items.

Type:

Array<Object>

In the following code, two items are defined on the toolbar: one is plain text, another is the Button UI component:

jQuery
index.js
index.html
$(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
app.component.html
app.component.ts
app.module.ts
<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
Index.cshtml
@(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
App.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.common.css';
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
App.js
import React from 'react';
import 'devextreme/dist/css/dx.common.css';
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;

visible

A Boolean value specifying whether or not the UI component is visible.

Type:

Boolean

Default Value: false
Raised Events: showing, hiding

width

Specifies the UI component's width.

Type:

Number

|

String

|

Function

Return Value:

Number

|

String

The UI component's width.

Default Value: 'auto'
Raised Events: resize

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", "80%", "auto", "inherit".

  • Function
    A function returning either of the above. For example:

    JavaScript
    width: function() {
        return window.innerWidth / 1.5;
    }