Skip to main content

Function: useCursorPosition()

useCursorPosition(containerRef): RefObject<{ x: number; y: number; }>

Defined in: hooks/useCursor/index.ts:13

useCursorPosition

Parameters​

containerRef​

RefObject<null | HTMLElement>

A ref to the container element.

Returns​

RefObject<{ x: number; y: number; }>

A ref object containing the cursor's x and y coordinates.

Description​

A custom hook that tracks the mouse cursor's position relative to a container element.

Example​

const containerRef = useRef(null);
const cursorPosition = useCursorPosition(containerRef);
// Use cursorPosition.current.x and cursorPosition.current.y