Skip to content
On this page

Interface: TooltipOptions

features/tooltips/tooltip.TooltipOptions

An object that configures a Tooltip.

Properties

classes

Optional classes: Computable<Record<string, boolean>>

Dictionary of CSS classes to apply to this feature.

Defined in

profectus/src/features/tooltips/tooltip.ts:33


direction

Optional direction: Computable<Direction>

The direction in which to display the tooltip

Defined in

profectus/src/features/tooltips/tooltip.ts:37


display

display: Computable<CoercableComponent>

The text to display inside the tooltip.

Defined in

profectus/src/features/tooltips/tooltip.ts:31


pinnable

Optional pinnable: boolean

Whether or not this tooltip can be pinned, meaning it'll stay visible even when not hovered.

Defined in

profectus/src/features/tooltips/tooltip.ts:29


style

Optional style: Computable<StyleValue>

CSS to apply to this feature.

Defined in

profectus/src/features/tooltips/tooltip.ts:35


xoffset

Optional xoffset: Computable<string>

The x offset of the tooltip, in px.

Defined in

profectus/src/features/tooltips/tooltip.ts:39


yoffset

Optional yoffset: Computable<string>

The y offset of the tooltip, in px.

Defined in

profectus/src/features/tooltips/tooltip.ts:41