@hookplus/use-scroll

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

Installation

yarn

yarn add @hookplus/use-scroll

npm

npm i @hookplus/use-scroll

Usage

import React from "react";
import useScroll from "@hookplus/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} |