Skip to content
generated from stagas/ts

Get mouse position relative to a DOM element.

License

Notifications You must be signed in to change notification settings

stagas/relative-mouse

Repository files navigation

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
# 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