Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TooltipHookReturnValue<E>

Note: This is really an internal type since this is handled automatically from the Tooltipped component.

remarks

@since 2.8.0

Type parameters

  • E: HTMLElement

Hierarchy

  • Omit<HoverModeOnlyReturnValue<E>, "handlers">
    • TooltipHookReturnValue

Index

Properties

active

active: boolean

Boolean if the hover mode is currently working.

elementProps

These are the props that should be provided to the element the tooltip is attached to.

handlers

handlers: Required<TooltippedElementEventHandlers<E>>

{@inheritDoc TooltippedElementEventHandlers}

setVisible

setVisible: Dispatch<SetStateAction<boolean>>

A function to manually set the visibility state if you need even more custom behavior.

tooltipProps

These props should be provided to the Tooltip component.

visible

visible: boolean

Boolean if the temporary element should be visible.

Methods

disableHoverMode

  • disableHoverMode(): void

enableHoverMode

  • enableHoverMode(): void

startDisableTimer

  • startDisableTimer(): void
  • A function that will start a timer for disabling the hover mode for all connected components. This should normally be called after leaving a hoverable element

    Returns void

Generated using TypeDoc