# pointer-proxy

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

Latest version **0.0.4** (published 2015-03-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install pointer-proxy
pnpm add pointer-proxy
yarn add pointer-proxy
bun add pointer-proxy
```

## Health

**Score 5/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: insecure dependencies; abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.4 |
| Published | 2015-03-12 |
| First published | 2015-03-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Studio Moniker |
| Maintainers | puckey |
| Keywords | dom, events, touch, mouse |

## Links

- npm: https://www.npmjs.com/package/pointer-proxy
- Repository: https://github.com/studiomoniker/pointer-proxy
- Issues: https://github.com/studiomoniker/pointer-proxy/issues
- npm.io page: https://npm.io/package/pointer-proxy

## Dependencies (2)

- [points](https://npm.io/package/points.md) git://github.com/Rich-Harris/Points
- [eventemitter2](https://npm.io/package/eventemitter2.md) ^0.4.14

## Alternatives

- [babylon](https://npm.io/package/babylon.md) — 5.1M weekly downloads
- [csscolorparser](https://npm.io/package/csscolorparser.md) — 3.7M weekly downloads
- [expr-eval-fork](https://npm.io/package/expr-eval-fork.md) — 1.5M weekly downloads
- [@leeoniya/ufuzzy](https://npm.io/package/@leeoniya/ufuzzy.md) — 247.7K weekly downloads
- [xml-parser](https://npm.io/package/xml-parser.md) — 78.4K weekly downloads

## Recent versions

- 0.0.4 (latest) — 2015-03-12
- 0.0.3 — 2015-03-12
- 0.0.2 — 2015-03-12
- 0.0.1 — 2015-03-12

## README

# PointerProxy
Simplifies working with pointer events on dom elements. 

A Pointer Proxy recieves a dom element and listens for (polyfilled) [pointer events](http://www.w3.org/TR/pointerevents/) 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:

````javascript
    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

````javascript
    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

````javascript
    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);
    });
````

---
_Source: https://npm.io/package/pointer-proxy · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._