relative-mouse
TypeScript icon, indicating that this package has built-in type declarations

1.0.1 • Public • Published

relative-mouse

Get mouse position relative to a DOM element.

npm i relative-mouse pnpm add relative-mouse yarn add relative-mouse

API

# getRelativeMouse(el, { x, y }) src/index.ts#L6

getRelativeMouse(el, { x, y })  =>

    {

    # x

      number

    # y

      number

    }
# getRelativeMouseFromEvent(el, event) src/index.ts#L3

    # el

      HTMLElement

    # event

      MouseEvent | PointerEvent

    getRelativeMouseFromEvent(el, event)  =>

      {

      # x

        number

      # y

        number

      }

Credits

Contributing

Fork or edit and submit a PR.

All contributions are welcome!

License

MIT © 2022 stagas

Package Sidebar

Install

npm i relative-mouse

Weekly Downloads

16

Version

1.0.1

License

MIT

Unpacked Size

17.2 kB

Total Files

13

Last publish

Collaborators

  • stagas