Tooltip Typescript API

Interface

Tooltip

Tooltip is an alternate for the html title. It displays a popup with details on hover.

Selector

smart-tooltip

Properties

animationAnimation

Sets or gets the animation mode. Animation is disabled when the property is set to 'none'

Default valueadvanced

arrowboolean

Gets or sets whether a tooltip's arrow will be shown.

Default valuefalse

arrowDirectionTooltipArrowDirection

Sets the position of the arrow.

Default valuebottom

delaynumber

Gets or sets whether a tooltip's arrow will be shown.

Default value0

disabledboolean

Enables or disables the tooltip.

Default valuefalse

offsetnumber[]

Sets an offset by X and Y.

localestring

Sets or gets the language. Used in conjunction with the property messages.

Default value"en

localizeFormatFunctionany

Callback, related to localization module.

messagesany

Sets or gets an object specifying strings used in the widget that can be localized. Used in conjunction with the property language.

Default value


"en": {

"propertyUnknownType": "'{{name}}' property is with undefined 'type' member!",

"propertyInvalidValue": "Invalid '{{name}}' property value! Actual value: {{actualValue}}, Expected value: {{value}}!",

"propertyInvalidValueType": "Invalid '{{name}}' property value type! Actual type: {{actualType}}, Expected type: {{type}}!",

"elementNotInDOM": "Element does not exist in DOM! Please, add the element to the DOM, before invoking a method.",

"moduleUndefined": "Module is undefined.",

"missingReference": "{{elementType}}: Missing reference to {{files}}.",

"htmlTemplateNotSuported": "{{elementType}}: Browser doesn't support HTMLTemplate elements.",

"invalidTemplate": "{{elementType}}: '{{property}}' property accepts a string that must match the id of an HTMLTemplate element from the DOM.",

"invalidSelector": "{{elementType}}: '{{property}}' must be a string, an HTMLElement or null.",

"invalidNode": "{{elementType}}: Invalid parameter '{{node}}' when calling {{method}}."

}


openModeTooltipOpenMode

Sets or gets the way of triggering the tooltip.

Default valuehover

positionTooltipPosition

Gets or sets the position of the tooltip.

Default valuetop

selectorany

Sets the element which triggers the tooltip.

themestring

Determines the theme. Theme defines the look of the element

Default value"

tooltipTemplateany

Sets custom tooltip template.

unfocusableboolean

If is set to true, the element cannot be focused.

Default valuefalse

valuestring

Sets or gets the widget's value.

Default value"""

visibleboolean

Sets or gets the visibility of the tooltip.

Default valuefalse

onopen((this: Window, ev: Event) => any) | null

This event is triggered when the tooltip is opened.

Arguments

evEvent

onclose((this: Window, ev: Event) => any) | null

This event is triggered when the tooltip is closed.

Arguments

evEvent

Methods

close(): void

Closes smart-tooltip.


open(): void

Opens smart-tooltip.


toggle(): void

Toggles smart-tooltip.



Enums

Animation

None Simple Advanced

TooltipArrowDirection

Bottom Top Left Right

TooltipOpenMode

Click Focus Hover Manual

TooltipPosition

Bottom Top Left Right Absolute