@rooks/use-mouse

Note: Future updates to this package have moved to the main package rooks. All hooks now reside in a single package which you can install using

npm install rooks

or

yarn add rooks

Rooks is completely treeshakeable and if you use only 1 of the 50+ hooks in the package, only that hook will be bundled with your code. Your bundle will only contain the hooks that you need. Cheers!

About

Mouse position hook for React.

Installation

npm install --save @rooks/use-mouse

Importing the hook

import useMouse from "@rooks/use-mouse"

Usage

function Demo() {
  const { x, y } = useMouse();
  return (
    <>
      <p> Move mouse here to see changes to position </p>
      <p>X position is {x || "null"}</p>
      <p>X position is {y || "null"}</p>
    </>
  );
}

render(<Demo/>)

Returned Object

| Returned object attributes | Type | Description | | -------------------------- | ---- | ------------------- | | x | int | X position of mouse | | y | int | Y position of mouse |