JavaScript/jQuery Tooltip Options
An object defining configuration properties for the Tooltip UI component.
See Also
- Configure a Widget: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
animation
Set this object to null or undefined to disable animation.
closeOnOutsideClick
A Boolean value specifying whether or not the UI component is closed if a user clicks outside of the popover window and outside the target element.
Event (jQuery or EventObject)
The event that caused UI component closing. It is a dxEvent or a jQuery.Event when you use jQuery.
true if the UI component should be closed; otherwise false.
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
$(function () { $("#tooltipContainer").dxTooltip({ // ... closeOnOutsideClick: function(e) { return e.target === $("#someElement").get()[0]; } }); });
Angular
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>
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.
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.
deferRendering
Specifies whether to render the UI component's content when it is displayed. If false, the content is rendered immediately.
disabled
Specifies whether the UI component responds to user interaction.
elementAttr
Specifies the global attributes to be attached to the UI component's container element.
jQuery
$(function(){ $("#tooltipContainer").dxTooltip({ // ... elementAttr: { id: "elementId", class: "class-name" } }); });
Angular
<dx-tooltip ... [elementAttr]="{ id: 'elementId', class: 'class-name' }"> </dx-tooltip>
import { DxTooltipModule } from "devextreme-angular"; // ... export class AppComponent { // ... } @NgModule({ imports: [ // ... DxTooltipModule ], // ... })
Vue
<template> <DxTooltip ... :element-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
import React from 'react'; import Tooltip from 'devextreme-react/tooltip'; class App extends React.Component { tooltipAttributes = { id: 'elementId', class: 'class-name' } render() { return ( <Tooltip ... elementAttr={this.tooltipAttributes}> </Tooltip> ); } } export default App;
height
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"
,"80%"
,"inherit"
.Function
A function returning either of the above. For example:JavaScriptheight: function() { return window.innerHeight / 1.5; }
hideEvent
Specifies properties of popover hiding.
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"
hint
Specifies text for a hint that appears when a user pauses on the UI component.
hoverStateEnabled
Specifies whether the UI component changes its state when a user pauses on it.
maxHeight
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"
,"80%"
,"inherit"
.Function
A function returning either of the above. For example:JavaScriptheight: function() { return window.innerHeight / 1.5; }
maxWidth
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"
,"80%"
,"auto"
,"inherit"
.Function
A function returning either of the above. For example:JavaScriptwidth: function() { return window.innerWidth / 1.5; }
minHeight
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"
,"80%"
,"inherit"
.Function
A function returning either of the above. For example:JavaScriptheight: function() { return window.innerHeight / 1.5; }
minWidth
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"
,"80%"
,"auto"
,"inherit"
.Function
A function returning either of the above. For example:JavaScriptwidth: 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.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
Model data. Available only when using Knockout. |
onDisposing
A function that is executed before the UI component is disposed of.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
Model data. Available only if you use Knockout. |
onHidden
A function that is executed after the UI component is hidden.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
Model data. Available only if Knockout is used. |
onHiding
A function that is executed before the UI component is hidden.
Information about the event.
Name | Type | Description |
---|---|---|
cancel |
Allows you to cancel overlay hiding. |
|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
Model data. Available only if Knockout is used. |
onInitialized
A function used in JavaScript frameworks to save the UI component instance.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
onOptionChanged
A function that is executed after a UI component property is changed.
Information about the event.
Name | Type | Description |
---|---|---|
model |
Model data. Available only if you use Knockout. |
|
fullName |
The path to the modified property that includes all parent properties. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
|
name |
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. |
The following example shows how to subscribe to component property changes:
jQuery
$(function() { $("#tooltipContainer").dxTooltip({ // ... onOptionChanged: function(e) { if(e.name === "changedProperty") { // handle the property change here } } }); });
Angular
<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
<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>
React
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} /> ); }
onShowing
A function that is executed before the UI component is displayed.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
Model data. Available only if Knockout is used. |
onShown
A function that is executed after the UI component is displayed.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
Model data. Available only if Knockout is used. |
position
An object defining UI component positioning properties.
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.
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 });
See Also
- Right-to-Left Support Demo: DataGrid | Navigation Widgets | Editors
shading
Specifies whether to shade the background when the UI component is active.
shadingColor
Specifies the shading color. Applies only if shading is enabled.
This property supports the following colors:
- Hexadecimal colors
- RGB colors
- RGBA colors
- Predefined/cross-browser color names
- Predefined SVG colors
- Paint server address
showEvent
Specifies properties for displaying the UI component.
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"
target
The target element associated with the Tooltip.
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.
width
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"
,"80%"
,"auto"
,"inherit"
.Function
A function returning either of the above. For example:JavaScriptwidth: function() { return window.innerWidth / 1.5; }
If you have technical questions, please create a support ticket in the DevExpress Support Center.