JavaScript/jQuery Tooltip Options

See Also

• Configure a Widget: Angular | Vue | React | jQuery | AngularJS | Knockout

Set this object to null or undefined to disable animation.

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.

$(function () {
    $("#tooltipContainer").dxTooltip({
        // ...
        closeOnOutsideClick: function(e) {
            return e.target === $("#someElement").get()[0];
        }
    });
});

import { DxTooltipModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
    closeOnOutsideClick(e) {
        return e.target === document.getElementById("someElement");
    }
}
@NgModule({
     imports: [
         // ...
         DxTooltipModule
     ],
     // ...
 })

<dx-tooltip ...
    [closeOnOutsideClick]="closeOnOutsideClick">
</dx-tooltip>

<template>
    <DxTooltip ....
        :close-on-outside-click="closeOnOutsideClick">
    </DxTooltip>
</template>

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

import DxTooltip from 'devextreme-vue/tooltip';

export default {
    components: {
        DxTooltip
    },
    methods: {
        closeOnOutsideClick (e) {
            return e.target === document.getElementById("someElement");
        }
    }
}
</script>

import React from 'react';
import 'devextreme/dist/css/dx.light.css';

import Tooltip from 'devextreme-react/tooltip';

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

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

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

Popup Demo

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.

View Demo

See Also

• Customize the Content
• Custom Templates

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

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.

hideEvent: "mouseleave"

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

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

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

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

See Also

• Get a UI component Instance in Angular | AngularJS | Knockout | Vue | React

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

$(function() {
    $("#tooltipContainer").dxTooltip({
        // ...
        onOptionChanged: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    });
});

<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 { }  

<template> 
    <DxTooltip ...
        @option-changed="handlePropertyChange"
    />            
</template> 

<script> 
import 'devextreme/dist/css/dx.common.css'; 
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> 

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

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

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

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

This property supports the following colors:

• Hexadecimal colors
• RGB colors
• RGBA colors
• Predefined/cross-browser color names
• Predefined SVG colors
• Paint server address

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.

showEvent: "mouseenter"

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 Tooltip against this element, use the position property.

Popup Demo

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