JavaScript/jQuery Tooltip Options

An object defining configuration properties for the Tooltip UI component.

View on GitHub

See Also
jQuery
Angular
Vue
React

animation

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

Type:

dxPopoverAnimation

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.

closeOnOutsideClick Deprecated

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.

Type:

Boolean

|

Function

Function parameters:
event:

Event (jQuery or EventObject)

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

Return Value:

Boolean

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

Default Value: true

container

Specifies the container in which to render the UI component.

Type:

String

|

HTMLElement | jQuery

Default Value: undefined

This property accepts one of the following values:

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

    jQuery
    index.js
    $(function(){
    $("#tooltipContainer").dxTooltip({
        // ...
        container: '#containerElement'
    });
});
    Angular
    app.component.html
    <dx-tooltip ... 
    container="#containerElement"
>
</dx-tooltip>
    Vue
    App.vue
    <template>
    <DxTooltip ... 
        container="#containerElement"
    >
    </DxTooltip>
</template>
<script>
import { DxTooltip } from 'devextreme-vue/tooltip';

export default {
    components: {
        DxTooltip
    }
};
</script>
    React
    App.js
    import Tooltip from 'devextreme-react/tooltip';
// ...
function App() {
    return (
        <Tooltip ... 
            container="#containerElement"
        >
        </Tooltip>
    );
}

  • A jQuery wrapper

    jQuery
    index.js
    $(function(){
    $("#tooltipContainer").dxTooltip({
        // ...
        container: $('#containerElement')
    });
});

  • A DOM element

    jQuery
    index.js
    $(function(){
    $("#tooltipContainer").dxTooltip({
        // ...
        container: document.getElementById('#containerElement')
    });
});
    Angular
    app.component.html
    app.component.ts
    <dx-tooltip ... 
    [container]="containerElement"
>
</dx-tooltip>
    // ...
export class AppComponent {
    containerElement: Element;
    constructor() {
        this.containerElement = document.getElementById('#containerElement') as Element;
    }
}
    Vue
    App.vue
    <template>
    <DxTooltip ... 
        :container="containerElement"
    >
    </DxTooltip>
</template>
<script>
import { DxTooltip } from 'devextreme-vue/tooltip';

export default {
    components: {
        DxTooltip
    },
    data() {
        return {
            containerElement: null
        }
    },
    mounted() {
        this.containerElement = document.getElementById('containerElement');
    }
};
</script>
    React
    App.js
    import React, { useEffect, useState } from 'react';
import Tooltip from 'devextreme-react/tooltip';
// ...
function App() {
    const [containerElement, setContainerElement] = useState(null);
    useEffect(() => {
        setContainerElement(document.getElementById('containerElement'));
    }, []);
    return (
        <Tooltip ... 
            container={containerElement}
        >
        </Tooltip>
    );
}

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):

contentTemplate

Specifies a custom template for the UI component content.

Type:

template

Template Data: undefined
Default Name: 'content'

View Demo

See Also

copyRootClassesToWrapper Deprecated

IMPORTANT
Use the wrapperAttr property instead.

Copies your custom CSS classes from the root element to the wrapper element.

Type:

Boolean

Default Value: false

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:

HTML
<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="tooltip" 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-tooltip-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.

Type:

Boolean

Default Value: true

Angular

If you set the deferRendering property to true, wrap the content in the Angular named template.

Vue

If you set the deferRendering property to true, wrap the content in the Vue named template.

disabled

Specifies whether the UI component responds to user interaction.

Type:

Boolean

Default Value: false

height

Specifies the UI component's height.

Type:

Number

|

String

|

Function

Return Value:

Number

|

String

The UI component height.

Default Value: 'auto'
Raised Events: onResize

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 Tooltip calculates its height relative to the window.

hideEvent

Specifies properties of popover hiding. Ignored if the shading property is set to true.

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"

hideOnOutsideClick

Specifies whether to hide 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 EventObject)

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

Return Value:

