hoverStop

Commons
stable

Marks a hover event with the internal stop token so that ancestor hover handlers skip processing — the equivalent of stopPropagation for the Origam hover system.

API

Signature

Full TypeScript signature sourced from the util file.

typescript

API

Parameters

Input parameters accepted by this util.

e
required
THoverEvent
The hover event object (a MouseEvent extended with the Origam internal stop key). Mutated in place by setting the stop flag.

API

Return value

The value returned by this util.

Nothing. The event object is mutated in place.

Usage

Examples

Ready-to-paste usage snippets.

Stop hover propagation on a nested element

typescript