# mouse-event-offset

> get relative position from an event

Latest version **3.0.2** (published 2015-09-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install mouse-event-offset
pnpm add mouse-event-offset
yarn add mouse-event-offset
bun add mouse-event-offset
```

## Health

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

Positive: has types package; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.0.2 |
| Published | 2015-09-29 |
| First published | 2014-08-31 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/mouse-event-offset) |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 29 |
| Author | Matt DesLauriers |
| Maintainers | mattdesl |
| Keywords | mouse, event, offset, top, left, corner, clientX, clientY, offsetX, offsetY, getBoundingClientRect, click, relative, position |

## Links

- npm: https://www.npmjs.com/package/mouse-event-offset
- Repository: https://github.com/mattdesl/mouse-event-offset
- Issues: https://github.com/mattdesl/mouse-event-offset/issues
- npm.io page: https://npm.io/package/mouse-event-offset

## Alternatives

- [async-exit-hook](https://npm.io/package/async-exit-hook.md) — 3.7M weekly downloads
- [evnty](https://npm.io/package/evnty.md) — 7.2K weekly downloads
- [eleventy-plugin-asciidoc](https://npm.io/package/eleventy-plugin-asciidoc.md) — 3.5K weekly downloads
- [@jswork/next-get2get](https://npm.io/package/@jswork/next-get2get.md) — 945 weekly downloads
- [@dashersw/axon](https://npm.io/package/@dashersw/axon.md) — 934 weekly downloads

## Recent versions

- 3.0.2 (latest) — 2015-09-29
- 3.0.1 — 2015-09-29
- 3.0.0 — 2015-09-29
- 2.0.0 — 2014-11-17
- 1.0.2 — 2014-09-22
- 1.0.1 — 2014-09-03
- 1.0.0 — 2014-08-31

## README

# mouse-event-offset

[![stable](http://badges.github.io/stability-badges/dist/stable.svg)](http://github.com/badges/stability-badges)

Computes the `[ offsetX, offsetY ]` from a mouse or touch event, relative to the top left of the `target` element.

```js 
var offset = require('mouse-event-offset')

window.addEventListener('touchstart', function (ev) {
  var target = ev.currentTarget
  var touch = ev.changedTouches[0]
  var pos = offset(touch, target)
  //=> [ 128, 52 ]
})
```
## Usage

### `position = offset(event, [target], [out])`

Pass a MouseEvent or TouchEvent as `event`. 

Optionally, you can specify a `target` element which the touch event should be relative to. Defaults to `event.currentTarget`, falling back to `event.srcElement` for older IE.

You can also specifiy `out` to store the position in that array, and avoid creating a new one.

## Changelog

- `3.x` new version; simpler API, less assumptions, avoids GC thrashing
- `2.x` uses `ev.currentTarget` instead of `ev.target`
- `1.x` simple implementation using `ev.target || ev.srcElement`

## License

MIT, see [LICENSE.md](http://github.com/mattdesl/mouse-event-offset/blob/master/LICENSE.md) for details.

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