Profectus / wrappers/tooltips/tooltip / Tooltip
Interface: Tooltip ​
An object that represents a tooltip that appears when hovering over an element.
Extends ​
Properties ​
[VueFeature] ​
[VueFeature]:
true
Used to identify Vue Features
Inherited from ​
Defined in ​
classes? ​
Dictionary of CSS classes to apply to this feature.
Inherited from ​
Defined in ​
components ​
components:
MaybeGetter<Renderable>[]
The components to render inside the vue feature
Inherited from ​
Defined in ​
direction? ​
The direction in which to display the tooltip
Defined in ​
profectus/src/wrappers/tooltips/tooltip.tsx:40
display ​
display:
MaybeGetter<Renderable>
The text to display inside the tooltip.
Defined in ​
profectus/src/wrappers/tooltips/tooltip.tsx:38
id ​
id:
string
An auto-generated ID for identifying features that appear in the DOM. Will not persist between refreshes or updates.
Inherited from ​
Defined in ​
pinnable? ​
optionalpinnable: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:36
pinned? ​
optionalpinned:Ref<boolean,boolean>
Whether or not this tooltip is currently pinned. Undefined if pinnable is false.
Defined in ​
profectus/src/wrappers/tooltips/tooltip.tsx:46
style? ​
optionalstyle:MaybeRef<CSSProperties>
CSS to apply to this feature.
Inherited from ​
Defined in ​
visibility? ​
optionalvisibility:MaybeRef<boolean | Visibility>
Whether this feature should be visible.
Inherited from ​
Defined in ​
wrappers ​
wrappers:
Wrapper[]
The components to render wrapped around the vue feature
Inherited from ​
Defined in ​
xoffset? ​
optionalxoffset:MaybeRef<string>
The x offset of the tooltip, in px.
Defined in ​
profectus/src/wrappers/tooltips/tooltip.tsx:42
yoffset? ​
optionalyoffset:MaybeRef<string>
The y offset of the tooltip, in px.