Angular Tooltip Properties

|

Function parameters:

event:

Event (jQuery or EventObject)

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

Return Value:

true if the widget should be closed; otherwise false.

Default Value: true

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

JavaScript

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

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

container

Specifies the container in which to render the widget.

Type:

|

Element

|

jQuery

Default Value: undefined

The container is defined during the widget'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 widget content.

Type:

template

Template Data: undefined

Default Name: 'content'

View Demo

deferRendering

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

Type:

Default Value: true

disabled

Specifies whether the widget responds to user interaction.

Type:

Default Value: false

elementAttr

Specifies the attributes to be attached to the widget's root element.

Type:

Default Value: {}

jQuery

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

Angular

HTML

TypeScript

<dx-tooltip ...
    [elementAttr]="{ id: 'elementId', class: 'class-name' }">
</dx-tooltip>

import { DxTooltipModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxTooltipModule
    ],
    // ...
})

Vue

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

App.js

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 widget's height.

Type:

|

|

Return Value:

|

The widget height.

Default Value: 'auto'

Raised Events: onResize

This option 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 options of popover hiding.

Type:

|

Default Value: undefined

If you assign only a string that specifies event names on which the widget is hidden, the widget will not apply any delay.

JavaScript

hideEvent: "mouseleave"

hint

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

Type:

Default Value: undefined

hoverStateEnabled

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

Type:

Default Value: false

maxHeight

Specifies the maximum height the widget can reach while resizing.

Type:

|

|

Return Value:

|

The maximum height.

Default Value: null

This option 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 widget can reach while resizing.

Type:

|

|

Return Value:

|

The maximum width.

Default Value: null

This option 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 widget can reach while resizing.

Type:

|

|

Return Value:

|

The minimum height.

Default Value: null

This option 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 widget can reach while resizing.

Type:

|

|

Return Value:

|

The minimum width.

Default Value: null

This option 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 widget's content is ready and each time the content is changed.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	Tooltip	The widget's instance.
element	HTMLElement \| jQuery	The widget'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 widget is disposed of.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	Tooltip	The widget's instance.
element	HTMLElement \| jQuery	The widget'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 widget is hidden.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	Tooltip	The widget's instance.
element	HTMLElement \| jQuery	The widget'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 widget is hidden.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
cancel	Boolean	Allows you to cancel overlay hiding.
component	Tooltip	The widget's instance.
element	HTMLElement \| jQuery	The widget'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 widget instance.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	Tooltip	The widget's instance.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

Default Value: null

onOptionChanged

A function that is executed after a widget option is changed.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
model	Object	Model data. Available only if you use Knockout.
fullName	String	The path to the modified option that includes all parent options.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
component	Tooltip	The widget's instance.
name	String	The modified option if it belongs to the first level. Otherwise, the first-level option it is nested into.
value	any	The modified option's new value.

Default Value: null

onShowing

A function that is executed before the widget is displayed.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	Tooltip	The widget's instance.
element	HTMLElement \| jQuery	The widget'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 widget is displayed.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	Tooltip	The widget's instance.
element	HTMLElement \| jQuery	The widget'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

position

An object defining widget positioning options.

Type:

|

PositionConfig

Default Value: 'bottom'

Accepted Values: 'bottom' | 'left' | 'right' | 'top'

Raised Events: onPositioning onPositioned

You can use the position.of option and the Popover's target option to specify the element against which the widget will be positioned. If you set both these options, position.of takes precedence.

Besides the position configuration object, the option 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 widget to a right-to-left representation.

Type:

Default Value: false

When this option is set to true, the widget 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
});

shading

Specifies whether to shade the background when the widget is active.

Type:

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:

Default Value: ''

This option supports the following colors:

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

showEvent

Specifies options for displaying the widget.

Type:

|

Default Value: undefined

If you assign only a string that specifies event names on which the widget is shown, the widget will not apply any delay.

JavaScript

showEvent: "mouseenter"

target

The target element associated with the Tooltip.

Type:

|

Element

|

jQuery

This option 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 option.

visible

A Boolean value specifying whether or not the widget is visible.

Type: