positionFromEvent

Type:Function
Status:stable
Since:1.0.0
Platform:js
@blackbyte.sugar.js.dom.position

Get the position from an event like:

  • touchstart
  • touchmove
  • touchend
  • touchcancel
  • mousedown
  • mouseup
  • mousemove
  • mouseover
  • mouseout
  • mouseenter
  • mouseleave
  • pointerdown
  • pointerup
  • pointermove
  • pointerover
  • pointerout
  • pointerenter
  • pointerleave

Params

  1. event*-MouseEvent|PointerEvent|TouchEvent

    The event to get the position from

Return

  1. -x: number; y: number;

    The absolute position of the event

Example

import { positionFromEvent } from '@blackbyte/sugar/dom'
positionFromEvent(e);
// output : { x, 230, y: 122 }

Todo

  • testsnormal