mp

mouse-position

A module for getting the current mouse position on an element, designed for use in games and animations.

Showing:

Popularity

Downloads/wk

140

GitHub Stars

14

Maintenance

Last Commit

3yrs ago

Contributors

2

Package

Dependencies

1

Size (min+gzip)

0.4KB

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

mouse-position experimental

A module for getting the current mouse position on an element, designed for use in games and animations.

Usage

NPM

mouse = mousePosition([element], [listener])

Start watching element for mousemove events. If you don't pass an element, mouse will watch the entire browser window.

listener will attach the listener event to another element – helpful, for example, to catch movement across a larger area but still receive positions relative to element.

mouse[0]

The current horizontal position of the mouse, in pixels.

mouse[1]

The current vertical position of the mouse, in pixels.

mouse.prev[0]

The previous horizontal position of the mouse, in pixels.

mouse.prev[1]

The previous vertical position of the mouse, in pixels.

mouse.on('move', callback(event))

Called every time the mouse is moved anywhere on the targeted element.

mouse.flush()

Call this method at the end of each frame to update the prevX and prevY values – you won't get mousemove events every frame, so if you don't update this you might get incorrect values.

mouse.dispose()

Call this method to remove the internal mousemove event listener and any move callbacks on the mouse object.

License

MIT. See LICENSE.md for details.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial