Normal People, MMM!

    @jacob-hooks/use-scroll

    1.0.17 • Public • Published

    @jacob-hooks/use-scroll

    React Hook to get X/Y coordinates of current position of the scroll.

    installation

    yarn

    yarn add @jacob-hooks/use-scroll

    npm

    npm i @jacob-hooks/use-scroll

    Usage

    import React from "react";
    import useScroll from "@jacob-hooks/use-scroll";
    
    function App() {
      const { x, y } = useScroll();
      return (
        <h1>
          We are in: {x} / {y}
        </h1>
      );
    }

    Return

    Return value Type Description Default value
    Coords Object An object containing the x/y coordinates of the current scroll position {x:0, y:0}

    Install

    npm i @jacob-hooks/use-scroll

    DownloadsWeekly Downloads

    0

    Version

    1.0.17

    License

    MIT

    Unpacked Size

    3.79 kB

    Total Files

    6

    Last publish

    Collaborators

    • jacobko