useMouse
React sensor hooks that track cursor position
Usage
import { useMouse } from "@reactuses/core";
const Demo = () => {
const mouse = useMouse();
return (
<div>
<p>
Client - x: {mouse.clientX}, y: {mouse.clientY}
</p>
<p>
Page - x: {mouse.pageX}, y: {mouse.pageY}
</p>
<p>
Screen - x: {mouse.screenX}, y: {mouse.screenY}
</p>
</div>
);
};
Example
Client - x: NaN, y: NaN
Page - x: NaN, y: NaN
Screen - x: NaN, y: NaN
Type Declarations
export interface CursorState {
screenX: number
screenY: number
clientX: number
clientY: number
pageX: number
pageY: number
elementX: number
elementY: number
elementH: number
elementW: number
elementPosX: number
elementPosY: number
}
export default function useMouse(target?: BasicTarget): CursorState