pointer-proxy

Takes a DOM element and simplifies it’s pointer events. Add a transform filter to modify or drop certain events.

Usage no npm install needed!

<script type="module">
  import pointerProxy from 'https://cdn.skypack.dev/pointer-proxy';
</script>

README

PointerProxy

Simplifies working with pointer events on dom elements.

A Pointer Proxy recieves a dom element and listens for (polyfilled) pointer events on it, emitting them as PointerEvent objects (as specified below) to attached event listeners.

Pass an optional filter function to stop events from being forwarded by returning false.

Example usage:

    var element = document.querySelector('#testElement');

    var proxy = new PointerProxy(element);

    // Listen for pointermove events:
    proxy.on('pointermove', function (event) {
      console.log(event.point);
      console.log(event.type);
      console.log(event.time);
    });
    

Events that can be listened for on Pointer Proxy:

pointerover/pointerenter
The pointer/finger is moved into the boundaries of an element. Also fired prior to firing a pointerdown event for devices that do not support hover.

pointerout/leave
The pointer/finger is moved out of the boundaries of an element.

pointerdown
The pointer/finger pressed on the element.

pointerup
The pointer/finger press was released on the element.

pointermove
The pointer/finger changed coordinates on top of the element.

pointercancel

PointerEvent properties

PointerEvent#point
the point relative to the element as an object with x and y properties

PointerEvent#pagePoint
the point relative to the page as an object with x and y properties

PointerEvent#type
the type of pointer event as a string

PointerEvent#time
the time of the event as a date

PointerEvent#originalEvent
the original browser event

Forwarding all pointer events

    var element = document.querySelector('#testElement');

    var proxy = new PointerProxy(element);

    // Forward all events to other event emitter:
    proxy.forwardEvents(otherEventEmitter);

    otherEventEmitter.on('pointermove', function(event) {
      console.log(event.point);
    });

Filtering out events

    var element = document.querySelector('#testElement');

    var filter = function (event) {
      // Only forward the event if the alt key is pressed
      return !!event.altKey;
    };

    var proxy = new PointerProxy(element, filter);

    proxy.on('pointermove', function (event) {
      console.log(event);
    });