React Scroll Info

A roll, as of parchment or papyrus, used especially in the writing of a document.

Quick Start

Installation

$ yarn add @trbl/react-scroll-info

Composition

  import React from 'react';
  import { ScrollInfoProvider, withScrollInfo, useScrollInfo } from '@trbl/react-scroll-info';

  const WithScrollInfo = withScrollInfo(() => <div>My Component</div>);
  const UseScrollInfo = () => <div>{useScrollInfo()}</div>;

  const App = () => {
    return (
      <ScrollInfoProvider>
        <WithScrollInfo />
        <UseScrollInfo />
      </ScrollInfoProvider>
    )
  }

  export default App;

Demo

To demo locally, clone the repo and

$ yarn
$ yarn dev
$ open http://localhost:3000

Documentation

All available props can be found via the references below:

• ScrollInfoProvider
• useScrollInfo
• withScrollInfo

Contribution

Help us, or let us help you help us.

License

MIT Copyright (c) TRBL, LLC