Skip to main content

useWindowScrollIntoPosition

Hook to scroll the window to a specific position.

Usage​

Live Editor
function App() {
	const scrollToPosition = useWindowScrollIntoPosition();

	const handleScroll = () => {
		scrollToPosition({ x: 100, y: 0, behavior: "smooth" });
	};

	return (
		<div>
			<button onClick={handleScroll}>Scroll to Position</button>
		</div>
	);
}
Result
Loading...

API​

Returns : ScrollToPosition

A function to scroll the window to the specified x and y coordinates.

Function parameters

x : A number indicating the x-coordinate to scroll to.

y : A number indicating the y-coordinate to scroll to.

behavior : A string indicating the scroll behavior ('auto' or 'smooth'). Defaults to 'auto'.