Boolean

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
JavaScript
$(function () {
    $("#tooltipContainer").dxTooltip({
        // ...
        hideOnOutsideClick: function(e) {
            return e.target === $("#someElement").get()[0];
        }
    });
});
Angular
TypeScript
HTML
import { DxTooltipModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
    hideOnOutsideClick(e) {
        return e.target === document.getElementById("someElement");
    }
}
@NgModule({
     imports: [
         // ...
         DxTooltipModule
     ],
     // ...
 })
<dx-tooltip ...
    [hideOnOutsideClick]="hideOnOutsideClick">
</dx-tooltip>
Vue
App.vue
<template>
    <DxTooltip ....
        :hide-on-outside-click="hideOnOutsideClick">
    </DxTooltip>
</template>

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

import DxTooltip from 'devextreme-vue/tooltip';

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

import Tooltip from 'devextreme-react/tooltip';

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

export default function App() {
    return (
        <Tooltip ...
            hideOnOutsideClick={hideOnOutsideClick}>
        </Tooltip>
    );
}

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

Popup Demo

hideOnParentScroll

Specifies whether to hide the Tooltip when users scroll one of its parent elements.

Type:

Boolean

Default Value: true

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", "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

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", "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

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", "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

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", "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.

Type:

Function

Function parameters:
e:

ContentReadyEvent

Information about the event.

Object structure:
Name Type Description
element

HTMLElement | jQuery

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

Tooltip

The UI component's instance.
Default Value: null

onDisposing

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

Type:

Function

Function parameters:
e:

DisposingEvent

Information about the event.

Object structure:
Name Type Description
element

HTMLElement | jQuery

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

Tooltip

The UI component's instance.
Default Value: null

onHidden

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

Type:

Function

Function parameters:
e:

HiddenEvent

Information about the event.

Object structure:
Name Type Description
element

HTMLElement | jQuery

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

Tooltip

The UI component's instance.
Default Value: null

onHiding

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

Type:

Function

Function parameters:
e:

HidingEvent

Information about the event.

Object structure:
Name Type Description
element

HTMLElement | jQuery

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

Tooltip

The UI component's instance.
cancel

Boolean

Set this field to true if you want the Tooltip to remain visible.
Default Value: null

onInitialized

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

Type:

Function

Function parameters:
e:

InitializedEvent

Information about the event.

Object structure:
Name Type Description
element

HTMLElement | jQuery

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

Tooltip

The UI component's instance.
Default Value: null

Angular
app.component.html
app.component.ts
<dx-tooltip ...
    (onInitialized)="saveInstance($event)">
</dx-tooltip>
import { Component } from "@angular/core";
import Tooltip from "devextreme/ui/data_grid";
// ...
export class AppComponent {
    tooltipInstance: Tooltip;
    saveInstance (e) {
        this.tooltipInstance = e.component;
    }
}
Vue
App.vue (Options API)
App.vue (Composition API)
<template>
    <div>
        <DxTooltip ...
            @initialized="saveInstance">
        </DxTooltip>
    </div>
</template>

<script>
import DxTooltip from 'devextreme-vue/tooltip';

export default {
    components: {
        DxTooltip
    },
    data: function() {
        return {
            tooltipInstance: null
        };
    },
    methods: {
        saveInstance: function(e) {
            this.tooltipInstance = e.component;
        }
    }
};
</script>
<template>
    <div>
        <DxTooltip ...
            @initialized="saveInstance">
        </DxTooltip>
    </div>
</template>

<script setup>
import DxTooltip from 'devextreme-vue/tooltip';

let tooltipInstance = null;

const saveInstance = (e) => {
    tooltipInstance = e.component;
}
</script>
React
App.js
import Tooltip from 'devextreme-react/tooltip';

class App extends React.Component {
    constructor(props) {
        super(props);

        this.saveInstance = this.saveInstance.bind(this);
    }

    saveInstance(e) {
        this.tooltipInstance = e.component;
    }

