bio-tooltips

---

Classes

TooltipController

Defined in: core/tooltip-controller.ts:101

Type Parameters

TData

TData = unknown

Constructors

Constructor

new TooltipController<TData>(reference, options): TooltipController<TData>

Defined in: core/tooltip-controller.ts:191

Parameters

reference

Element

options

TooltipControllerOptions<TData>

Returns

TooltipController<TData>

Properties

_entityCacheKey?

optional _entityCacheKey?: string

Defined in: core/tooltip-controller.ts:120

_entityData?

optional _entityData?: TData | null

Defined in: core/tooltip-controller.ts:119

_isPinned?

optional _isPinned?: boolean

Defined in: core/tooltip-controller.ts:130

_isPointerInside?

optional _isPointerInside?: boolean

Defined in: core/tooltip-controller.ts:131

_nestedTooltips

_nestedTooltips: TooltipController<any>[] = []

Defined in: core/tooltip-controller.ts:118

_peerDismissed?

optional _peerDismissed?: boolean

Defined in: core/tooltip-controller.ts:138

_pinButton?

optional _pinButton?: HTMLElement | null

Defined in: core/tooltip-controller.ts:139

_renderedVisualSections?

optional _renderedVisualSections?: Set<string>

Defined in: core/tooltip-controller.ts:127

_renderingVisualSections?

optional _renderingVisualSections?: Set<string>

Defined in: core/tooltip-controller.ts:128

_sectionKeydownHandler?

optional _sectionKeydownHandler?: (event) => void

Defined in: core/tooltip-controller.ts:124

Parameters

event

KeyboardEvent

Returns

void

_sectionToggleHandler?

optional _sectionToggleHandler?: (event) => void

Defined in: core/tooltip-controller.ts:123

Parameters

event

Event

Returns

void

_themeIntent?

optional _themeIntent?: string

Defined in: core/tooltip-controller.ts:122

_timingStart?

optional _timingStart?: number

Defined in: core/tooltip-controller.ts:129

_uniqueId?

optional _uniqueId?: string

Defined in: core/tooltip-controller.ts:121

_visualRenderPromise?

optional _visualRenderPromise?: Promise<void>

Defined in: core/tooltip-controller.ts:126

_visualsRendered?

optional _visualsRendered?: boolean

Defined in: core/tooltip-controller.ts:125

_visualViewportResizeHandler?

optional _visualViewportResizeHandler?: () => void

Defined in: core/tooltip-controller.ts:140

Returns

void

arrow

readonly arrow: HTMLDivElement

Defined in: core/tooltip-controller.ts:106

box

readonly box: HTMLDivElement

Defined in: core/tooltip-controller.ts:104

content

readonly content: HTMLDivElement

Defined in: core/tooltip-controller.ts:105

options

options: TooltipControllerOptions<TData>

Defined in: core/tooltip-controller.ts:116

reference

readonly reference: Element

Defined in: core/tooltip-controller.ts:102

root

readonly root: HTMLDivElement

Defined in: core/tooltip-controller.ts:103

state

readonly state: object

Defined in: core/tooltip-controller.ts:107

isDestroyed

isDestroyed: boolean = false

isMounted

isMounted: boolean = false

isShown

isShown: boolean = false

isVisible

isVisible: boolean = false

status

status: TooltipStatus = 'idle'

Defined in: core/tooltip-controller.ts:114

theme

theme: string

Defined in: core/tooltip-controller.ts:115

Methods

addNestedTooltip()

addNestedTooltip(child): void

Defined in: core/tooltip-controller.ts:446

Parameters

child

TooltipController<any>

Returns

void

close()

close(): void

Defined in: core/tooltip-controller.ts:552

Explicitly dismiss this controller, including pinned dialogs.

Returns

void

destroy()

destroy(): void

Defined in: core/tooltip-controller.ts:484

Returns

void

destroyNestedTooltips()

destroyNestedTooltips(): void

Defined in: core/tooltip-controller.ts:460

Returns

void

dismiss()

dismiss(): void

Defined in: core/tooltip-controller.ts:395

Close this tooltip immediately, bypassing the interactive hide debounce and the pointer bridge that otherwise keep an open panel alive while the cursor drifts toward the next trigger. The engine calls this on the open siblings whenever a tooltip opens so only one top-level tooltip is visible at a time. Pinned tooltips are left untouched. Keyboard focus inside an unpinned panel is restored to its trigger as the panel closes, preserving focus while still enforcing the single-open-tooltip rule.

The _peerDismissed flag marks this close as "lost to a sibling" so that hovering this tooltip's own panel cannot revive it (its panel may still be under the cursor, now covered by the sibling's panel). The flag is cleared once the tooltip is fully unmounted or genuinely reopens.

Returns

void

enter()

enter(): void

Defined in: core/tooltip-controller.ts:546

Explicitly enter a dialog from keyboard activation.

Returns

void

hasFocus()

hasFocus(): boolean

