Tooltip
Directive
kendo-tooltip
Props
auto-hide Boolean
Specifies if the Tooltip will be hidden when the mouse leaves the target element (autoHide
in Kendo UI for jQuery).
- If
autoHide
is set tofalse
, the Tooltip will display a Close button. - If
autoHide
is set tofalse
,showAfter
is specified, andshowOn
is set tomouseenter
, the Tooltip will be displayed after the specific timeout even if the element is no longer hovered over.
animation Boolean | Object
A collection of Animation
objects for changing the default animations (animation
in Kendo UI for jQuery). If animation
is set to false
, the animations will be disabled. The supported composite props are available in AnimationProps
.
content String | Function | Object
The text or the function whose results will be displayed within the tooltip (content
in Kendo UI for jQuery). By default, the tooltip will display the content of the title
attribute of the target element. To retrieve the title
attribute of the target from inside the content function, then use target.data("title")
. The supported composite props are available in ContentProps
.
callout Boolean
Specifies if the Tooltip callout will be displayed (callout
in Kendo UI for jQuery).
filter String
A selector for elements within the container for which the Tooltip will be displayed (filter
in Kendo UI for jQuery).
iframe Boolean
Explicitly states whether content iframe will be created (iframe
in Kendo UI for jQuery).
height Number
The height (in pixels) of the Tooltip (height
in Kendo UI for jQuery).
width Number
The width (in pixels) of the Tooltip (width
in Kendo UI for jQuery).
position String
The position that is relative to the target element at which the Tooltip will be displayed (position
in Kendo UI for jQuery).
The supported predefined values are:
bottom
top
left
right
center
show-after Number
The delay (in milliseconds) before the Tooltip is displayed (showAfter
in Kendo UI for jQuery). If showOn
is set to click
or focus
, show-after
is ignored.
show-on String
The event on which the Tooltip will be displayed (showOn
in Kendo UI for jQuery).
The supported predefined values are:
mouseenter
click
focus
hide-after Number
The delay (in milliseconds) before the Tooltip is hidden (hideAfter
in Kendo UI for jQuery). If showOn
is set to click
or focus
, hide-after
is ignored.
offset Number
Specifies the offset (in pixels) between the Tooltip and the anchor (offset
in Kendo UI for jQuery). If the callout
property is set to true
, the offset is rendered from the callout arrow. If the callout
property is set to false
, the offset is rendered from the content of the Tooltip.
Events
contentload: Function
Fires when an AJAX request for content completes (contentLoad
in Kendo UI for jQuery).
show: Function
Fires when a Tooltip is displayed (show
in Kendo UI for jQuery).
hide: Function
Fires when a Tooltip is hidden (hide
in Kendo UI for jQuery).
requeststart: Function
(Applies for AJAX requests only) Fires before an AJAX request starts (requestStart
in Kendo UI for jQuery).
error: Function
Fires when an AJAX request for content fails (error
in Kendo UI for jQuery).
Methods
For more details about the methods available in the component's API please check its Kendo UI for jQuery API documentation.
kendoWidget
returns
Returns the Kendo UI Tooltip instance.