    render() {
        return (
            <div>
                <Tooltip onInitialized={this.saveInstance} />
            </div>
        );
    }
}
See Also
jQuery
  • Get a UI component Instance in jQuery
Angular
  • Get a UI component Instance in Angular
Vue
  • Get a UI component Instance in Vue
React
  • Get a UI component Instance in React

onOptionChanged

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

Type:

Function

Function parameters:
e:

OptionChangedEvent

Information about the event.

Object structure:
Name Type Description
value any

The modified property's new value.
previousValue any

The UI component's previous value.
name

String

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

String

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

HTMLElement | jQuery

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

Tooltip

The UI component's instance.
Default Value: null

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

jQuery
index.js
$(function() {
    $("#tooltipContainer").dxTooltip({
        // ...
        onOptionChanged: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    });
});
Angular
app.component.html
app.component.ts
app.module.ts
<dx-tooltip ...
    (onOptionChanged)="handlePropertyChange($event)"> 
</dx-tooltip>
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 { DxTooltipModule } from 'devextreme-angular'; 

@NgModule({ 
    declarations: [ 
        AppComponent 
    ], 
    imports: [ 
        BrowserModule, 
        DxTooltipModule 
    ], 
    providers: [ ], 
    bootstrap: [AppComponent] 
}) 

export class AppModule { }
Vue
App.vue
<template> 
    <DxTooltip ...
        @option-changed="handlePropertyChange"
    />            
</template> 

<script>  
import 'devextreme/dist/css/dx.light.css'; 
import DxTooltip from 'devextreme-vue/tooltip'; 

export default { 
    components: { 
        DxTooltip
    }, 
    // ...
    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.light.css'; 

import Tooltip from 'devextreme-react/tooltip'; 

const handlePropertyChange = (e) => {
    if(e.name === "changedProperty") {
        // handle the property change here
    }
}

export default function App() { 
    return ( 
        <Tooltip ...
            onOptionChanged={handlePropertyChange}
        />        
    ); 
}

onShowing

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

Type:

Function

Function parameters:
e:

ShowingEvent

Information about the event.

Object structure:
Name Type Description
element

HTMLElement | jQuery

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

Tooltip

The UI component's instance.
cancel

Boolean

Set this field to true if you want to prevent the Tooltip from being displayed.
Default Value: null

onShown

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

Type:

Function

Function parameters:
e:

ShownEvent

Information about the event.

Object structure:
Name Type Description
element

HTMLElement | jQuery

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

Tooltip

The UI component's instance.
Default Value: null

position

An object defining UI component positioning properties.

Type:

Position

|

PositionConfig

Default Value: { my: 'top center', at: 'bottom center', collision: 'fit flip' }
Raised Events: onPositioned

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
});

DataGrid Demo Navigation UI Demo Editors Demo

shading

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

Type:

Boolean

Default Value: false

Shading always applies to the window.

shadingColor

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

Type:

String

Default Value: ''

This property supports the following colors:

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"

target

Specifies the element against which to position the Tooltip.

Type:

String

|

HTMLElement | jQuery

Default Value: undefined

This property accepts one of the following values:

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

    jQuery
    index.js
    $(function(){
    $("#tooltipContainer").dxTooltip({
        // ...
        target: '#targetElement'
    });
});
    Angular
    app.component.html
    <dx-tooltip ... 
    target="#targetElement"
>
</dx-tooltip>
    Vue
    App.vue
    <template>
    <DxTooltip ... 
        target="#targetElement"
    >
    </DxTooltip>
</template>
<script>
import { DxTooltip } from 'devextreme-vue/tooltip';

export default {
    components: {
        DxTooltip
    }
};
</script>
    React
    App.js
    import Tooltip from 'devextreme-react/tooltip';
