JavaScript/jQuery Tooltip Options

View on GitHub

See Also

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.

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

• color swatch container

• .dx-viewport

• body

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

The Tooltip calculates its height relative to the window.

The target property specifies a target element for the Tooltip 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.

hideEvent: "mouseleave"

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.

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

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>

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

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

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

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

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

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

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

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

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

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.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.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 always applies to the window.

This property supports the following colors:

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

The target property specifies a target element for the Tooltip 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.

showEvent: "mouseenter"

This property accepts one of the following values:

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.

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

The Tooltip calculates its width relative to the window.

$(function(){
    $("#tooltipContainer").dxTooltip({
        // ...
        wrapperAttr: {
            id: "elementId",
            class: "class-name"
        }
    });
});

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

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

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:

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

<div id="myTooltip" class="myClass"></div>

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

<Tooltip ... className="myClass" />

@(Html.DevExtreme().Tooltip()...
    .OnInitialized("(e) => e.element.addClass('myClass')")
)

    @(Html.DevExtreme().Tooltip()...
    .OnInitialized("(e) => e.element.addClass('myClass')")
)