Interface HoverModeEventHandlers

An object of event handlers that should be provided to a component to enable and disable the visibility of a temporary element while hovering over that component.

remarks: @since 2.8.0
remarks: @since 5.0.0 The HTMLElement type will be correctly inferred when using them on multiple components.

Hierarchy

HoverModeHoverEventHandlers
- HoverModeEventHandlers
  - HoverModeHookReturnValue

Index

Methods

Methods

onClick

onClick<E>(event: MouseEvent<E, MouseEvent>): void

- Defined in packages/utils/src/hover/useHoverMode.ts:42
An optional event handler to merge with the hover mode visibility hander. If this function calls event.stopPropagation(), the hover mode behavior will be disabled.

Type parameters
- E: HTMLElement
Parameters
- event: MouseEvent<E, MouseEvent>
Returns void

onMouseEnter

onMouseEnter<E>(event: MouseEvent<E, MouseEvent>): void

Inherited from HoverModeHoverEventHandlers.onMouseEnter
- Defined in packages/utils/src/hover/useHoverMode.ts:17
An optional event handler to merge with the hover mode visibility hander. If this function calls event.stopPropagation(), the hover mode behavior will be disabled.

Type parameters
- E: HTMLElement
Parameters
- event: MouseEvent<E, MouseEvent>
Returns void

onMouseLeave

onMouseLeave<E>(event: MouseEvent<E, MouseEvent>): void

Inherited from HoverModeHoverEventHandlers.onMouseLeave
- Defined in packages/utils/src/hover/useHoverMode.ts:24
An optional event handler to merge with the hover mode visibility hander. If this function calls event.stopPropagation(), the hover mode behavior will be disabled.

Type parameters
- E: HTMLElement
Parameters
- event: MouseEvent<E, MouseEvent>
Returns void

Generated using TypeDoc