Skip to content

bio-tooltips


Interfaces

CoreTooltipConfig

Defined in: core/config.ts:55

Extended by

Properties

constrainToViewport

constrainToViewport: boolean

Defined in: core/config.ts:70

debugTimings

debugTimings: boolean

Defined in: core/config.ts:62

display?

optional display?: unknown

Defined in: core/config.ts:71

nestedTooltipOptions

nestedTooltipOptions: TooltipOptions

Defined in: core/config.ts:67

onTiming?

optional onTiming?: TooltipTimingObserver

Defined in: core/config.ts:63

prefetch

prefetch: PrefetchMode

Defined in: core/config.ts:59

prefetchThreshold

prefetchThreshold: number

Defined in: core/config.ts:60

presentation?

optional presentation?: TooltipPresentation

Defined in: core/config.ts:58

How top-level tooltip dialogs are presented. Nested tooltips remain popovers.

sectionVariant

sectionVariant: SectionVariant

Defined in: core/config.ts:65

selector

selector: string

Defined in: core/config.ts:56

theme

theme: TooltipTheme

Defined in: core/config.ts:64

tooltipHeight?

optional tooltipHeight?: number

Defined in: core/config.ts:69

tooltipOptions

tooltipOptions: TooltipOptions

Defined in: core/config.ts:66

tooltipWidth?

optional tooltipWidth?: number

Defined in: core/config.ts:68

visualPreload

visualPreload: VisualPreloadMode

Defined in: core/config.ts:61


TooltipTimingEvent

Defined in: core/config.ts:45

Properties

details?

optional details?: Record<string, unknown>

Defined in: core/config.ts:50

elapsedMs

elapsedMs: number

Defined in: core/config.ts:47

label

label: string

Defined in: core/config.ts:46

timestampMs

timestampMs: number

Defined in: core/config.ts:48

tooltipId?

optional tooltipId?: string

Defined in: core/config.ts:49

Type Aliases

FixedPlacement

FixedPlacement = "top" | "top-start" | "top-end" | "right" | "right-start" | "right-end" | "bottom" | "bottom-start" | "bottom-end" | "left" | "left-start" | "left-end"

Defined in: core/config.ts:7


PrefetchMode

PrefetchMode = "smart" | "all" | "none"

Defined in: core/config.ts:1


SectionVariant

SectionVariant = "cards" | "dividers"

Defined in: core/config.ts:4


TooltipOptions

TooltipOptions = TooltipPlacementOptions & object

Defined in: core/config.ts:33

Type Declaration

appendTo?

optional appendTo?: HTMLElement | (() => HTMLElement)

hideDelay?

optional hideDelay?: number

hideDuration?

optional hideDuration?: number

offset?

optional offset?: number

showDelay?

optional showDelay?: number

showDuration?

optional showDuration?: number

strategy?

optional strategy?: "absolute" | "fixed"

viewportPadding?

optional viewportPadding?: number

zIndex?

optional zIndex?: number


TooltipPlacementOptions

TooltipPlacementOptions = { allowedPlacements?: never; fallbackPlacements?: FixedPlacement[]; placement?: FixedPlacement; } | { allowedPlacements?: FixedPlacement[]; fallbackPlacements?: never; placement: "auto"; }

Defined in: core/config.ts:21


TooltipPresentation

TooltipPresentation = "auto" | "popover" | "drawer"

Defined in: core/config.ts:5


TooltipTheme

TooltipTheme = "light" | "dark" | "auto" | "material" | "translucent" | "light-border" | undefined

Defined in: core/config.ts:2


TooltipTimingObserver

TooltipTimingObserver = (event) => void

Defined in: core/config.ts:53

Parameters

event

TooltipTimingEvent

Returns

void


VisualPreloadMode

VisualPreloadMode = "none" | "hover" | "init"

Defined in: core/config.ts:3

Variables

defaultCoreConfig

const defaultCoreConfig: CoreTooltipConfig

Defined in: core/config.ts:74