useMouse

sensors

test coverage

Last changed: 17 days ago

Hook that manages a mouse position

import { useMouse } from '@siberiacancode/reactuse';

Usage

const { x, y, elementX, elementY, elementPositionX, elementPositionY } = useMouse(ref);
// or
const { ref, x, y, elementX, elementY, elementPositionX, elementPositionY } = useMouse();

Demo

source

Api

Parameters

Name	Type	Default	Note
target	HookTarget	-	The target element to manage the mouse position for

Returns

UseMouseReturn

Returns

UseMouseReturn & { ref: StateRef<Target> }

Source

Source • Demo

Contributors

debabin

hywax