Defined in: core/tooltip-controller.ts:1533

Returns

boolean

hide()

hide(): void

Defined in: core/tooltip-controller.ts:356

Returns

void

isDrawerPresentation()

isDrawerPresentation(): boolean

Defined in: core/tooltip-controller.ts:289

The resolved presentation currently used by this controller.

Returns

boolean

open()

open(options?): void

Defined in: core/tooltip-controller.ts:530

Open immediately, optionally moving focus into the dialog.

Parameters

options?

TooltipOpenOptions = {}

Returns

void

removeNestedTooltip()

removeNestedTooltip(child): void

Defined in: core/tooltip-controller.ts:454

Parameters

child

TooltipController<any>

Returns

void

setContent()

setContent(content): void

Defined in: core/tooltip-controller.ts:409

Parameters

content

string

Returns

void

setPinned()

setPinned(pinned): void

Defined in: core/tooltip-controller.ts:466

Parameters

pinned

boolean

Returns

void

setPresentation()

setPresentation(presentation): void

Defined in: core/tooltip-controller.ts:294

Update the presentation setting, including a live auto breakpoint change.

Parameters

presentation

TooltipPresentation

Returns

void

setTheme()

setTheme(theme): void

Defined in: core/tooltip-controller.ts:421

Parameters

theme

string

Returns

void

show()

show(): void

Defined in: core/tooltip-controller.ts:337

Returns

void

syncPinButton()

syncPinButton(): void

Defined in: core/tooltip-controller.ts:1187

Synchronize a rendered pin control with the controller's current state.

Returns

void

updateOptions()

updateOptions(options): void

Defined in: core/tooltip-controller.ts:428

Parameters

options

Partial<Omit<TooltipControllerOptions<TData>, "tooltip">> & object

Returns

void

updatePosition()

updatePosition(): Promise<void>

Defined in: core/tooltip-controller.ts:442

Returns

Promise<void>

Interfaces

TooltipControllerHooks

Defined in: core/tooltip-controller.ts:26

Type Parameters

TData

TData

Properties

onDestroy?

optional onDestroy?: (instance) => void

Defined in: core/tooltip-controller.ts:30

Parameters

instance

TooltipController<TData>

Returns

void

onHide?

optional onHide?: (instance) => false | void

Defined in: core/tooltip-controller.ts:29

Parameters

instance

TooltipController<TData>

Returns

false | void

onShow?

optional onShow?: (instance) => false | void

Defined in: core/tooltip-controller.ts:27

Parameters

instance

TooltipController<TData>

Returns

false | void

onShown?

optional onShown?: (instance) => void

Defined in: core/tooltip-controller.ts:28

Parameters

instance

TooltipController<TData>

Returns

void

---

TooltipControllerOptions

Defined in: core/tooltip-controller.ts:33

Type Parameters

TData

TData

Properties

accessibleName?

optional accessibleName?: string

Defined in: core/tooltip-controller.ts:48

constrainToViewport?

optional constrainToViewport?: boolean

Defined in: core/tooltip-controller.ts:37

content?

optional content?: string

Defined in: core/tooltip-controller.ts:34

hooks?

optional hooks?: TooltipControllerHooks<TData>

Defined in: core/tooltip-controller.ts:43

interactiveBorder?

optional interactiveBorder?: number

Defined in: core/tooltip-controller.ts:40

interactiveDebounce?

optional interactiveDebounce?: number

Defined in: core/tooltip-controller.ts:41

kind?

optional kind?: "dialog" | "tooltip"

Defined in: core/tooltip-controller.ts:47

maxHeight?

optional maxHeight?: number

Defined in: core/tooltip-controller.ts:39

maxWidth?

optional maxWidth?: number

Defined in: core/tooltip-controller.ts:38

parent?

optional parent?: TooltipController<any>

Defined in: core/tooltip-controller.ts:42

presentation?

optional presentation?: TooltipPresentation

Defined in: core/tooltip-controller.ts:50

Presentation for top-level dialogs. Nested tooltips always use popovers.

theme

theme: string

Defined in: core/tooltip-controller.ts:36

timingConfig?

optional timingConfig?: CoreTooltipConfig

Defined in: core/tooltip-controller.ts:46

tooltip

tooltip: TooltipOptions

Defined in: core/tooltip-controller.ts:35

triggerStyle?

optional triggerStyle?: TooltipTriggerStyle

Defined in: core/tooltip-controller.ts:52

Explicitly managed for configured triggers; omitted nested controllers are untouched.

Type Aliases

TooltipStatus

TooltipStatus = "idle" | "opening" | "open" | "closing" | "destroyed"

Defined in: core/tooltip-controller.ts:24

Functions

createStaticTooltip()

createStaticTooltip(reference, content, options): TooltipController

Defined in: core/tooltip-controller.ts:1756

Parameters

reference

Element

content

string

options

Omit<TooltipControllerOptions<unknown>, "content">

Returns

TooltipController