├── .gitignore
├── README.md
├── package-lock.json
├── package.json
├── public
├── favicon.ico
├── index.html
├── logo192.png
├── logo512.png
├── manifest.json
└── robots.txt
├── src
├── App.js
├── App.scss
├── App.test.js
├── components
│ ├── Header
│ │ ├── Header.scss
│ │ └── index.jsx
│ └── ProgressBar
│ │ ├── ProgressBar.scss
│ │ └── index.jsx
├── hooks
│ └── useScrollProgress.js
├── index.css
├── index.js
├── logo.svg
├── pages
│ ├── ContainerScroll
│ │ ├── ContainerScroll.scss
│ │ └── index.jsx
│ └── FullPageScroll
│ │ ├── FullPageScroll.scss
│ │ └── index.jsx
├── serviceWorker.js
└── setupTests.js
└── yarn.lock
/.gitignore:
--------------------------------------------------------------------------------
1 | # See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
2 |
3 | # dependencies
4 | /node_modules
5 | /.pnp
6 | .pnp.js
7 |
8 | # testing
9 | /coverage
10 |
11 | # production
12 | /build
13 |
14 | # misc
15 | .DS_Store
16 | .env.local
17 | .env.development.local
18 | .env.test.local
19 | .env.production.local
20 |
21 | npm-debug.log*
22 | yarn-debug.log*
23 | yarn-error.log*
24 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # useScrollProgress hook
2 |
3 | This helps you how progress that you've scroll on a container.
4 |
5 | A container can be either
6 | - Window object (full page scroll)
7 | - Any scrolling element (container scroll)
8 |
9 | Check it out the demos:
10 |
11 | ### Full page scroll demo
12 |
13 | 
14 |
15 |
16 | ### Container scroll demo
17 |
18 | 
19 |
20 |
21 | ## How the useScrollProgress() hook is implemented
22 |
23 | > Browse the file at /src/hooks/useScrollProgress
24 |
25 | ## How to use it
26 |
27 | ```js
28 | // Full page scroll
29 | const {progress, isAtBottom} = useScrollProgress({
30 | isFullPageScroll: true,
31 | onBottomReach: () => console.log('Yay ... bottom reach 🎉'),
32 | })
33 | ```
34 |
35 | ```js
36 | // Container scroll
37 | const {progress, isAtBottom} = useScrollProgress({
38 | isFullPageScroll: false,
39 | containerRef: DOMElement ,
40 | onBottomReach: () => console.log('Yay ... bottom reach 🎉'),
41 | })
42 | ```
43 |
44 | ### Props
45 |
46 | - `isFullPageScroll`: boolean - Indicate whether using page scroll or container scroll.
47 | - `containerRef`: object - If isFullPageScroll = false, you need to set this to a DOMElement.
48 | - `onBottomReach`: function - A callback when user scroll to the bottom of the container.
49 |
50 | ### Output
51 |
52 | - `progress`: number - A value in range of [0, 100] indicating the progress of scrolling.
53 | - `isAtBottom`: boolean - Let you know if user is at bottom of the container or not.
54 |
55 | > When isAtBottom = true, I use approximately check only, it means if the scrolling distance is less than or equal to 15px, I'll treat it at bottom. 🙂
56 |
57 | License: MIT
--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "use-scroll-progress",
3 | "version": "0.1.0",
4 | "private": false,
5 | "license": "MIT",
6 | "dependencies": {
7 | "@testing-library/jest-dom": "^4.2.4",
8 | "@testing-library/react": "^9.3.2",
9 | "@testing-library/user-event": "^7.1.2",
10 | "lodash.debounce": "^4.0.8",
11 | "lodash.throttle": "^4.1.1",
12 | "react": "^16.13.1",
13 | "react-dom": "^16.13.1",
14 | "react-router-dom": "^5.2.0",
15 | "react-scripts": "3.4.1",
16 | "reactstrap": "^8.4.1"
17 | },
18 | "scripts": {
19 | "start": "react-scripts start",
20 | "build": "react-scripts build",
21 | "test": "react-scripts test",
22 | "eject": "react-scripts eject"
23 | },
24 | "eslintConfig": {
25 | "extends": "react-app"
26 | },
27 | "browserslist": {
28 | "production": [
29 | ">0.2%",
30 | "not dead",
31 | "not op_mini all"
32 | ],
33 | "development": [
34 | "last 1 chrome version",
35 | "last 1 firefox version",
36 | "last 1 safari version"
37 | ]
38 | },
39 | "devDependencies": {
40 | "node-sass": "^4.14.1"
41 | }
42 | }
43 |
--------------------------------------------------------------------------------
/public/favicon.ico:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/paulnguyen-mn/use-scroll-progress/2675feec78da80be148e5379ee9f294ffb8420b5/public/favicon.ico
--------------------------------------------------------------------------------
/public/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
10 |
11 |
15 |
16 |
25 |
26 |
28 |
29 |
31 |
32 | React App
33 |
34 |
35 |
36 | You need to enable JavaScript to run this app.
37 |
38 |
48 |
49 |
50 |
--------------------------------------------------------------------------------
/public/logo192.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/paulnguyen-mn/use-scroll-progress/2675feec78da80be148e5379ee9f294ffb8420b5/public/logo192.png
--------------------------------------------------------------------------------
/public/logo512.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/paulnguyen-mn/use-scroll-progress/2675feec78da80be148e5379ee9f294ffb8420b5/public/logo512.png
--------------------------------------------------------------------------------
/public/manifest.json:
--------------------------------------------------------------------------------
1 | {
2 | "short_name": "React App",
3 | "name": "Create React App Sample",
4 | "icons": [
5 | {
6 | "src": "favicon.ico",
7 | "sizes": "64x64 32x32 24x24 16x16",
8 | "type": "image/x-icon"
9 | },
10 | {
11 | "src": "logo192.png",
12 | "type": "image/png",
13 | "sizes": "192x192"
14 | },
15 | {
16 | "src": "logo512.png",
17 | "type": "image/png",
18 | "sizes": "512x512"
19 | }
20 | ],
21 | "start_url": ".",
22 | "display": "standalone",
23 | "theme_color": "#000000",
24 | "background_color": "#ffffff"
25 | }
26 |
--------------------------------------------------------------------------------
/public/robots.txt:
--------------------------------------------------------------------------------
1 | # https://www.robotstxt.org/robotstxt.html
2 | User-agent: *
3 | Disallow:
4 |
--------------------------------------------------------------------------------
/src/App.js:
--------------------------------------------------------------------------------
1 | import React from 'react';
2 | import './App.scss';
3 | import { BrowserRouter, Switch, Route } from 'react-router-dom';
4 | import FullPageScroll from './pages/FullPageScroll';
5 | import ContainerScroll from './pages/ContainerScroll';
6 | import Header from './components/Header';
7 |
8 | function App() {
9 | return (
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
20 | );
21 | }
22 |
23 | export default App;
24 |
--------------------------------------------------------------------------------
/src/App.scss:
--------------------------------------------------------------------------------
1 | .demo-app {
2 | }
3 |
--------------------------------------------------------------------------------
/src/App.test.js:
--------------------------------------------------------------------------------
1 | import React from 'react';
2 | import { render } from '@testing-library/react';
3 | import App from './App';
4 |
5 | test('renders learn react link', () => {
6 | const { getByText } = render( );
7 | const linkElement = getByText(/learn react/i);
8 | expect(linkElement).toBeInTheDocument();
9 | });
10 |
--------------------------------------------------------------------------------
/src/components/Header/Header.scss:
--------------------------------------------------------------------------------
1 | .nav {
2 | display: flex;
3 | flex-flow: row nowrap;
4 |
5 | &__item {
6 | flex: 0 0 auto;
7 | width: 50%;
8 | padding: 0.5rem 1rem;
9 |
10 | color: black;
11 | background-color: white;
12 |
13 | text-align: center;
14 | font-size: 1.25rem;
15 | transition: all 0.35s ease-in-out 0s;
16 |
17 | &--active {
18 | color: white;
19 | background-color: var(--primary);
20 | }
21 |
22 | &:hover {
23 | color: white;
24 | text-decoration: none;
25 |
26 | &:not(.nav__item--active) {
27 | color: var(--primary);
28 | }
29 | }
30 | }
31 | }
32 |
--------------------------------------------------------------------------------
/src/components/Header/index.jsx:
--------------------------------------------------------------------------------
1 | import React from 'react';
2 | import { NavLink } from 'react-router-dom';
3 | import './Header.scss';
4 |
5 | Header.propTypes = {};
6 |
7 | function Header() {
8 | return (
9 |
10 |
16 | Full page scroll
17 |
18 |
19 |
24 | Container scroll
25 |
26 |
27 | );
28 | }
29 |
30 | export default Header;
--------------------------------------------------------------------------------
/src/components/ProgressBar/ProgressBar.scss:
--------------------------------------------------------------------------------
1 | .custom-progress {
2 | border-radius: 0;
3 | }
4 |
--------------------------------------------------------------------------------
/src/components/ProgressBar/index.jsx:
--------------------------------------------------------------------------------
1 | import PropTypes from 'prop-types';
2 | import React from 'react';
3 | import { Progress } from 'reactstrap';
4 | import useScrollProgress from '../../hooks/useScrollProgress';
5 | import './ProgressBar.scss';
6 |
7 | ProgressBar.propTypes = {
8 | isFullPageScroll: PropTypes.bool,
9 | containerRef: PropTypes.object,
10 | onBottomReach: PropTypes.func,
11 | };
12 |
13 | ProgressBar.defaultProps = {
14 | isFullPageScroll: true,
15 | containerRef: null,
16 | onBottomReach: null,
17 | }
18 |
19 | function ProgressBar(props) {
20 | const { containerRef, onBottomReach, isFullPageScroll } = props
21 | const { progress, isAtBottom } = useScrollProgress({
22 | isFullPageScroll,
23 | containerRef,
24 | onBottomReach
25 | })
26 |
27 | return (
28 |
29 | {progress}%
30 | {isAtBottom ? ` - Yay ... you read it all 🎉` : ''}
31 |
32 | );
33 | }
34 |
35 | export default ProgressBar;
--------------------------------------------------------------------------------
/src/hooks/useScrollProgress.js:
--------------------------------------------------------------------------------
1 | import { useState, useEffect, useRef } from "react";
2 | import debounce from 'lodash.debounce';
3 | import throttle from 'lodash.throttle';
4 |
5 | const getWindowScrollHeight = () => {
6 | // Refs: https://javascript.info/size-and-scroll-window
7 | return Math.max(
8 | document.body.scrollHeight, document.documentElement.scrollHeight,
9 | document.body.offsetHeight, document.documentElement.offsetHeight,
10 | document.body.clientHeight, document.documentElement.clientHeight
11 | );
12 | }
13 |
14 | const useScrollProgress = (props) => {
15 | const { isFullPageScroll, containerRef, onBottomReach } = props;
16 | const [scrollPosition, setScrollPosition] = useState(0);
17 | const [isAtBottom, setIsAtBottom] = useState(false);
18 |
19 | // Why useRef, as the side effect will re-run when updating isAtBottom state
20 | // Using block variable in the side effect will cause this var is reset every time this side effect re-run
21 | const lastScrollTopRef = useRef(0);
22 |
23 | // Listen to scroll event
24 | useEffect(() => {
25 | const scrollContainerRef = isFullPageScroll ? window : containerRef;
26 | if (!scrollContainerRef) return;
27 |
28 | // Handle container scroll
29 | let lastScrollTop = lastScrollTopRef.current;
30 |
31 | const triggerBottomReach = debounce(() => {
32 | onBottomReach();
33 | setIsAtBottom(true);
34 | }, 300)
35 |
36 | const calculateScrollDistance = () => {
37 | const scrollTop = isFullPageScroll ? window.pageYOffset : scrollContainerRef.scrollTop;
38 | const scrollHeight = isFullPageScroll ? getWindowScrollHeight() : scrollContainerRef.scrollHeight;
39 | const clientHeight = isFullPageScroll ? document.documentElement.clientHeight : scrollContainerRef.clientHeight
40 | const totalDocScrollLength = scrollHeight - clientHeight;
41 |
42 | const scrollPosition = Math.floor(scrollTop / totalDocScrollLength * 100);
43 | setScrollPosition(scrollPosition);
44 |
45 | // if user is scrolling down to bottom (approximately)
46 | const isScrollingDown = scrollTop > lastScrollTop;
47 | const isAlmostReachBottom = (totalDocScrollLength - scrollTop) <= 15;
48 | if (onBottomReach && isScrollingDown && isAlmostReachBottom) {
49 | triggerBottomReach();
50 | }
51 |
52 | // Reset isAtBottom state if user are scrolling up and not at bottom
53 | // In case scrollTop is unchanged, dont treat it as either scrolling down or up
54 | const isScrollingUp = scrollTop < lastScrollTop;
55 | if (isScrollingUp && !isAlmostReachBottom && isAtBottom) {
56 | setIsAtBottom(false);
57 | }
58 |
59 | lastScrollTopRef.current = scrollTop;
60 | }
61 |
62 | const handleScrollChange = () => {
63 | requestAnimationFrame(calculateScrollDistance);
64 | }
65 |
66 | // Throttle scrolling every 100ms including leading and trailing
67 | const throttleScroll = throttle(handleScrollChange, 100);
68 | scrollContainerRef.addEventListener('scroll', throttleScroll);
69 |
70 | // Clean up listener when component is unmount
71 | return () => {
72 | scrollContainerRef.removeEventListener('scroll', throttleScroll);
73 | }
74 | }, [isAtBottom, isFullPageScroll, containerRef, onBottomReach]);
75 |
76 | return {
77 | progress: scrollPosition,
78 | isAtBottom
79 | };
80 | }
81 |
82 | export default useScrollProgress
--------------------------------------------------------------------------------
/src/index.css:
--------------------------------------------------------------------------------
1 | body {
2 | margin: 0;
3 | font-family: "Poppins", -apple-system, BlinkMacSystemFont, "Segoe UI", "Roboto", "Oxygen", "Ubuntu", "Cantarell",
4 | "Fira Sans", "Droid Sans", "Helvetica Neue", sans-serif;
5 | -webkit-font-smoothing: antialiased;
6 | -moz-osx-font-smoothing: grayscale;
7 | }
8 |
9 | code {
10 | font-family: source-code-pro, Menlo, Monaco, Consolas, "Courier New", monospace;
11 | }
12 |
--------------------------------------------------------------------------------
/src/index.js:
--------------------------------------------------------------------------------
1 | import React from 'react';
2 | import ReactDOM from 'react-dom';
3 | import './index.css';
4 | import App from './App';
5 | import * as serviceWorker from './serviceWorker';
6 |
7 | ReactDOM.render(
8 |
9 |
10 | ,
11 | document.getElementById('root')
12 | );
13 |
14 | // If you want your app to work offline and load faster, you can change
15 | // unregister() to register() below. Note this comes with some pitfalls.
16 | // Learn more about service workers: https://bit.ly/CRA-PWA
17 | serviceWorker.unregister();
18 |
--------------------------------------------------------------------------------
/src/logo.svg:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
--------------------------------------------------------------------------------
/src/pages/ContainerScroll/ContainerScroll.scss:
--------------------------------------------------------------------------------
1 | .container-scroll {
2 | padding-top: 3rem;
3 |
4 | &__box {
5 | height: 70vh;
6 | padding: 1rem;
7 | border: 1px solid var(--secondary);
8 | border-radius: 0 0 0.5rem 0.5rem;
9 |
10 | overflow: auto;
11 |
12 | & > p {
13 | margin: 12rem 0;
14 | }
15 | }
16 | }
17 |
--------------------------------------------------------------------------------
/src/pages/ContainerScroll/index.jsx:
--------------------------------------------------------------------------------
1 | import React, { useCallback, useState } from 'react';
2 | import { Container } from 'reactstrap';
3 | import ProgressBar from '../../components/ProgressBar';
4 | import './ContainerScroll.scss';
5 |
6 | ContainerScroll.propTypes = {
7 |
8 | };
9 |
10 | function ContainerScroll(props) {
11 | const [scrollingContainerRef, setScrollingContainerRef] = useState(null)
12 |
13 | const handleContainerRefMounted = useCallback(node => {
14 | if (node) {
15 | setScrollingContainerRef(node);
16 | }
17 | }, [])
18 |
19 | console.log(scrollingContainerRef)
20 |
21 | return (
22 |
23 |
24 |
25 |
console.log('Bottom reach!!! :P')}
29 | />
30 |
31 |
32 |
33 |
34 |
Scroll down to see changes ...
35 |
Continue to scroll ...
36 |
Keep scrolling ...
37 |
That's right! Just scrolling ... no matter what
38 |
Perfect! It's almost there
39 |
One more step, common!
40 |
Congrats! You're awesome
41 |
42 |
43 |
44 | );
45 | }
46 |
47 | export default ContainerScroll;
--------------------------------------------------------------------------------
/src/pages/FullPageScroll/FullPageScroll.scss:
--------------------------------------------------------------------------------
1 | .page-scroll {
2 | &__progress {
3 | position: sticky;
4 | top: 0;
5 | }
6 |
7 | &__main {
8 | & > p {
9 | margin: 40vh 0;
10 | padding: 0 1rem;
11 | }
12 | }
13 | }
14 |
--------------------------------------------------------------------------------
/src/pages/FullPageScroll/index.jsx:
--------------------------------------------------------------------------------
1 | import React from 'react';
2 | import ProgressBar from '../../components/ProgressBar';
3 | import './FullPageScroll.scss';
4 |
5 | FullPageScroll.propTypes = {};
6 |
7 | function FullPageScroll(props) {
8 | return (
9 |
10 |
11 |
console.log('Bottom reach!!! :P')}
14 | />
15 |
16 |
17 |
18 |
Scroll down to see changes ...
19 |
Continue to scroll ...
20 |
Keep scrolling ...
21 |
That's right! Just scrolling ... no matter what
22 |
Perfect! It's almost there
23 |
One more step, common!
24 |
Congrats! You're awesome
25 |
26 |
27 | );
28 | }
29 |
30 | export default FullPageScroll;
--------------------------------------------------------------------------------
/src/serviceWorker.js:
--------------------------------------------------------------------------------
1 | // This optional code is used to register a service worker.
2 | // register() is not called by default.
3 |
4 | // This lets the app load faster on subsequent visits in production, and gives
5 | // it offline capabilities. However, it also means that developers (and users)
6 | // will only see deployed updates on subsequent visits to a page, after all the
7 | // existing tabs open on the page have been closed, since previously cached
8 | // resources are updated in the background.
9 |
10 | // To learn more about the benefits of this model and instructions on how to
11 | // opt-in, read https://bit.ly/CRA-PWA
12 |
13 | const isLocalhost = Boolean(
14 | window.location.hostname === 'localhost' ||
15 | // [::1] is the IPv6 localhost address.
16 | window.location.hostname === '[::1]' ||
17 | // 127.0.0.0/8 are considered localhost for IPv4.
18 | window.location.hostname.match(
19 | /^127(?:\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}$/
20 | )
21 | );
22 |
23 | export function register(config) {
24 | if (process.env.NODE_ENV === 'production' && 'serviceWorker' in navigator) {
25 | // The URL constructor is available in all browsers that support SW.
26 | const publicUrl = new URL(process.env.PUBLIC_URL, window.location.href);
27 | if (publicUrl.origin !== window.location.origin) {
28 | // Our service worker won't work if PUBLIC_URL is on a different origin
29 | // from what our page is served on. This might happen if a CDN is used to
30 | // serve assets; see https://github.com/facebook/create-react-app/issues/2374
31 | return;
32 | }
33 |
34 | window.addEventListener('load', () => {
35 | const swUrl = `${process.env.PUBLIC_URL}/service-worker.js`;
36 |
37 | if (isLocalhost) {
38 | // This is running on localhost. Let's check if a service worker still exists or not.
39 | checkValidServiceWorker(swUrl, config);
40 |
41 | // Add some additional logging to localhost, pointing developers to the
42 | // service worker/PWA documentation.
43 | navigator.serviceWorker.ready.then(() => {
44 | console.log(
45 | 'This web app is being served cache-first by a service ' +
46 | 'worker. To learn more, visit https://bit.ly/CRA-PWA'
47 | );
48 | });
49 | } else {
50 | // Is not localhost. Just register service worker
51 | registerValidSW(swUrl, config);
52 | }
53 | });
54 | }
55 | }
56 |
57 | function registerValidSW(swUrl, config) {
58 | navigator.serviceWorker
59 | .register(swUrl)
60 | .then(registration => {
61 | registration.onupdatefound = () => {
62 | const installingWorker = registration.installing;
63 | if (installingWorker == null) {
64 | return;
65 | }
66 | installingWorker.onstatechange = () => {
67 | if (installingWorker.state === 'installed') {
68 | if (navigator.serviceWorker.controller) {
69 | // At this point, the updated precached content has been fetched,
70 | // but the previous service worker will still serve the older
71 | // content until all client tabs are closed.
72 | console.log(
73 | 'New content is available and will be used when all ' +
74 | 'tabs for this page are closed. See https://bit.ly/CRA-PWA.'
75 | );
76 |
77 | // Execute callback
78 | if (config && config.onUpdate) {
79 | config.onUpdate(registration);
80 | }
81 | } else {
82 | // At this point, everything has been precached.
83 | // It's the perfect time to display a
84 | // "Content is cached for offline use." message.
85 | console.log('Content is cached for offline use.');
86 |
87 | // Execute callback
88 | if (config && config.onSuccess) {
89 | config.onSuccess(registration);
90 | }
91 | }
92 | }
93 | };
94 | };
95 | })
96 | .catch(error => {
97 | console.error('Error during service worker registration:', error);
98 | });
99 | }
100 |
101 | function checkValidServiceWorker(swUrl, config) {
102 | // Check if the service worker can be found. If it can't reload the page.
103 | fetch(swUrl, {
104 | headers: { 'Service-Worker': 'script' },
105 | })
106 | .then(response => {
107 | // Ensure service worker exists, and that we really are getting a JS file.
108 | const contentType = response.headers.get('content-type');
109 | if (
110 | response.status === 404 ||
111 | (contentType != null && contentType.indexOf('javascript') === -1)
112 | ) {
113 | // No service worker found. Probably a different app. Reload the page.
114 | navigator.serviceWorker.ready.then(registration => {
115 | registration.unregister().then(() => {
116 | window.location.reload();
117 | });
118 | });
119 | } else {
120 | // Service worker found. Proceed as normal.
121 | registerValidSW(swUrl, config);
122 | }
123 | })
124 | .catch(() => {
125 | console.log(
126 | 'No internet connection found. App is running in offline mode.'
127 | );
128 | });
129 | }
130 |
131 | export function unregister() {
132 | if ('serviceWorker' in navigator) {
133 | navigator.serviceWorker.ready
134 | .then(registration => {
135 | registration.unregister();
136 | })
137 | .catch(error => {
138 | console.error(error.message);
139 | });
140 | }
141 | }
142 |
--------------------------------------------------------------------------------
/src/setupTests.js:
--------------------------------------------------------------------------------
1 | // jest-dom adds custom jest matchers for asserting on DOM nodes.
2 | // allows you to do things like:
3 | // expect(element).toHaveTextContent(/react/i)
4 | // learn more: https://github.com/testing-library/jest-dom
5 | import '@testing-library/jest-dom/extend-expect';
6 |
--------------------------------------------------------------------------------