Design+Code logo

Quick links

Suggested search

CodeSandbox link

You can find the full code for this tutorial, with styling, at https://codesandbox.io/s/usepagebottom-hook-v67jq.

Create the hook

In a new usePageBottom.js file, import useState and useEffect from the React library.

// src/usePageBottom.js

import { useState, useEffect } from 'react';

Define the usePageBottom hook. Don't forget to export default the hook at the bottom.

// src/usePageBottom.js

const usePageBottom = () => {}

export default usePageBottom

Inside of the hook, define a reachedBottom state, and set it by default to false.

// src/usePageBottom.js

const [reachedBottom, setReachedBottom] = useState(false);

Let's defined the useEffect inside of the hook.

useEffect(() => {}, []);

Next, we'll add a function called handleScroll inside of the useEffect . This will be called when we'll listen to the scroll event.

// src/usePageBottom.js

useEffect(() => {
  const handleScroll = () => {
    const offsetHeight = document.documentElement.offsetHeight;
    const innerHeight = window.innerHeight;
    const scrollTop = document.documentElement.scrollTop;

    const hasReachedBottom = offsetHeight - (innerHeight + scrollTop) <= 10;

    setReachedBottom(hasReachedBottom);
  };
}, []);

In the handleScroll above, we're getting three values: the offsetHeight of the document, the innerHeight of the window and the scrollTop of the document. The offsetHeight is the height of the element. The innerHeight of the window is the height of the window. The scrollTop calculates the distance the user scrolled from the top of the document, to their current position, if the element is scrollable. Finally, we're calculating if the user has reached the bottom by calculating if they're at least 10 pixels from the bottom of the page, and saving it in a hasReachedBottom variable. We're then setting the reachedBottom state with the hasReachedBottom variable. Right below the handleScroll function, we'll add an event listener to the window . We'll listen to the scroll event, and when that event is fired, we'll call the handleScroll function.

// src/usePageBottom.js

useEffect(() => {
  const handleScroll = () => {
    const offsetHeight = document.documentElement.offsetHeight;
    const innerHeight = window.innerHeight;
    const scrollTop = document.documentElement.scrollTop;

    const hasReachedBottom = offsetHeight - (innerHeight + scrollTop) <= 10;

    setReachedBottom(hasReachedBottom);
  };

  window.addEventListener("scroll", handleScroll);

}, []);

The last line of the useEffect is the cleanup function. We'll remove the event listener there.

useEffect(() => {
  const handleScroll = () => {
    const offsetHeight = document.documentElement.offsetHeight;
    const innerHeight = window.innerHeight;
    const scrollTop = document.documentElement.scrollTop;

    const hasReachedBottom = offsetHeight - (innerHeight + scrollTop) <= 10;

    setReachedBottom(hasReachedBottom);
  };

  window.addEventListener("scroll", handleScroll);

  return () => window.removeEventListener("scroll", handleScroll);
}, []);

At the bottom of the usePageBottom hook, we'll return the reachedBottom state.

// src/usePageBottom.js

const usePageBottom = () => {
  const [reachedBottom, setReachedBottom] = useState(false);

	// useEffect here...
  
  return reachedBottom
};

Find below the final code for the usePageBottom hook.

// src/usePageBottom.js, final code

import { useState, useEffect } from "react";

const usePageBottom = () => {
  const [reachedBottom, setReachedBottom] = useState(false);

  useEffect(() => {
    const handleScroll = () => {
      const offsetHeight = document.documentElement.offsetHeight;
      const innerHeight = window.innerHeight;
      const scrollTop = document.documentElement.scrollTop;

      const hasReachedBottom = offsetHeight - (innerHeight + scrollTop) <= 10;

      setReachedBottom(hasReachedBottom);
    };

    window.addEventListener("scroll", handleScroll);

    return () => window.removeEventListener("scroll", handleScroll);
  }, []);

  return reachedBottom
};

export default usePageBottom;

Use the hook

Now, it's time the use the hook. First, let's create our page, and add some height to it.

// src/MyPage.js

import styled from "styled-components";

const MyPage = () => {
  return <Wrapper>Hello world!</Wrapper>;
};

export default MyPage;

const Wrapper = styled.div`
  height: 200vh;
  padding: 20px;
  background: rgba(0, 0, 0, 0.2);
`;

Now, let's import the hook.

// src/MyPage.js

import usePageBottom from "./usePageBottom";

And let's call the hook! Now, when the user has reached at last 10px from the bottom of the page, the reachedBottom value printed on the console will be true . Otherwise, it'll be false.

const reachedBottom = usePageBottom();
console.log("reachedBottom", reachedBottom);

