Bio Tooltips

Appearance

bio-tooltips

Interfaces ​

CoreTooltipConfig ​

Defined in: core/config.ts:60

Extended by ​

Properties ​

constrainToViewport ​

constrainToViewport: boolean

Defined in: core/config.ts:77

debugTimings ​

debugTimings: boolean

Defined in: core/config.ts:69

display? ​

optional display?: unknown

Defined in: core/config.ts:78

nestedTooltipOptions ​

nestedTooltipOptions: TooltipOptions

Defined in: core/config.ts:74

onTiming? ​

optional onTiming?: TooltipTimingObserver

Defined in: core/config.ts:70

prefetch ​

prefetch: PrefetchMode

Defined in: core/config.ts:66

prefetchThreshold ​

prefetchThreshold: number

Defined in: core/config.ts:67

presentation? ​

optional presentation?: TooltipPresentation

Defined in: core/config.ts:65

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

sectionVariant ​

sectionVariant: SectionVariant

Defined in: core/config.ts:72

selector ​

selector: string

Defined in: core/config.ts:61

theme ​

theme: TooltipTheme

Defined in: core/config.ts:71

tooltipHeight? ​

optional tooltipHeight?: number

Defined in: core/config.ts:76

tooltipOptions ​

tooltipOptions: TooltipOptions

Defined in: core/config.ts:73

tooltipWidth? ​

optional tooltipWidth?: number

Defined in: core/config.ts:75

triggerStyle ​

triggerStyle: TooltipTriggerStyle

Defined in: core/config.ts:63

Visual cue applied to initialized tooltip triggers. Defaults to none.

visualPreload ​

visualPreload: VisualPreloadMode

Defined in: core/config.ts:68

TooltipTimingEvent ​

Defined in: core/config.ts:50

Properties ​

details? ​

optional details?: Record<string, unknown>

Defined in: core/config.ts:55

elapsedMs ​

elapsedMs: number

Defined in: core/config.ts:52

label ​

label: string

Defined in: core/config.ts:51

timestampMs ​

timestampMs: number

Defined in: core/config.ts:53

tooltipId? ​

optional tooltipId?: string

Defined in: core/config.ts:54

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

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

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

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

Parameters ​

event ​

TooltipTimingEvent

Returns ​

void

TooltipTriggerStyle ​

TooltipTriggerStyle = "none" | TooltipTriggerStylePreset | readonly TooltipTriggerStylePreset[]

Defined in: core/config.ts:7

TooltipTriggerStylePreset ​

TooltipTriggerStylePreset = "dotted" | "solid" | "bold"

Defined in: core/config.ts:6

VisualPreloadMode ​

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

Defined in: core/config.ts:3

Variables ​

defaultCoreConfig ​

const defaultCoreConfig: CoreTooltipConfig

Defined in: core/config.ts:81