React Tooltip API

The Tooltip widget displays a tooltip for a specified element on the page.

import Tooltip from "devextreme-react/tooltip"

Type: TooltipTypes.default

DevExtreme widgets are integrated with many popular libraries and frameworks. See the Installation section (for JavaScript libraries) or the Prerequisites and Installation section (for ASP.NET MVC framework) to find details on setting up DevExtreme with a particular library or framework.

The following code shows how to create the Tooltip widget using every supported library and framework. For more details on working with widgets in these libraries and frameworks, see the Widget Basics topic for jQuery, Angular, AngularJS, Knockout or ASP.NET MVC.

jQuery

HTML

JavaScript

<div id="targetElement"></div>
<div id="tooltip">
    <p>Tooltip content</p>
</div>

$(function () {
    $("#tooltip").dxTooltip({
        target: "#targetElement",
        showEvent: "dxhoverstart",
        hideEvent: "dxhoverend"
    });
});

Angular

HTML

TypeScript

<div id="targetElement"></div>
<dx-tooltip
    target="#targetElement"
    showEvent="dxhoverstart"
    hideEvent="dxhoverend">
        <p>Tooltip content</p>
</dx-tooltip>

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

AngularJS

HTML

<div id="targetElement"></div>
<div dx-tooltip="{
    target: '#targetElement',
    showEvent: 'dxhoverstart',
    hideEvent: 'dxhoverend'
}">
    <p>Tooltip content</p>
</div>

Knockout

HTML

<div id="targetElement"></div>
<div data-bind="dxTooltip: {
    target: '#targetElement',
    showEvent: 'dxhoverstart',
    hideEvent: 'dxhoverend'
}">
    <p>Tooltip content</p>
</div>

ASP.NET MVC Controls

Razor C#

Razor VB

@(Html.DevExtreme().Tooltip()
    .ID("tooltip")
    .Target("#targetElement")
    .ShowEvent("dxhoverstart")
    .HideEvent("dxhoverend")
    .ContentTemplate(@<text>
        <p>Tooltip content</p>
    </text>)
)
<div id="targetElement"></div>

@Code
    Html.DevExtreme().Tooltip() _
        .ID("tooltip") _
        .Target("#targetElement") _
        .ShowEvent("dxhoverstart") _
        .HideEvent("dxhoverend") _
        .ContentTemplate(Sub()
            @<text>
                <p>Tooltip content</p>
            </text>
        End Sub).Render
End Code
<div id="targetElement"></div>

View Demo Watch Video

Configuration

An object defining configuration options for the Tooltip widget.

Name	Description
animation	Configures widget visibility animations. This object contains two fields: show and hide.
closeOnBackButton	A Boolean value specifying whether or not the widget is closed if a user presses the Back hardware button.
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.
container	Specifies the container in which to place the widget.
contentTemplate	Specifies a custom template for the widget content.
deferRendering	Specifies whether to render the widget's content when it is displayed. If false, the content is rendered immediately.
disabled	Specifies whether the widget responds to user interaction.
elementAttr	Specifies the attributes to be attached to the widget's root element.
height	Specifies the widget's height.
hideEvent	Specifies options of popover hiding.
hint	Specifies text for a hint that appears when a user pauses on the widget.
hoverStateEnabled	Specifies whether the widget changes its state when a user pauses on it.
maxHeight	Specifies the maximum height the widget can reach while resizing.
maxWidth	Specifies the maximum width the widget can reach while resizing.
minHeight	Specifies the minimum height the widget can reach while resizing.
minWidth	Specifies the minimum width the widget can reach while resizing.
onContentReady	A function that is executed when the widget's content is ready and each time the content is changed.
onDisposing	A function that is executed before the widget is disposed of.
onHidden	A function that is executed after the widget is hidden.
onHiding	A function that is executed before the widget is hidden.
onInitialized	A function used in JavaScript frameworks to save the widget instance.
onOptionChanged	A function that is executed after a widget option is changed.
onShowing	A function that is executed before the widget is displayed.
onShown	A function that is executed after the widget is displayed.
position	An object defining widget positioning options.
rtlEnabled	Switches the widget to a right-to-left representation.
shading	Specifies whether to shade the container when the widget is active.
shadingColor	Specifies the shading color.
showEvent	Specifies options for displaying the widget.
target	The target element associated with the Tooltip.
visible	A Boolean value specifying whether or not the widget is visible.
width	Specifies the widget's width.

Methods

This section describes members used to manipulate the widget.

Name	Description
beginUpdate()	Prevents the widget from refreshing until the endUpdate() method is called.
content()	Gets the widget's content.
defaultOptions(rule)	Specifies the device-dependent default configuration options for this component.
dispose()	Disposes of all the resources allocated to the Tooltip instance.
element()	Gets the root widget element.
endUpdate()	Refreshes the widget after a call of the beginUpdate() method.
getInstance(element)	Gets the instance of a widget found using its DOM node.
hide()	Hides the widget.
instance()	Gets the widget's instance. Use it to access other methods of the widget.
off(eventName)	Detaches all event handlers from a single event.
off(eventName, eventHandler)	Detaches a particular event handler from a single event.
on(eventName, eventHandler)	Subscribes to an event.
on(events)	Subscribes to events.
option()	Gets all widget options.
option(optionName)	Gets the value of a single option.
option(optionName, optionValue)	Updates the value of a single option.
option(options)	Updates the values of several options.
repaint()	Recalculates the widget's size and position without rerendering.
show()	Shows the widget.
show(target)	Shows the widget for a target element.
toggle(showing)	Shows or hides the widget depending on the argument.

Events

Name	Description
contentReady	Raised when the widget's content is ready.
disposing	Raised before the widget is disposed of.
hidden	Raised after the widget is hidden.
hiding	Raised before the widget is hidden.
initialized	Raised only once, after the widget is initialized.
optionChanged	Raised after a widget option is changed.
showing	Raised before the widget is displayed.
shown	Raised after the widget is displayed.

React Tooltip API

jQuery

Angular

AngularJS

Knockout

ASP.NET MVC Controls

See Also

Configuration

Methods

Events

See Also