Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface HoverModeOptions<E>

remarks

@since 2.8.0

Type parameters

  • E: HTMLElement

Hierarchy

Index

Properties

Properties

Optional defaultVisible

defaultVisible: boolean

Boolean if the element should start visible.

defaultvalue

false

Optional disabled

disabled: boolean

Boolean if the hover mode functionality should be disabled.

defaultvalue

false

Optional exitVisibilityDelay

exitVisibilityDelay: number

The amount of time to wait once the mouse has left the element before setting the visibility to false.

This will default to 0 if the sticky option is omitted or false.

defaultvalue

0 or DEFAULT_HOVER_MODE_STICKY_EXIT_TIME

Optional onClick

onClick: MouseEventHandler<E>

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.

Optional onMouseEnter

onMouseEnter: MouseEventHandler<E>

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.

Optional onMouseLeave

onMouseLeave: MouseEventHandler<E>

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.

Optional sticky

sticky: boolean

Boolean if the hover mode should also provide a "sticky" mode which allows the exit behavior to be disabled if the element is clicked.

Generated using TypeDoc