Learn with videos and source files. Available to Pro subscribers only.

Purchase includes access to 50+ courses, 320+ premium tutorials, 300+ hours of videos, source files and certificates.

BACK TO

useWindowSize Hook

READ NEXT

useLocalStorage Hook

Templates and source code

Download source files

Download the videos and assets to refer and learn offline without interuption.

check

Design template

check

Source code for all sections

check

Video files, ePub and subtitles

Videos

ePub

Assets

Subtitles

1

Intro to React Hooks

An overview of React Hooks and the frameworks you can use to build your React application blazingly fast

3:39

2

Create your first React app

Create your first React project from the Terminal and save it on your local computer

4:23

3

React Component

Create your first JSX component using React

2:54

4

Styling in React

How to style your React components using inline styling, separate stylesheets or styled-components

5:06

5

Styles and Props

Render different styles depending on different properties passed to your component

2:22

6

Understanding Hooks

Learn about the basics of React Hooks, which introduced at React Conf 2018

3:21

7

useState Hook

Use the useState hook to manage local state in your React component

2:54

8

useEffect Hook

Manage with your component's lifecycle with the useEffect hook

3:41

9

useRef Hook

Learn about the useRef hook, which replaces the JavaScript getElementById way

3:00

10

Props

Learn about props in React to pass data from parent to child components

3:11

11

Conditional Rendering

Render different UIs depending on different conditions and states

4:21

12

Load Local Data

Load local JSON data into your React application

4:04

13

Fetch Data from an API

Learn the basics of asynchronous functions and promises by fetching data from an API using fetch, useEffect and useState

5:40

14

Toggle a state

Learn how to toggle a state from true to false and back again

4:05

15

useInput Hook

Create a hook to get the value and the onChange event of input fields

6:04

16

Gatsby and React

Create a static content-oriented website using React on Gatsby

6:44

17

NextJS and React

Create your first NextJS React application

5:24

18

React TypeScript Part 1

Learn how to create a React TypeScript application using the Create React App, Gatsby and NextJS methods

8:19

19

React TypeScript Part 2

Learn the basics of TypeScript and how to use TypeScript in a React component

7:35

20

useScrollPosition Hook

Create a custom hook to listen to the current window position of the user

4:26

21

useOnScreen hook

Create a custom hook to listen to when an element is visible on screen

8:08

22

useContext Hook

Manage global states throughout the entire application

8:32

23

Fragments

Group multiple children together with React Fragments

2:43

24

Lazy Loading

Lazy Load heavy components to improve performance

4:05

25

React Suspense

Wait for data with React Suspense and React.lazy

3:13

26

Environment Variables

Make environment variables secret with a .env file

4:43

27

Reach Router

Create a multiple-pages React application with Reach Router

5:31

28

URL Params

Create unique URL with URL Params

4:04

29

SEO and Metadata

Optimize a React application for search engines with React Helmet

6:47

30

Favicon

Add an icon to a React website

3:03

31

Dynamic Favicon

Change the favicon's fill color depending on the user's system appearance

2:14

32

PropTypes

Implement props type-checking with PropTypes

3:54

33

Custom PropTypes

Create a custom PropType using a validator function

3:58

34

useMemo Hook

Prevent unnecessary re-renders when the component stays the same

4:05

35

forwardRef Hook

Forward a ref to a child component

3:28

36

Handling Events

How to handle events in React

5:44

37

Spread attributes

Learn how to make use of the spread operator

3:35

38

useMousePosition Hook

Detect the user's mouse position on a bound element

4:55

39

useReducer with useContext Part 1

Create a reducer to be used in a context

7:33

40

useReducer with useContext Part 2

Incorporate useReducer with useContext

6:48

41

useReducer with useContext Part 3

Connect the context and reducer with the frontend

5:43

42

Netlify

Deploy to production using Netlify

5:08

43

Gatsby Cloud

Deploy to production using Gatsby Cloud

6:19

44

Gatsby Plugin Image

Use gatsby-plugin-image for automatic image resizing, formatting, and higher performance

8:11

45

useOnClickOutside Hook

Toggle a modal visibility with a useOnClickOutside hook

6:32

46

useWindowSize Hook

Create a hook to determine the width and height of the window

4:14

47

usePageBottom hook

Detect if the user scrolled to the bottom of the page

4:48

48

useLocalStorage Hook

Store an item in a browser's local storage

5:27

49

Three.js in React Part 1

Bring your website to life with beautiful 3D objects

17:33

50

Three.js in React Part 2

Bring your website to life with beautiful 3D objects

11:18