Skip to content

Profectus / wrappers/tooltips/tooltip / TooltipOptions

Interface: TooltipOptions ​

An object that configures a Tooltip.

Extends ​

Properties ​

classes? ​

optional classes: MaybeRefOrGetter<Record<string, boolean>>

Dictionary of CSS classes to apply to this feature.

Inherited from ​

VueFeatureOptions.classes

Defined in ​

profectus/src/util/vue.tsx:24


direction? ​

optional direction: MaybeRefOrGetter<Direction>

The direction in which to display the tooltip

Defined in ​

profectus/src/wrappers/tooltips/tooltip.tsx:26


display ​

display: MaybeGetter<Renderable>

The text to display inside the tooltip.

Defined in ​

profectus/src/wrappers/tooltips/tooltip.tsx:24


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/wrappers/tooltips/tooltip.tsx:22


style? ​

optional style: MaybeRefOrGetter<CSSProperties>

CSS to apply to this feature.

Inherited from ​

VueFeatureOptions.style

Defined in ​

profectus/src/util/vue.tsx:26


visibility? ​

optional visibility: MaybeRefOrGetter<boolean | Visibility>

Whether this feature should be visible.

Inherited from ​

VueFeatureOptions.visibility

Defined in ​

profectus/src/util/vue.tsx:22


xoffset? ​

optional xoffset: MaybeRefOrGetter<string>

The x offset of the tooltip, in px.

Defined in ​

profectus/src/wrappers/tooltips/tooltip.tsx:28


yoffset? ​

optional yoffset: MaybeRefOrGetter<string>

The y offset of the tooltip, in px.

Defined in ​

profectus/src/wrappers/tooltips/tooltip.tsx:30