Skip to main content

Hover event

Hover values

PropertydefaultDescription
deviceType of device
activefalseWhether drag is active.
_activefalseWhether drag is active.
value[0, 0]Current position
_value[0, 0]Previous position
delta[0, 0]Delta of position
offset[0, 0]Offset of position
movement[0, 0]Movement of position
targetnullTarget element

Hover events

Event nameArgumentDescription
hoverHoverStateCalled on all hover events. Mainly events specified
hoverStartEventCalled on hover start events
hoveringEventCalled on hover move events
hoverEndEventCalled on hover end events
mountElementCalled when the component is mounted
cleannullCalled when the component is removed

Hover state

export interface HoverState<El extends Element = Element> {
_active: boolean
active: boolean
device: 'mouse' | 'pointer' | 'touch'
_value: Vec2
value: Vec2
delta: Vec2
offset: Vec2
movement: Vec2
event: Event
target: El
isHoverStart: boolean
isHovering: boolean
isHoverEnd: boolean
hover: (self: HoverState) => void
hoverStart(e: Event): void
hovering(e: Event): void
hoverEnd(e: Event): void
mount(target: El): void
clean(target?: El): void
ref(target: El | null): void
}