Package Exports

@rooks/use-mouse

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@rooks/use-mouse) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@rooks/use-mouse

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