0.0.2 • Published 5 months ago
@multimatic/react-scroll-info v0.0.2
Modify by Multimatic
React Scroll Info
A roll, as of parchment or papyrus, used especially in the writing of a document.
Quick Start
Installation
$ yarn add @multimatic/react-scroll-info
Composition
import React from 'react';
import { ScrollInfoProvider, withScrollInfo, useScrollInfo } from '@multimatic/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
License
MIT Copyright (c) Multimatic, LLC