Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface HoverModeHookReturnValue

remarks

@since 5.0.0

Hierarchy

Index

Properties

active: boolean

Boolean if the hover mode is currently working.

handlers: Readonly<HoverModeEventHandlers>

A convenience prop that allows you to spread all the hover mode event handlers onto a single component if no custom functionality is required.

remarks

@since 5.0.0

hoverHandlers: Readonly<HoverModeHoverEventHandlers>

A convenience prop that allows you to spread only the onMouseEnter and onMouseLeave the hover mode event handlers onto a single component if no custom functionality is required.

remarks

@since 5.0.0

setVisible: Dispatch<SetStateAction<boolean>>

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

stuck: boolean

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

visible: boolean

Boolean if the temporary element should be visible.

Methods

  • clearHoverTimeout(): void
  • disableHoverMode(): void
  • enableHoverMode(): void
  • onClick<E>(event: MouseEvent<E, MouseEvent>): void
  • onMouseEnter<E>(event: MouseEvent<E, MouseEvent>): void
  • onMouseLeave<E>(event: MouseEvent<E, MouseEvent>): void
  • startDisableTimer(): void

Generated using TypeDoc