Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lemehovskiy/react-scroller
React component for detecting vertical scroll progress.
https://github.com/lemehovskiy/react-scroller
detect hook hooks progress react react-hooks reactjs scroll
Last synced: 4 days ago
JSON representation
React component for detecting vertical scroll progress.
- Host: GitHub
- URL: https://github.com/lemehovskiy/react-scroller
- Owner: lemehovskiy
- Created: 2021-12-02T05:15:32.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-10-25T16:04:16.000Z (about 1 year ago)
- Last Synced: 2024-04-26T02:22:04.516Z (7 months ago)
- Topics: detect, hook, hooks, progress, react, react-hooks, reactjs, scroll
- Language: TypeScript
- Homepage:
- Size: 542 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
react-scroller
[]()
[](https://github.com/lemehovskiy/react-scroller/issues)
[](https://github.com/lemehovskiy/react-scroller/pulls)
[](/LICENSE)
---
React component for precise vertical scroll progress detection.
[Basic Scroller](https://codesandbox.io/s/lemehovskiy-react-scroller-simple-demo-e3c8d?file=/src/App.tsx)
[Basic useScroller](https://codesandbox.io/s/lemehovskiy-react-scroller-basic-usescroller-demo-qtj00?file=/src/App.tsx)
[Basic parallax background effect](https://codesandbox.io/s/lemehovskiy-react-scroller-basic-parallax-lncoe?file=/src/App.tsx)
[Gsap(Greensock) parallax background effect](https://codesandbox.io/s/lemehovskiy-react-scroller-gsap-parallax-yw4cx?file=/src/App.tsx)
[Gsap(Greensock) timeline](https://codesandbox.io/s/lemehovskiy-react-scroller-gsap-greensock-timeline-5jzs2)
- Vertical Scroll Progress Tracking: Easily monitor scroll progress in your React components for engaging user experiences.
- Custom Start and End Offsets: Define precise scroll triggers for your components, enhancing user interactions.
- Auto-Adjust Offsets: Ensure seamless tracking even in limited space scenarios, making your components responsive.
- Debug Mode: Debug with ease using the built-in visualizer for triggers.
### Installing
```sh
npm i @lemehovskiy/react-scroller
```
### Scroller example
App.tsx
```js
import Scroller from "@lemehovskiy/react-scroller/dist";
export default function App() {
return (
<>
{({ scrollProgress }) => (
{scrollProgress}
)}
>
);
}
```
### useScroller hook example
App.tsx
```js
import { useRef } from "react";
import { useScroller } from "@lemehovskiy/react-scroller/dist";
export default function App() {
const ref = useRef(null);
const { scrollProgress } = useScroller({
ref
});
return (
<>
{scrollProgress}
>
);
}
```
## Scroller API
| name | description | type | default |
| ---------------------- | --------------------------------------------- | ------------------------------------------------------------- | ------- |
| children | | children: (props: { scrollProgress?: number }) => JSX.Element | |
| debug | Debug flag property | boolean | false |
| scrollTriggerOffset | See useScroller hook API below for more details |
| autoAdjustScrollOffset | See useScroller hook API below for more details |
## useScroller hook API
| name | description | type | default |
| ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- | ------------------ |
| ref | | | |
| scrollTriggerOffset | Offset for scroll trigger position. By default, the scroll trigger "start" is placed at the bottom, and the trigger "end" at the top. If you want to reduce the start offset by 100px you can pass {start: -100, end: 0} or move the start offset to the middle of the viewport {start: '-50%', end: 0} | {start: number | string, end: number | string } | {start: 0, end: 0} |
| autoAdjustScrollOffset | Auto-adjusting start and end offset. This option is helpful if the element is first or last and you can't realize the full progress range. You can manually adjust triggers offset but in this case, you can lose responsive behavior. | boolean | false |