TooltipProps

Represents the props of the KendoReact Tooltip component.

anchorElement?

string

Sets the anchor element of the Tooltip.

The available options are:

  • (Default) pointerShows a Tooltip where the cursor is located.
  • targetPositions the Tooltip based on the anchor element.

appendTo?

HTMLElement | null

Defines the container to which the Tooltip will be appended. Defaults to body.

children?

any

Sets the content of the Tooltip.

className?

string

Sets a class of the Tooltip animation container.

content?

any

Sets the content of the Tooltip (see example).

filter?

(target: HTMLElement) => void

Represents a callback function which determines if a Tooltip will be displayed (see example).

onClose?

(event: TooltipEvent) => void

Fires when the Tooltip is hidden.

onOpen?

(event: TooltipEvent) => void

Fires when the Tooltip is shown.

onPosition?

(event: TooltipPositionEvent) => { left: number; top: number; }

Callback called when the Tooltip calculates it's position. Useful to modify the default position behavior. Require to return the top and left position of the Tooltip.

open?

boolean

Specifies if the Tooltip will be open. Sets the Tooltip in its controlled mode (see example). Requires you to set the targetElement property.

openDelay?

number

Sets a delay in milliseconds.

parentTitle?

boolean

If any of the parent elements has a title, displays a Tooltip.

position?

TooltipPosition

Sets the position of the Tooltip (see example).

The available options are:

  • (Default) autoPositions the Tooltip depending on the available space.
  • rightPositions the Tooltip to the right side of the element.
  • leftPositions the Tooltip to the left side of the element.
  • bottomPositions the Tooltip at the bottom of the element.
  • topPositions the Tooltip at the top of the element.

setCalloutOnPositionAuto?

any

When the position is set to auto, sets the start point of the Tooltip callout (in pixels).

showCallout?

boolean

Specifies if the Tooltip callout will be displayed.

style?

CSSProperties

Specifies the styles which are set to the Tooltip animation container.

targetElement?

any

Sets the Tooltip target element. You have to use it with the open property.

tooltipClassName?

string

Specifies the CSS class names which are set to the Tooltip DOM element.

tooltipStyle?

CSSProperties

Specifies the styles which are set to the Tooltip DOM element.

updateInterval?

number

The milliseconds interval on which the Tooltip will check for title change. By default the Tooltip does not track for title updates.