@rooks/use-mouse
    TypeScript icon, indicating that this package has built-in type declarations

    4.11.2 • Public • Published

    @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!

    TitleCard

    Build Status

    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

    Install

    npm i @rooks/use-mouse

    DownloadsWeekly Downloads

    235

    Version

    4.11.2

    License

    MIT

    Unpacked Size

    9.61 kB

    Total Files

    14

    Last publish

    Collaborators

    • imbhargav5