stagas / relative-mouse

Get mouse position relative to a DOM element.

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

# el

HTMLElement

# pos

{

# x

src/index.ts#L6

number

# y

src/index.ts#L6

number

}

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

• get-element-offset by stagas – Get accurate DOM element offset.

Contributing

Fork or edit and submit a PR.

All contributions are welcome!

License

MIT © 2022 stagas