The modern link attribution platform. Loved by world-class engineering teams at Twilio, Zillow, Jobber, Vercel, Raycast, and more.
TypeScript clickhousemysqlnextjsopen-sourceplanetscaleprismatailwindcsstinybirdtypescriptupstashvercel
import { RefObject, useCallback, useEffect, useState } from "react";
export function useScroll(
threshold: number,
{ container }: { container?: RefObject<HTMLElement | null> } = {},
) {
const [scrolled, setScrolled] = useState(false);
const onScroll = useCallback(() => {
setScrolled(
(container?.current ? container.current.scrollTop : window.scrollY) >
threshold,
);
}, [threshold]);
useEffect(() => {
const element = container?.current ?? window;
element.addEventListener("scroll", onScroll);
return () => element.removeEventListener("scroll", onScroll);
}, [onScroll]);
// also check on first load
useEffect(() => {
onScroll();
}, [onScroll]);
return scrolled;
}