Scroll to top of page in React.js
In React, use window.scrollTo()
the method to scroll to the top of the page, for example window.scrollTo(0, 0)
.
method on the window object scrollTo
to scroll to a specific set of coordinates in the document.
import {useEffect} from 'react';
export default function App() {
useEffect(() => {
// 👇️ scroll to top on page load
window.scrollTo({top: 0, left: 0, behavior: 'smooth'});
}, []);
return (
<div>
<h2>Top of the page</h2>
<div style={{height: '155rem'}} />
{/* 👇️ scroll to top on button click */}
<button
onClick={() => {
window.scrollTo({top: 0, left: 0, behavior: 'smooth'});
}}
style={{
position: 'fixed',
padding: '1rem 2rem',
fontSize: '20px',
bottom: '40px',
right: '40px',
backgroundColor: '#0C9',
color: '#fff',
textAlign: 'center',
}}
>
Scroll to top
</button>
</div>
);
}
The examples in the code sample show how to:
- Scroll to the top of the page after rendering the component.
- Click the button to scroll to the top of the page.
window.scrollTo
Method scrolls to a specific set of coordinates in the document.
<button
onClick={() => {
window.scrollTo({top: 0, left: 0, behavior: 'smooth'});
}}
>
Scroll to top
</button>
It takes an object whose top
property specifies Y
the number of pixels to scroll the window along the axis.
left
Property specifies X
the number of pixels by which the window is scrolled on the axis.
behavior
Property specifies whether scrolling should be animated smoothly (smooth), or occur immediately (auto).
behavior
The default value of the property is auto .
If we need to scroll to the top of the page after the component has rendered, we can use useEffect
the <head> hook.
useEffect(() => {
// 👇️ scroll to top on page load
window.scrollTo({top: 0, left: 0, behavior: 'smooth'});
}, []);
We pass an empty
dependencies
array to the hook, so it will only run on the initial render.
If we need to scroll to the top of the page when the button is clicked, set onClick
the attribute on the element and pass it a function.
This function should call window.scrollTo()
the method, just like we useEffect
did in the hook.
For reprinting, please send an email to 1244347461@qq.com for approval. After obtaining the author's consent, kindly include the source as a link.
Related Articles
How to avoid cross-origin (CORS) issues in React/Next.js
Publish Date:2025/03/17 Views:170 Category:NETWORK
-
In this article, we will introduce how to avoid cross-origin (CORS) issues in React/Next.js. Cross-origin resource sharing (CORS) is a protocol that defines how web requests should be handled when crossing different URLs.
React Tutorial - Transferring Props
Publish Date:2025/03/16 Views:188 Category:React
-
React transfers Props. Props are generated when components are encapsulated. Components expose some properties (Props) to the outside world to complete some functions.
React Tutorial: Props Anti-Pattern
Publish Date:2025/03/16 Views:187 Category:React
-
React's Props anti-pattern, using Props to generate state in getInitialState is an anti-pattern - Anti-Pattern.
React Tutorial - Props Validation
Publish Date:2025/03/16 Views:102 Category:React
-
Props validation is a very useful way to use components correctly. It can avoid many bugs and problems as your application becomes more and more complex. In addition, it can make your program more readable.
React tutorial: Types of Props for child components
Publish Date:2025/03/16 Views:172 Category:React
-
Usually, the child components of a React component are a group, that is, the child components are an array. Introduction to Type of the Children Props.
How to solve the error Uncaught TypeError: Cannot read properties of undefined in
Publish Date:2025/03/16 Views:153 Category:React
-
In the process of React development, we often encounter some errors. Here we look at an error reported in App.js. The error is as follows: App.js:69 Uncaught TypeError: Cannot read properties of undefined (reading 'setState') at onInput
Why do you need to bind event handlers in React Class Components?
Publish Date:2025/03/16 Views:60 Category:React
-
When using React, we must have come across control components and event handlers. We need to use `.bind()` in the constructor of the custom component to bind these methods to the component instance. As shown in the following code:
Solution to the error "does not contain a default export" in React
Publish Date:2025/03/16 Views:191 Category:React
-
When we try to use `default import` to import from a module that does not have a `default export`, we get a "does not contain a default export" error. To fix the error, make sure the module has named exports and wrap the import in curly braces, e.g.
Error in React: Attempted import error 'X' is not exported from Solution
Publish Date:2025/03/16 Views:78 Category:React
-
In React, the error “Attempted import error 'X' is not exported from” in React.js occurs when we try to import a named import that does not exist in the specified file. To fix the error, make sure the module has named exports and you have not obfu