React Tooltip Props

Default Value: { show: { type: 'fade', from: 0, to: 1 }, hide: { type: 'fade', to: 0 } }

NOTE

To specify in which position the widget will be shown and from which it will be hidden, use the position option.

closeOnBackButton

A Boolean value specifying whether or not the widget is closed if a user presses the Back hardware button.

Type:

Default Value: true

closeOnOutsideClick

A Boolean value specifying whether or not the widget is closed if a user clicks outside of the popover window and outside the target element.

Type:

|

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

container

Specifies the container in which to place the widget.

Type:

|

DOM Node

|

jQuery

Default Value: undefined

The default container is defined during the widget's initialization. It is the viewport, or the body element if the viewport is not found, or the parent element if the previous two are absent.

The specified container affects some features of the Tooltip: the area to be shaded, behavior on scrolling, etc.

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
    ],
    // ...
})

ASP.NET MVC Control

Razor C#

Razor VB

@(Html.DevExtreme().Tooltip()
    .ElementAttr("class", "class-name")
    // ===== or =====
    .ElementAttr(new {
        @id = "elementId",
        @class = "class-name"
    })
    // ===== or =====
    .ElementAttr(new Dictionary<string, object>() {
        { "id", "elementId" },
        { "class", "class-name" }
    })

)

@(Html.DevExtreme().Tooltip() _
    .ElementAttr("class", "class-name")
    ' ===== or =====
    .ElementAttr(New With {
        .id = "elementId",
        .class = "class-name"
    })
    ' ===== or =====
    .ElementAttr(New Dictionary(Of String, Object) From {
        { "id", "elementId" },
        { "class", "class-name" }
    })
)

height

Specifies the widget's height.

Type:

|

|

Return Value:

|

The widget height.

Default Value: 'auto'

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%", "auto", "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: "dxhoverend"

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

The widget's instance.

element

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

model

The 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

The widget's instance.

element

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

model

The 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

The widget's instance.

element

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

model

The 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
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	The model data. Available only if Knockout is used.
cancel	Boolean	Allows you to cancel overlay hiding.

Default Value: null

onInitialized

A function that is executed only once, after the widget is initialized.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name

Type

Description

component

The widget's instance.

element

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

Default Value: null

You cannot access widget elements in this function because it is executed before they are ready. Use the onContentReady function instead.

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
name	String	The option's short name.
model	Object	The model data. Available only if you use Knockout.
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.
fullName	String	The option's full name.
value	any	The 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

The widget's instance.

element

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

model

The 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

The widget's instance.

element

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

model

The 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

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

NOTE

To specify the element against which the widget will be positioned, use the target option instead of the of field of the position object. If both target and of are specified, target will be used.

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

A Boolean value specifying whether or not the main screen is inactive while the widget is active.

Type:

Default Value: false

shadingColor

Specifies the shading color.

Type:

Default Value: ''

This option makes sense only if the shading option is set to true.

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: "dxclick"

target

The target element associated with a popover.

Type:

|

DOM Node

|

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: