import{_ as e,c as t,o,N as a}from"./chunks/framework.0799945b.js";const m=JSON.parse('{"title":"Module: features/tooltips/tooltip","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/modules/features/tooltips/tooltip.md","lastUpdated":null}'),l={name:"api/modules/features/tooltips/tooltip.md"},d=a('

Module: features/tooltips/tooltip ​

Components ​

Interfaces ​

Type Aliases ​

GenericTooltip ​

Ƭ GenericTooltip: Replace<Tooltip<TooltipOptions>, { direction: ProcessedComputable<Direction> ; pinnable: boolean ; pinned: Ref<boolean> | undefined }>

A type that matches any valid Tooltip object.

Defined in ​

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

Tooltip ​

Ƭ Tooltip<T>: Replace<T & BaseTooltip, { classes: GetComputableType<T["classes"]> ; direction: GetComputableTypeWithDefault<T["direction"], Up> ; display: GetComputableType<T["display"]> ; pinnable: T["pinnable"] extends undefined ? false : T["pinnable"] ; pinned: T["pinnable"] extends true ? Ref<boolean> : undefined ; style: GetComputableType<T["style"]> ; xoffset: GetComputableType<T["xoffset"]> ; yoffset: GetComputableType<T["yoffset"]> }>

An object that represents a tooltip that appears when hovering over an element.

Type parameters ​

NameType
Textends TooltipOptions

Defined in ​

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

Functions ​

addTooltip ​

▸ addTooltip<T>(element, options): Tooltip<T>

Creates a tooltip on the given element with the given options.

Type parameters ​

NameType
Textends TooltipOptions

Parameters ​

NameTypeDescription
elementVueFeatureThe renderable feature to display the tooltip on.
optionsT & ThisType<Tooltip<T>> & Partial<BaseTooltip>Tooltip options.

Returns ​

Tooltip<T>

Defined in ​

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

',31),i=[d];function r(c,p,s,n,h,u){return o(),t("div",null,i)}const b=e(l,[["render",r]]);export{m as __pageData,b as default};