Skip to content

useScrollProgress

@hua-labs/hua/motion

bash
npm install @hua-labs/hua
tsx
import { useScrollProgress } from "@hua-labs/hua/framework";

tsx
const { progress } = useScrollProgress();

return (
  <div
    className="fixed top-0 left-0 h-1 bg-primary"
    style={{ width: `${progress}%` }}
  />
);

targetnumber-Total scroll height (defaults to document height)
offsetnumber0Scroll start offset in pixels
showOnMountbooleanfalseShow initial state on mount (SSR safety)

progressnumberScroll progress percentage (0-100)
mountedbooleanWhether component is mounted (hydration safety)