TooltipModel API in JavaScript Tooltip API control

Interface for a class Tooltip

Properties

afterClose

EmitType<TooltipEventArgs>

We can trigger afterClose event when the Tooltip Component gets closed.

afterOpen

EmitType<TooltipEventArgs>

We can trigger afterOpen event after the Tooltip Component gets opened.

beforeClose

EmitType<TooltipEventArgs>

We can trigger beforeClose event before the Tooltip hides from the screen. If returned false, then the Tooltip is no more hidden.

beforeCollision

EmitType<TooltipEventArgs>

We can trigger beforeCollision event for every collision fit calculation.

beforeOpen

EmitType<TooltipEventArgs>

We can trigger beforeOpen event before the Tooltip is displayed over the target element. When one of its arguments cancel is set to true, the Tooltip display can be prevented. This event is mainly used for the purpose of refreshing the Tooltip positions dynamically or to set customized styles in it and so on.

beforeRender

EmitType<TooltipEventArgs>

We can trigger beforeRender event before the Tooltip and its contents are added to the DOM. When one of its arguments cancel is set to true, the Tooltip can be prevented from rendering on the page. This event is mainly used for the purpose of customizing the Tooltip before it shows up on the screen. For example, to load the AJAX content or to set new animation effects on the Tooltip, this event can be opted. Refer the documentation here to know more about this property with demo.

created

EmitType<Object>

We can trigger created event after the Tooltip component is created.

destroyed

EmitType<Object>

We can trigger destroyed event when the Tooltip component is destroyed.

animation

AnimationModel

We can set the same or different animation option to Tooltip while it is in open or close state. Refer the documentation here to know more about this property with demo.

closeDelay

number

It is used to close the Tooltip after a specified delay in milliseconds.

container

string | HTMLElement

It is used to set the container element in which the Tooltip’s pop-up will be appended. It accepts value as both string and HTML Element. It’s default value is body, in which the Tooltip’s pop-up will be appended.

content

string | HTMLElement | Function

It is used to display the content of Tooltip which can be both string and HTML Elements. Refer the documentation here to know more about this property with demo.

cssClass

string

It is used to customize the Tooltip which accepts custom CSS class names that defines specific user-defined styles and themes to be applied on the Tooltip element.

enableHtmlParse

boolean

It enables or disables the parsing of HTML string content into HTML DOM elements for Tooltip. If the value of the property is set to false, the tooltip content will be displayed as HTML string instead of HTML DOM elements.

enableHtmlSanitizer

boolean

Defines whether to allow the cross-scripting site or not.

enablePersistence

boolean

Enable or disable persisting component’s state between page reloads.

enableRtl

boolean

Enable or disable rendering component in right to left direction.

height

string | number

It is used to set the height of Tooltip component which accepts both string and number values. When Tooltip content gets overflow due to height value then the scroll mode will be enabled. Refer the documentation here to know more about this property with demo.

htmlAttributes

{ [key: string]: string }

Allows additional HTML attributes such as tabindex, title, name, etc. to root element of the Tooltip popup, and accepts n number of attributes in a key-value pair format.

isSticky

boolean

It is used to display the Tooltip in an open state until closed by manually. Refer the documentation here to know more about this property with demo.

locale

string

Overrides the global culture and localization value for this component. Default global culture is ‘en-US’.

mouseTrail

boolean

It allows the Tooltip to follow the mouse pointer movement over the specified target element. Refer the documentation here to know more about this property with demo.

offsetX

number

It sets the space between the target and Tooltip element in X axis.

offsetY

number

It sets the space between the target and Tooltip element in Y axis.

openDelay

number

It is used to open the Tooltip after the specified delay in milliseconds.

opensOn

string

It is used to determine the device mode to display the Tooltip content. If it is in desktop, it will show the Tooltip content when hovering on the target element. If it is in touch device, it will show the Tooltip content when tap and holding on the target element.

position

Position

It is used to set the position of Tooltip element, with respect to Target element.

showTipPointer

boolean

It is used to show or hide the tip pointer of Tooltip.

target

string

It is used to denote the target selector where the Tooltip need to be displayed. The target element is considered as parent container.

tipPointerPosition

TipPointerPosition

It is used to set the position of tip pointer on tooltip. When it sets to auto, the tip pointer auto adjusts within the space of target’s length and does not point outside. Refer the documentation here to know more about this property with demo.

width

string | number

It is used to set the width of Tooltip component which accepts both string and number values. When set to auto, the Tooltip width gets auto adjusted to display its content within the viewable screen.

windowCollision

boolean

It is used to set the collision target element as page viewport (window) or Tooltip element, when using the target. If this property is enabled, tooltip will perform the collision calculation between the target elements and viewport(window) instead of Tooltip element.