bio-tooltips

---

Classes

TooltipController

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

Type Parameters

TData

TData = unknown

Constructors

Constructor

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

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

Parameters

reference

Element

options

TooltipControllerOptions<TData>

Returns

TooltipController<TData>

Properties

_entityCacheKey?

optional _entityCacheKey?: string

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

_entityData?

optional _entityData?: TData | null

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

_isPinned?

optional _isPinned?: boolean

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

_isPointerInside?

optional _isPointerInside?: boolean

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

_nestedTooltips

_nestedTooltips: TooltipController<any>[] = []

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

_peerDismissed?

optional _peerDismissed?: boolean

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

_pinButton?

optional _pinButton?: HTMLElement | null

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

_renderedVisualSections?

optional _renderedVisualSections?: Set<string>

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

_renderingVisualSections?

optional _renderingVisualSections?: Set<string>

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

_sectionKeydownHandler?

optional _sectionKeydownHandler?: (event) => void

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

Parameters

event

KeyboardEvent

Returns

void

_sectionToggleHandler?

optional _sectionToggleHandler?: (event) => void

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

Parameters

event

Event

Returns

void

_themeIntent?

optional _themeIntent?: string

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

_timingStart?

optional _timingStart?: number

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

_uniqueId?

optional _uniqueId?: string

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

_visualRenderPromise?

optional _visualRenderPromise?: Promise<void>

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

_visualsRendered?

optional _visualsRendered?: boolean

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

_visualViewportResizeHandler?

optional _visualViewportResizeHandler?: () => void

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

Returns

void

arrow

readonly arrow: HTMLDivElement

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

box

readonly box: HTMLDivElement

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

content

readonly content: HTMLDivElement

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

options

options: TooltipControllerOptions<TData>

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

reference

readonly reference: Element

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

root

readonly root: HTMLDivElement

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

state

readonly state: object

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

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:70

theme

theme: string

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

Methods

addNestedTooltip()

addNestedTooltip(child): void

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

Parameters

child

TooltipController<any>

Returns

void

close()

close(): void

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

Explicitly dismiss this controller, including pinned dialogs.

Returns

void

destroy()

destroy(): void

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

Returns

void

destroyNestedTooltips()

destroyNestedTooltips(): void

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

Returns

void

dismiss()

dismiss(): void

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

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 and tooltips whose panel holds keyboard focus are left untouched — a focus on the trigger alone does not protect a peer dismissal.

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:443

Explicitly enter a dialog from keyboard activation.

Returns

void

hasFocus()

hasFocus(): boolean

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

Returns

boolean

hide()

hide(): void

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

Returns

void

isDrawerPresentation()

isDrawerPresentation(): boolean

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

The resolved presentation currently used by this controller.

Returns

boolean

open()

open(options?): void

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

Open immediately, optionally moving focus into the dialog.

Parameters

options?

TooltipOpenOptions = {}

Returns

void

removeNestedTooltip()

removeNestedTooltip(child): void

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

Parameters

child

TooltipController<any>

Returns

void

setContent()

setContent(content): void

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

Parameters

content

string

Returns

void

setPinned()

setPinned(pinned): void

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

Parameters

pinned

boolean

Returns

void

setPresentation()

setPresentation(presentation): void

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

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:326

Parameters

theme

string

Returns

void

show()

show(): void

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

Returns

void

syncPinButton()

syncPinButton(): void

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

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

Returns

void

updateOptions()

updateOptions(options): void

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

Parameters

options

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

Returns

void

updatePosition()

updatePosition(): Promise<void>

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

Returns

Promise<void>

Interfaces

TooltipControllerHooks

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

Type Parameters

TData

TData

Properties

onDestroy?

optional onDestroy?: (instance) => void

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

Parameters

instance

TooltipController<TData>

Returns

void

onHide?

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

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

Parameters

instance

TooltipController<TData>

Returns

false | void

onShow?

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

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

Parameters

instance

TooltipController<TData>

Returns

false | void

onShown?

optional onShown?: (instance) => void

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

Parameters

instance

TooltipController<TData>

Returns

void

---

TooltipControllerOptions

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

Type Parameters

TData

TData

Properties

accessibleName?

optional accessibleName?: string

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

constrainToViewport?

optional constrainToViewport?: boolean

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

content?

optional content?: string

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

hooks?

optional hooks?: TooltipControllerHooks<TData>

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

interactiveBorder?

optional interactiveBorder?: number

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

interactiveDebounce?

optional interactiveDebounce?: number

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

kind?

optional kind?: "dialog" | "tooltip"

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

maxHeight?

optional maxHeight?: number

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

maxWidth?

optional maxWidth?: number

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

parent?

optional parent?: TooltipController<any>

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

presentation?

optional presentation?: TooltipPresentation

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

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

theme

theme: string

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

timingConfig?

optional timingConfig?: CoreTooltipConfig

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

tooltip

tooltip: TooltipOptions

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

Type Aliases

TooltipStatus

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

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

Functions

createStaticTooltip()

createStaticTooltip(reference, content, options): TooltipController

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

Parameters

reference

Element

content

string

options

Omit<TooltipControllerOptions<unknown>, "content">

Returns

TooltipController