// ...
function App() {
    return (
        <Tooltip ... 
            target="#targetElement"
        >
        </Tooltip>
    );
}

  • A jQuery wrapper

    jQuery
    index.js
    $(function(){
    $("#tooltipContainer").dxTooltip({
        // ...
        target: $('#targetElement')
    });
});

  • A DOM element

    jQuery
    index.js
    $(function(){
    $("#tooltipContainer").dxTooltip({
        // ...
        target: document.getElementById('#targetElement')
    });
});
    Angular
    app.component.html
    app.component.ts
    <dx-tooltip ... 
    [target]="targetElement"
>
</dx-tooltip>
    // ...
export class AppComponent {
    targetElement: Element;
    constructor() {
        this.targetElement = document.getElementById('#targetElement') as Element;
    }
}
    Vue
    App.vue
    <template>
    <DxTooltip ... 
        :target="targetElement"
    >
    </DxTooltip>
</template>
<script>
import { DxTooltip } from 'devextreme-vue/tooltip';

export default {
    components: {
        DxTooltip
    },
    data() {
        return {
            targetElement: null
        }
    },
    mounted() {
        this.targetElement = document.getElementById('targetElement');
    }
};
</script>
    React
    App.js
    import React, { useEffect, useState } from 'react';
import Tooltip from 'devextreme-react/tooltip';
// ...
function App() {
    const [targetElement, setTargetElement] = useState(null);
    useEffect(() => {
        setTargetElement(document.getElementById('targetElement'));
    }, []);
    return (
        <Tooltip ... 
            target={targetElement}
        >
        </Tooltip>
    );
}

To change the Tooltip position against this element, use the position property.

This property also specifies a target element for the Tooltip showEvent and hideEvent.

visible

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

Type:

Boolean

Default Value: false
Raised Events: onHiding onShowing

Popup Demo

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: onResize

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 Tooltip calculates its width relative to the window.

wrapperAttr

Specifies the global attributes for the UI component's wrapper element.

Type: any
Default Value: {}

jQuery
$(function(){
    $("#tooltipContainer").dxTooltip({
        // ...
        wrapperAttr: {
            id: "elementId",
            class: "class-name"
        }
    });
});
Angular
app.component.html
app.component.ts
app.module.ts
<dx-tooltip ...
    [wrapperAttr]="{ id: 'elementId', class: 'class-name' }">
</dx-tooltip>
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 { DxTooltipModule } from 'devextreme-angular';

@NgModule({
    declarations: [
        AppComponent
    ],
    imports: [
        BrowserModule,
        DxTooltipModule
    ],
    providers: [ ],
    bootstrap: [AppComponent]
})
export class AppModule { }
Vue
App.vue
<template>
    <DxTooltip ...
        :wrapper-attr="tooltipAttributes">
    </DxTooltip>
</template>

<script>
import DxTooltip from 'devextreme-vue/tooltip';

export default {
    components: {
        DxTooltip
    },
    data() {
        return {
            tooltipAttributes: {
                id: 'elementId',
                class: 'class-name'
            }
        }
    }
}
</script>
React
App.js
import React, { useMemo } from 'react';

import Tooltip from 'devextreme-react/tooltip';

function App() {
    const tooltipAttributes = useMemo(() => {
        return {
            id: 'elementId',
            class: 'class-name'
        }
    }, []);

    return (
        <Tooltip ...
            wrapperAttr={tooltipAttributes}>
        </Tooltip>
    );
}
export default App;

The code above specifies the id and class attributes for the wrapper element and produces markup similar to this:

HTML
<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-tooltip-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="myTooltip" class="myClass"></div>
Angular

You can specify attributes to the component's root element directly in HTML code:

<dx-tooltip ... class="myClass">
</dx-tooltip>
React

You can specify attributes to the component's root element directly in HTML code:

<Tooltip ... className="myClass" />
ASP.NET Core Controls

To add an attribute to an ASP.NET Core control, use its OnInitialized method:

@(Html.DevExtreme().Tooltip()...
    .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().Tooltip()...
    .OnInitialized("(e) => e.element.addClass('myClass')")
)