web-api-hooks/dist-types/useMouseCoords.d.ts

Essential set of React Hooks for convenient Web API consumption.

/**
 * Tracks mouse position.
 *
 * @returns Coordinates `[x, y]`, falling back to `[0, 0]` when unavailable.
 *
 * @example
 * function Component() {
 *   const [mouseX, mouseY] = useMouseCoords();
 *   // ...
 * }
 */
export default function useMouseCoords(): Readonly<[number, number]>;