Skip to content

HoverOptions

HoverOptions = object

Defined in: client/hover.ts:8

optional above: boolean

Defined in: client/hover.ts:10

Whether the prefered position of the tooltip is above the token.

false

optional allowChildren: boolean

Defined in: client/hover.ts:19

Whether the callback will be called for tokens that have elements as children.

false

optional delay: number

Defined in: client/hover.ts:24

Delay before the tooltip is opened in milliseconds. If omitted, the tooltip opens immediately.


optional maxHeight: string

Defined in: client/hover.ts:14

A CSS length value for the tooltip’s max height.


optional maxWidth: string

Defined in: client/hover.ts:12

A CSS length value for the tooltip’s max width.


optional warmDuration: number

Defined in: client/hover.ts:32

The opening delay can be temporarily removed after closing a tooltip, and this option controls for how many milliseconds it is removed. If omitted, the delay is always applied. When a tooltip gets opened with no delay, it gets the pce-instant class added. The .pce-instant selector can therefore be used to remove CSS transitions when opened with no delay for example.