Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface HoverModeReturnValue<E>

remarks

@since 2.8.0

Type parameters

  • E: HTMLElement

Hierarchy

Index

Properties

active

active: boolean

Boolean if the hover mode is currently working.

handlers

handlers: Required<HoverModeEventHandlers<E>>

{@inheritDoc HoverModeEventHandlers}

setVisible

setVisible: Dispatch<SetStateAction<boolean>>

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

Optional stickyHandlers

stickyHandlers: Required<HoverModeEventHandlers<E>>

{@inheritDoc StickyHoverModeEventHandlers}

Optional stuck

stuck: boolean

Boolean if the the visible state is true because the user clicked an element with the stickyHandlers.

visible

visible: boolean

Boolean if the temporary element should be visible.

Methods

disableHoverMode

  • disableHoverMode(): void

enableHoverMode

  • enableHoverMode(): void

startDisableTimer

  • startDisableTimer(): void

Generated using TypeDoc