New to Kendo UI for Vue? Start a free 30-day trial

TooltipProps

Interface

Represents the props of the Kendo UI for Vue Tooltip component.

Definition

Package:@progress/kendo-vue-tooltip

Properties

Sets the element that the Tooltip uses as its anchor.

The available options are:

  • (Default) pointer—Shows the Tooltip where the cursor is.
  • target—Positions the Tooltip next to the target element.
Default:

pointer

appendTo?

HTMLElement

Sets the container to which the Tooltip is appended. When you do not set it, the Tooltip is appended to the body element.

Sets a CSS class on the animation container of the Tooltip.

Sets the content of the Tooltip (see example). Accepts a Vue component, a render function, or a slot name.

filter?

(target: HTMLElement) => void

Sets a callback that decides if the Tooltip shows for an element (see example).

Parameters:targetHTMLElement

onClose?

(event: TooltipEvent) => void

Fires when the Tooltip closes.

Parameters:eventTooltipEvent

onOpen?

(event: TooltipEvent) => void

Fires when the Tooltip opens.

Parameters:eventTooltipEvent

open?

boolean

Sets if the Tooltip is open. When you set it, the Tooltip works in controlled mode (see example). You also have to set the targetElement property.

Sets the delay in milliseconds before the Tooltip opens.

Default:

400

Sets if the Tooltip shows the title of a parent element when the target element has no title.

Default:

false

position?

String | TooltipPosition

Sets the position of the Tooltip (see example).

The available options are:

  • (Default) auto—Positions the Tooltip based on the available space.
  • right—Positions the Tooltip to the right of the element.
  • left—Positions the Tooltip to the left of the element.
  • bottom—Positions the Tooltip below the element.
  • top—Positions the Tooltip above the element.
Default:

auto

Sets the start point of the Tooltip callout in pixels when position is auto.

Sets if the Tooltip shows a callout.

Default:

true

Sets the target element of the Tooltip. Use it together with the open property.

Sets CSS classes on the Tooltip element.

Sets the styles of the Tooltip element.

Sets the interval in milliseconds at which the Tooltip checks for title changes. When you do not set it, the Tooltip does not track title changes.

Sets a callback that runs when the Tooltip calculates its position. Use it to change the default position. The callback must return the top and left position of the Tooltip.

Parameters:eventTooltipPositionEventReturns:

{ top: number; left: number }

Sets the styles of the animation container of the Tooltip.