← Back toHTML DOM

Scroll to top of the page

Written byPhuoc Nguyen
Category
Level 1 — Basic
Created
18 Feb, 2020
In general, you can scroll to a point whose coordinates indicates the distance from it to the top and left side of document:
window.scrollTo(pageX, pageY);
So, the following code scrolls to top of the page:
window.scrollTo(0, 0);

Use cases

  1. You can add a button at the bottom of page that allows user to scroll to the top quickly.
  2. In a single page application, where page is built on top of components, and users usually don't realize the page changes when navigating to other page.
The browser keeps the current scroll position. We have to scroll to the top when users change page. The following sample code is used in the layout of a React application using the React Router:
import { useLocation } from 'react-router-dom';

export default ({ children }) => {
const { pathname } = useLocation();

React.useEffect(() => {
window.scrollTo(0, 0);
}, [pathname]);

return (
...
);
};

See also

Questions? 🙋

Do you have any questions? Not just about this specific post, but about any topic in front-end development that you'd like to learn more about? If so, feel free to send me a message on Twitter or send me an email. You can find them at the bottom of this page.
I have a long list of upcoming posts, but your questions or ideas for the next one will be my top priority. Let's learn together! Sharing knowledge is the best way to grow 🥷.

Recent posts ⚡

Newsletter 🔔

If you're into front-end technologies and you want to see more of the content I'm creating, then you might want to consider subscribing to my newsletter.
By subscribing, you'll be the first to know about new articles, products, and exclusive promotions.
Don't worry, I won't spam you. And if you ever change your mind, you can unsubscribe at any time.
Phước Nguyễn